org.apache.jackrabbit.oak.plugins.blob.datastore

Class FSBackend

java.lang.Object

org.apache.jackrabbit.oak.spi.blob.AbstractSharedBackend

org.apache.jackrabbit.oak.plugins.blob.datastore.FSBackend

All Implemented Interfaces:

SharedBackend

public class FSBackend
extends AbstractSharedBackend

Field Summary

Fields

Modifier and Type	Field and Description
static String	FS_BACKEND_PATH

Constructor Summary

Constructors

Constructor and Description
FSBackend()

Method Summary

Modifier and Type	Method and Description
void	addMetadataRecord(File input, String name) Adds a metadata record with the specified name
void	addMetadataRecord(InputStream input, String name) Adds a metadata record with the specified name
void	close() Close backend and release resources like database connection if any.
void	deleteAllMetadataRecords(String prefix) Deletes all the metadata records with the specified prefix.
boolean	deleteMetadataRecord(String name) Deletes the metadata record with the specified name
void	deleteRecord(DataIdentifier identifier) Delete record identified by identifier.
boolean	exists(DataIdentifier identifier) This method check the existence of record in backend.
Iterator<DataIdentifier>	getAllIdentifiers() Returns identifiers of all records that exists in backend.
List<DataRecord>	getAllMetadataRecords(String prefix) Gets all the metadata with a specified prefix.
Iterator<DataRecord>	getAllRecords() Returns a list of all DataRecords
DataRecord	getMetadataRecord(String name) Gets the metadata of the specified name.
byte[]	getOrCreateReferenceKey() Returns the reference key of this backend.
DataRecord	getRecord(DataIdentifier identifier) Gets the record with the specified identifier
void	init() Initialize
boolean	metadataRecordExists(String name) Checks if the metadata record with the specified name exists.
InputStream	read(DataIdentifier identifier) Return inputstream of record identified by identifier.
void	setProperties(Properties properties) Properties used to configure the backend.
void	write(DataIdentifier identifier, File file) Stores file to backend with identifier used as key.

Methods inherited from class java.lang.Object

equals, 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()
          throws DataStoreException

Description copied from interface: SharedBackend

Initialize

Throws:

DataStoreException

read

public InputStream read(DataIdentifier identifier)
                 throws DataStoreException

Description copied from interface: SharedBackend

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.

write

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

Description copied from interface: SharedBackend

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

file - file that would be stored in backend.

Throws:

DataStoreException - for any error.

getRecord

public DataRecord getRecord(DataIdentifier identifier)
                     throws DataStoreException

Description copied from interface: SharedBackend

Gets the record with the specified identifier

Parameters:

identifier - the record identifier

Returns:

the metadata DataRecord

Throws:

DataStoreException

getAllIdentifiers

public Iterator<DataIdentifier> getAllIdentifiers()
                                           throws DataStoreException

Description copied from interface: SharedBackend

Returns identifiers of all records that exists in backend.

Returns:

iterator consisting of all identifiers

Throws:

DataStoreException

exists

public boolean exists(DataIdentifier identifier)
               throws DataStoreException

Description copied from interface: SharedBackend

This method check the existence of record in backend.

Parameters:

identifier - identifier to be checked.

Returns:

true if records exists else false.

Throws:

DataStoreException

deleteRecord

public void deleteRecord(DataIdentifier identifier)
                  throws DataStoreException

Description copied from interface: SharedBackend

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

Throws:

DataStoreException

addMetadataRecord

public void addMetadataRecord(InputStream input,
                              String name)
                       throws DataStoreException

Description copied from interface: SharedBackend

Adds a metadata record with the specified name

Parameters:

input - the record input stream

name - the name

Throws:

DataStoreException

addMetadataRecord

public void addMetadataRecord(File input,
                              String name)
                       throws DataStoreException

Description copied from interface: SharedBackend

Adds a metadata record with the specified name

Parameters:

input - the record file

name - the name

Throws:

DataStoreException

getMetadataRecord

public DataRecord getMetadataRecord(String name)

Description copied from interface: SharedBackend

Gets the metadata of the specified name.

Parameters:

name - the name of the record

Returns:

the metadata DataRecord

getAllMetadataRecords

public List<DataRecord> getAllMetadataRecords(String prefix)

Description copied from interface: SharedBackend

Gets all the metadata with a specified prefix.

Parameters:

prefix - the prefix of the records to retrieve

Returns:

list of all the metadata DataRecords

deleteMetadataRecord

public boolean deleteMetadataRecord(String name)

Description copied from interface: SharedBackend

Deletes the metadata record with the specified name

Parameters:

name - the name of the record

Returns:

boolean to indicate success of deletion

deleteAllMetadataRecords

public void deleteAllMetadataRecords(String prefix)

Description copied from interface: SharedBackend

Deletes all the metadata records with the specified prefix.

Parameters:

prefix - the prefix of the record

metadataRecordExists

public boolean metadataRecordExists(String name)

Description copied from interface: SharedBackend

Checks if the metadata record with the specified name exists.

Parameters:

name - the name of the record

Returns:

whether record exists

getAllRecords

public Iterator<DataRecord> getAllRecords()

Description copied from interface: SharedBackend

Returns a list of all DataRecords

Returns:

iterator over DataRecords

close

public void close()
           throws DataStoreException

Description copied from interface: SharedBackend

Close backend and release resources like database connection if any.

Throws:

DataStoreException

getOrCreateReferenceKey

public byte[] getOrCreateReferenceKey()
                               throws DataStoreException

Description copied from class: AbstractSharedBackend

Returns the reference key of this backend. If one does not already exist, it is automatically created in an implementation-specific way. The default implementation simply creates a temporary random key that's valid only until the data store gets restarted. Subclasses can override and/or decorate this method to support a more persistent reference key.

This method is called only once during the lifetime of a backend instance and the return value is cached in memory, so it's no problem if the implementation is slow.

Overrides:

getOrCreateReferenceKey in class AbstractSharedBackend

Returns:

reference key

Throws:

DataStoreException - if the key is not available

setProperties

public void setProperties(Properties properties)

Properties used to configure the backend. These are mandatorily to be provided explicitly before calling {init() is invoked.

Parameters:

properties - to configure Backend