Package org.apache.jackrabbit.core.data

Class FSBackend

java.lang.Object

org.apache.jackrabbit.core.data.AbstractBackend

org.apache.jackrabbit.core.data.FSBackend

All Implemented Interfaces:

Backend

public class FSBackend
extends AbstractBackend

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FS_BACKEND_PATH

Constructor Summary

Constructors

Constructor	Description
FSBackend()

Method Summary

Modifier and Type	Method	Description
java.util.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.
java.util.Iterator<DataIdentifier>	getAllIdentifiers()	Returns identifiers of all records that exists in backend.
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, java.lang.String homeDir, java.lang.String config)	This method initialize backend with the configuration.
void	init(CachingDataStore store, java.lang.String homeDir, java.util.Properties prop)
java.io.InputStream	read(DataIdentifier identifier)	Return inputstream of record identified by identifier.
void	setProperties(java.util.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, java.io.File src)	Stores file to backend with identifier used as key.
void	writeAsync(DataIdentifier identifier, java.io.File src, AsyncUploadCallback callback)	Write file to backend in asynchronous mode.

Methods inherited from class org.apache.jackrabbit.core.data.AbstractBackend

close, getAsyncWritePoolSize, setAsyncWritePoolSize

Methods inherited from class java.lang.Object

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

Field Detail

FS_BACKEND_PATH

public static final java.lang.String FS_BACKEND_PATH

See Also:

Constant Field Values

Constructor Detail

FSBackend

public FSBackend()

Method Detail

init

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

Description copied from class: AbstractBackend

This method initialize backend with the configuration.

Specified by:

init in interface Backend

Overrides:

init in class AbstractBackend

Parameters:

store - CachingDataStore

homeDir - path of repository home dir.

config - path of config property file.

Throws:

DataStoreException

init

public void init(CachingDataStore store,
                 java.lang.String homeDir,
                 java.util.Properties prop)
          throws DataStoreException

Throws:

DataStoreException

read

public java.io.InputStream read(DataIdentifier identifier)
                         throws DataStoreException

Description copied from interface: Backend

Return inputstream of record identified by identifier.

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.

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.

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,
                  java.io.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.

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,
                       java.io.File src,
                       AsyncUploadCallback callback)
                throws DataStoreException

Description copied from interface: Backend

Write file to backend in asynchronous mode.

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

Throws:

DataStoreException

getAllIdentifiers

public java.util.Iterator<DataIdentifier> getAllIdentifiers()
                                                     throws DataStoreException

Description copied from interface: Backend

Returns identifiers of all records that exists in 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.

Throws:

DataStoreException

exists

public boolean exists(DataIdentifier identifier)
               throws DataStoreException

Description copied from interface: Backend

This method check the existence of record in 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.

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.

Throws:

DataStoreException

deleteAllOlderThan

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

Description copied from interface: Backend

Delete all records which are older than timestamp.

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.

Throws:

DataStoreException

setProperties

public void setProperties(java.util.Properties properties)

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

Parameters:

properties - to configure S3Backend