org.apache.jackrabbit.oak.plugins.blob

Interface SharedDataStore

All Known Implementing Classes:

DataStoreBlobStore, OakFileDataStore, SharedS3DataStore

public interface SharedDataStore

Interface to be implemented by a shared data store.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SharedDataStore.Type Explicitly identifies the type of the data store

Method Summary

Modifier and Type	Method and Description
void	addMetadataRecord(InputStream stream, String name) Adds the root record.
void	deleteAllMetadataRecords(String prefix) Deletes all records matching the given prefix.
boolean	deleteMetadataRecord(String name) Deletes the root record represented by the given parameters.
List<DataRecord>	getAllMetadataRecords(String prefix) Gets the all root records.
DataRecord	getMetadataRecord(String name) Retrieves the metadata record with the given name
SharedDataStore.Type	getType() Gets the type.

Method Detail

addMetadataRecord

void addMetadataRecord(InputStream stream,
                       String name)
                throws DataStoreException

Adds the root record.

Parameters:

stream - the stream

name - the name of the root record

Throws:

DataStoreException - the data store exception

getMetadataRecord

DataRecord getMetadataRecord(String name)

Retrieves the metadata record with the given name

Parameters:

name - the name of the record

Returns:

getAllMetadataRecords

List<DataRecord> getAllMetadataRecords(String prefix)

Gets the all root records.

Returns:

the all root records

deleteMetadataRecord

boolean deleteMetadataRecord(String name)

Deletes the root record represented by the given parameters.

Parameters:

name - the name of the root record

Returns:

success/failure

deleteAllMetadataRecords

void deleteAllMetadataRecords(String prefix)

Deletes all records matching the given prefix.

Parameters:

prefix - metadata type identifier

getType

SharedDataStore.Type getType()

Gets the type.

Returns:

the type