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

Class S3Backend

java.lang.Object

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

All Implemented Interfaces:

org.apache.jackrabbit.core.data.Backend, SharedS3Backend

public class S3Backend
extends Object
implements SharedS3Backend

A data store backend that stores data on Amazon S3.

Constructor Summary

Constructors

Constructor and Description
S3Backend()

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	close()
void	deleteAllMetadataRecords(String prefix) Deletes all the metadata records with the specified prefix.
Set<org.apache.jackrabbit.core.data.DataIdentifier>	deleteAllOlderThan(long min)
boolean	deleteMetadataRecord(String name) Deletes the metadata record with the specified name
void	deleteRecord(org.apache.jackrabbit.core.data.DataIdentifier identifier)
boolean	exists(org.apache.jackrabbit.core.data.DataIdentifier identifier) Check if record identified by identifier exists in Amazon S3.
boolean	exists(org.apache.jackrabbit.core.data.DataIdentifier identifier, boolean touch)
Iterator<org.apache.jackrabbit.core.data.DataIdentifier>	getAllIdentifiers()
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
String	getBucket()
long	getLastModified(org.apache.jackrabbit.core.data.DataIdentifier identifier)
long	getLength(org.apache.jackrabbit.core.data.DataIdentifier identifier)
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 identifier) Gets the record with the specified identifier
void	init(org.apache.jackrabbit.core.data.CachingDataStore store, String homeDir, Properties prop)
void	init(org.apache.jackrabbit.core.data.CachingDataStore store, String homeDir, String config) Initialize S3Backend.
InputStream	read(org.apache.jackrabbit.core.data.DataIdentifier identifier)
void	setBucket(String bucket)
void	setProperties(Properties properties) Properties used to configure the backend.
void	touch(org.apache.jackrabbit.core.data.DataIdentifier identifier, long minModifiedDate)
void	touchAsync(org.apache.jackrabbit.core.data.DataIdentifier identifier, long minModifiedDate, org.apache.jackrabbit.core.data.AsyncTouchCallback callback)
void	write(org.apache.jackrabbit.core.data.DataIdentifier identifier, File file) It uploads file to Amazon S3.
void	writeAsync(org.apache.jackrabbit.core.data.DataIdentifier identifier, File file, org.apache.jackrabbit.core.data.AsyncUploadCallback callback)

Methods inherited from class java.lang.Object

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

Constructor Detail

S3Backend

public S3Backend()

Method Detail

init

public void init(org.apache.jackrabbit.core.data.CachingDataStore store,
        String homeDir,
        String config)
          throws org.apache.jackrabbit.core.data.DataStoreException

Initialize S3Backend. It creates AmazonS3Client and TransferManager from aws.properties. It creates S3 bucket if it doesn't pre-exist in S3.

Specified by:

init in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

init

public void init(org.apache.jackrabbit.core.data.CachingDataStore store,
        String homeDir,
        Properties prop)
          throws org.apache.jackrabbit.core.data.DataStoreException

Throws:

org.apache.jackrabbit.core.data.DataStoreException

write

public void write(org.apache.jackrabbit.core.data.DataIdentifier identifier,
         File file)
           throws org.apache.jackrabbit.core.data.DataStoreException

It uploads file to Amazon S3. If file size is greater than 5MB, this method uses parallel concurrent connections to upload.

Specified by:

write in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

writeAsync

public void writeAsync(org.apache.jackrabbit.core.data.DataIdentifier identifier,
              File file,
              org.apache.jackrabbit.core.data.AsyncUploadCallback callback)
                throws org.apache.jackrabbit.core.data.DataStoreException

Specified by:

writeAsync in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

exists

public boolean exists(org.apache.jackrabbit.core.data.DataIdentifier identifier)
               throws org.apache.jackrabbit.core.data.DataStoreException

Check if record identified by identifier exists in Amazon S3.

Specified by:

exists in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

exists

public boolean exists(org.apache.jackrabbit.core.data.DataIdentifier identifier,
             boolean touch)
               throws org.apache.jackrabbit.core.data.DataStoreException

Specified by:

exists in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

touchAsync

public void touchAsync(org.apache.jackrabbit.core.data.DataIdentifier identifier,
              long minModifiedDate,
              org.apache.jackrabbit.core.data.AsyncTouchCallback callback)
                throws org.apache.jackrabbit.core.data.DataStoreException

Specified by:

touchAsync in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

touch

public void touch(org.apache.jackrabbit.core.data.DataIdentifier identifier,
         long minModifiedDate)
           throws org.apache.jackrabbit.core.data.DataStoreException

Specified by:

touch in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

read

public InputStream read(org.apache.jackrabbit.core.data.DataIdentifier identifier)
                 throws org.apache.jackrabbit.core.data.DataStoreException

Specified by:

read in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

getAllIdentifiers

public Iterator<org.apache.jackrabbit.core.data.DataIdentifier> getAllIdentifiers()
                                                                           throws org.apache.jackrabbit.core.data.DataStoreException

Specified by:

getAllIdentifiers in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

getLastModified

public long getLastModified(org.apache.jackrabbit.core.data.DataIdentifier identifier)
                     throws org.apache.jackrabbit.core.data.DataStoreException

Specified by:

getLastModified in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

getLength

public long getLength(org.apache.jackrabbit.core.data.DataIdentifier identifier)
               throws org.apache.jackrabbit.core.data.DataStoreException

Specified by:

getLength in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

deleteRecord

public void deleteRecord(org.apache.jackrabbit.core.data.DataIdentifier identifier)
                  throws org.apache.jackrabbit.core.data.DataStoreException

Specified by:

deleteRecord in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

deleteAllOlderThan

public Set<org.apache.jackrabbit.core.data.DataIdentifier> deleteAllOlderThan(long min)
                                                                       throws org.apache.jackrabbit.core.data.DataStoreException

Specified by:

deleteAllOlderThan in interface org.apache.jackrabbit.core.data.Backend

Throws:

org.apache.jackrabbit.core.data.DataStoreException

close

public void close()

Specified by:

close in interface org.apache.jackrabbit.core.data.Backend

getBucket

public String getBucket()

setBucket

public void setBucket(String bucket)

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

addMetadataRecord

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

Description copied from interface: SharedS3Backend

Adds a metadata record with the specified name

Specified by:

addMetadataRecord in interface SharedS3Backend

Parameters:

input - the record input stream

name - the name

Throws:

org.apache.jackrabbit.core.data.DataStoreException

addMetadataRecord

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

Description copied from interface: SharedS3Backend

Adds a metadata record with the specified name

Specified by:

addMetadataRecord in interface SharedS3Backend

Parameters:

input - the record file

name - the name

Throws:

org.apache.jackrabbit.core.data.DataStoreException

getMetadataRecord

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

Description copied from interface: SharedS3Backend

Gets the metadata of the specified name.

Specified by:

getMetadataRecord in interface SharedS3Backend

Parameters:

name - the name of the record

Returns:

the metadata DataRecord

getAllMetadataRecords

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

Description copied from interface: SharedS3Backend

Gets all the metadata with a specified prefix.

Specified by:

getAllMetadataRecords in interface SharedS3Backend

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: SharedS3Backend

Deletes the metadata record with the specified name

Specified by:

deleteMetadataRecord in interface SharedS3Backend

Parameters:

name - the name of the record

Returns:

boolean to indicate success of deletion

deleteAllMetadataRecords

public void deleteAllMetadataRecords(String prefix)

Description copied from interface: SharedS3Backend

Deletes all the metadata records with the specified prefix.

Specified by:

deleteAllMetadataRecords in interface SharedS3Backend

Parameters:

prefix - the prefix of the record

getAllRecords

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

Description copied from interface: SharedS3Backend

Returns a list of all DataRecords

Specified by:

getAllRecords in interface SharedS3Backend

Returns:

iterator over DataRecords

getRecord

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

Description copied from interface: SharedS3Backend

Gets the record with the specified identifier

Specified by:

getRecord in interface SharedS3Backend

Parameters:

identifier - the record identifier

Returns:

the metadata DataRecord

Throws:

org.apache.jackrabbit.core.data.DataStoreException