org.apache.jackrabbit.core.data

Class FSBackend

java.lang.Object

org.apache.jackrabbit.core.data.FSBackend

All Implemented Interfaces:

Backend

public class FSBackend
extends Object
implements Backend

Field Summary

Fields

Modifier and Type	Field and Description
static String	FS_BACKEND_PATH

Constructor Summary

Constructors

Constructor and Description
FSBackend()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close backend and release resources like database connection if any.
protected Executor	createAsyncWriteExecutor() Creates a Executor.
Set<DataIdentifier>	deleteAllOlderThan(long min) Delete all records which are older than timestamp.
void	deleteRecord(DataIdentifier identifier) Delete record identified by identifier.
boolean	exists(DataIdentifier identifier) This method check the existence of record in backend.
boolean	exists(DataIdentifier identifier, boolean touch) This method check the existence of record in backend.
Iterator<DataIdentifier>	getAllIdentifiers() Returns identifiers of all records that exists in backend.
protected Executor	getAsyncWriteExecutor() Returns ThreadPoolExecutor used to execute asynchronous write or touch jobs.
long	getLastModified(DataIdentifier identifier) Return lastModified of record identified by identifier.
long	getLength(DataIdentifier identifier) Return length of record identified by identifier.
void	init(CachingDataStore store, String homeDir, Properties prop)
void	init(CachingDataStore store, String homeDir, String config) This method initialize backend with the configuration.
InputStream	read(DataIdentifier identifier) Return inputstream of record identified by identifier.
void	setProperties(Properties properties) Properties used to configure the backend.
void	touch(DataIdentifier identifier, long minModifiedDate) Update the lastModified of record if it's lastModified < minModifiedDate.
void	touchAsync(DataIdentifier identifier, long minModifiedDate, AsyncTouchCallback callback) Update the lastModified of record if it's lastModified < minModifiedDate asynchronously.
void	write(DataIdentifier identifier, File src) Stores file to backend with identifier used as key.
void	writeAsync(DataIdentifier identifier, File src, AsyncUploadCallback callback) Write file to backend in asynchronous mode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FS_BACKEND_PATH

public static final String FS_BACKEND_PATH

See Also:

Constant Field Values

Constructor Detail

FSBackend

public FSBackend()

Method Detail

init

public void init(CachingDataStore store,
        String homeDir,
        String config)
          throws DataStoreException

Description copied from interface: Backend

This method initialize backend with the configuration.

Specified by:

init in interface Backend

Parameters:

store - CachingDataStore

homeDir - path of repository home dir.

config - path of config property file.

Throws:

DataStoreException

init

public void init(CachingDataStore store,
        String homeDir,
        Properties prop)
          throws DataStoreException

Throws:

DataStoreException

read

public InputStream read(DataIdentifier identifier)
                 throws DataStoreException

Description copied from interface: Backend

Return inputstream of record identified by identifier.

Specified by:

read in interface Backend

Parameters:

identifier - identifier of record.

Returns:

inputstream of the record.

Throws:

DataStoreException - if record not found or any error.

getLength

public long getLength(DataIdentifier identifier)
               throws DataStoreException

Description copied from interface: Backend

Return length of record identified by identifier.

Specified by:

getLength in interface Backend

Parameters:

identifier - identifier of record.

Returns:

length of the record.

Throws:

DataStoreException - if record not found or any error.

getLastModified

public long getLastModified(DataIdentifier identifier)
                     throws DataStoreException

Description copied from interface: Backend

Return lastModified of record identified by identifier.

Specified by:

getLastModified in interface Backend

Parameters:

identifier - identifier of record.

Returns:

lastModified of the record.

Throws:

DataStoreException - if record not found or any error.

write

public void write(DataIdentifier identifier,
         File src)
           throws DataStoreException

Description copied from interface: Backend

Stores file to backend with identifier used as key. If key pre-exists, it updates the timestamp of the key.

Specified by:

write in interface Backend

Parameters:

identifier - key of the file

src - file that would be stored in backend.

Throws:

DataStoreException - for any error.

writeAsync

public void writeAsync(DataIdentifier identifier,
              File src,
              AsyncUploadCallback callback)
                throws DataStoreException

Description copied from interface: Backend

Write file to backend in asynchronous mode.

Specified by:

writeAsync in interface Backend

callback - Callback interface to called after upload succeed or failed.

Throws:

DataStoreException

getAllIdentifiers

public Iterator<DataIdentifier> getAllIdentifiers()
                                           throws DataStoreException

Description copied from interface: Backend

Returns identifiers of all records that exists in backend.

Specified by:

getAllIdentifiers in interface Backend

Returns:

iterator consisting of all identifiers

Throws:

DataStoreException

exists

public boolean exists(DataIdentifier identifier,
             boolean touch)
               throws DataStoreException

Description copied from interface: Backend

This method check the existence of record in backend. Return true if records exists else false. This method also touch record identified by identifier if touch is true.

Specified by:

exists in interface Backend

Throws:

DataStoreException

exists

public boolean exists(DataIdentifier identifier)
               throws DataStoreException

Description copied from interface: Backend

This method check the existence of record in backend.

Specified by:

exists in interface Backend

Parameters:

identifier - identifier to be checked.

Returns:

true if records exists else false.

Throws:

DataStoreException

touch

public void touch(DataIdentifier identifier,
         long minModifiedDate)
           throws DataStoreException

Description copied from interface: Backend

Update the lastModified of record if it's lastModified < minModifiedDate.

Specified by:

touch in interface Backend

Throws:

DataStoreException

touchAsync

public void touchAsync(DataIdentifier identifier,
              long minModifiedDate,
              AsyncTouchCallback callback)
                throws DataStoreException

Description copied from interface: Backend

Update the lastModified of record if it's lastModified < minModifiedDate asynchronously. Result of update is passed using appropriate AsyncTouchCallback methods. If identifier's lastModified > minModified AsyncTouchCallback.onAbort(AsyncTouchResult) is called. Any exception is communicated through AsyncTouchCallback.onFailure(AsyncTouchResult) . On successful update of lastModified, AsyncTouchCallback.onSuccess(AsyncTouchResult) is invoked.

Specified by:

touchAsync in interface Backend

Throws:

DataStoreException

close

public void close()
           throws DataStoreException

Description copied from interface: Backend

Close backend and release resources like database connection if any.

Specified by:

close in interface Backend

Throws:

DataStoreException

deleteAllOlderThan

public Set<DataIdentifier> deleteAllOlderThan(long min)
                                       throws DataStoreException

Description copied from interface: Backend

Delete all records which are older than timestamp.

Specified by:

deleteAllOlderThan in interface Backend

Returns:

Set of identifiers which are deleted.

Throws:

DataStoreException

deleteRecord

public void deleteRecord(DataIdentifier identifier)
                  throws DataStoreException

Description copied from interface: Backend

Delete record identified by identifier. No-op if identifier not found.

Specified by:

deleteRecord in interface Backend

Throws:

DataStoreException

setProperties

public void setProperties(Properties properties)

Properties used to configure the backend. If provided explicitly before init is invoked then these take precedence

Parameters:

properties - to configure S3Backend

createAsyncWriteExecutor

protected Executor createAsyncWriteExecutor()

Creates a Executor. This method is invoked during the initialization for asynchronous write/touch job executions.

Returns:

a Executor

getAsyncWriteExecutor

protected Executor getAsyncWriteExecutor()

Returns ThreadPoolExecutor used to execute asynchronous write or touch jobs.

Returns:

ThreadPoolExecutor used to execute asynchronous write or touch jobs