org.apache.jackrabbit.oak.blob.cloud.aws.s3

Interface SharedS3Backend

All Superinterfaces:

org.apache.jackrabbit.core.data.Backend

All Known Implementing Classes:

S3Backend

public interface SharedS3Backend
extends org.apache.jackrabbit.core.data.Backend

Extension to the Backend for supporting adding meta data to the underlying store.

Method Summary

Methods

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	deleteAllMetadataRecords(String prefix) Deletes all the metadata records with the specified prefix.
boolean	deleteMetadataRecord(String name) Deletes the metadata record with the specified name
List<org.apache.jackrabbit.core.data.DataRecord>	getAllMetadataRecords(String prefix) Gets all the metadata with a specified prefix.
Iterator<org.apache.jackrabbit.core.data.DataRecord>	getAllRecords() Returns a list of all DataRecords
org.apache.jackrabbit.core.data.DataRecord	getMetadataRecord(String name) Gets the metadata of the specified name.
org.apache.jackrabbit.core.data.DataRecord	getRecord(org.apache.jackrabbit.core.data.DataIdentifier id) Gets the record with the specified identifier

Methods inherited from interface org.apache.jackrabbit.core.data.Backend

close, deleteAllOlderThan, deleteRecord, exists, exists, getAllIdentifiers, getLastModified, getLength, init, read, touch, touchAsync, write, writeAsync

Method Detail

addMetadataRecord

void addMetadataRecord(InputStream input,
                     String name)
                       throws org.apache.jackrabbit.core.data.DataStoreException

Adds a metadata record with the specified name

Parameters:

input - the record input stream

name - the name

Throws:

org.apache.jackrabbit.core.data.DataStoreException

addMetadataRecord

void addMetadataRecord(File input,
                     String name)
                       throws org.apache.jackrabbit.core.data.DataStoreException

Adds a metadata record with the specified name

Parameters:

input - the record file

name - the name

Throws:

org.apache.jackrabbit.core.data.DataStoreException

getMetadataRecord

org.apache.jackrabbit.core.data.DataRecord getMetadataRecord(String name)

Gets the metadata of the specified name.

Parameters:

name - the name of the record

Returns:

the metadata DataRecord

getAllMetadataRecords

List<org.apache.jackrabbit.core.data.DataRecord> getAllMetadataRecords(String prefix)

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

boolean deleteMetadataRecord(String name)

Deletes the metadata record with the specified name

Parameters:

name - the name of the record

Returns:

boolean to indicate success of deletion

deleteAllMetadataRecords

void deleteAllMetadataRecords(String prefix)

Deletes all the metadata records with the specified prefix.

Parameters:

prefix - the prefix of the record

getAllRecords

Iterator<org.apache.jackrabbit.core.data.DataRecord> getAllRecords()
                                                                   throws org.apache.jackrabbit.core.data.DataStoreException

Returns a list of all DataRecords

Returns:

iterator over DataRecords

Throws:

org.apache.jackrabbit.core.data.DataStoreException

getRecord

org.apache.jackrabbit.core.data.DataRecord getRecord(org.apache.jackrabbit.core.data.DataIdentifier id)
                                                     throws org.apache.jackrabbit.core.data.DataStoreException

Gets the record with the specified identifier

Parameters:

id - the record identifier

Returns:

the metadata DataRecord

Throws:

org.apache.jackrabbit.core.data.DataStoreException