org.apache.jackrabbit.aws.ext.ds

Class S3Backend

java.lang.Object

org.apache.jackrabbit.aws.ext.ds.S3Backend

All Implemented Interfaces:

Backend

public class S3Backend
extends Object
implements Backend

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	close() Close backend and release resources like database connection if any.
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) Check if record identified by identifier exists in Amazon S3.
boolean	exists(DataIdentifier identifier, boolean touch) This method check the existence of record in backend.
Iterator<DataIdentifier>	getAllIdentifiers() Returns identifiers of all records that exists in backend.
String	getBucket()
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, String homeDir, Properties prop)
void	init(CachingDataStore store, String homeDir, String config) Initialize S3Backend.
InputStream	read(DataIdentifier identifier) Return inputstream of record identified by identifier.
void	setBucket(String bucket)
void	setProperties(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, File file) It uploads file to Amazon S3.
void	writeAsync(DataIdentifier identifier, File file, AsyncUploadCallback callback) Write file to backend in asynchronous mode.

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(CachingDataStore store,
        String homeDir,
        String config)
          throws 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 Backend

Parameters:

store - CachingDataStore

homeDir - path of repository home dir.

config - path of config property file.

Throws:

DataStoreException

init

public void init(CachingDataStore store,
        String homeDir,
        Properties prop)
          throws DataStoreException

Throws:

DataStoreException

write

public void write(DataIdentifier identifier,
         File file)
           throws 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 Backend

Parameters:

identifier - key of the file

file - file that would be stored in backend.

Throws:

DataStoreException - for any error.

writeAsync

public void writeAsync(DataIdentifier identifier,
              File file,
              AsyncUploadCallback callback)
                throws DataStoreException

Description copied from interface: Backend

Write file to backend in asynchronous mode.

Specified by:

writeAsync in interface Backend

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

Throws:

DataStoreException

exists

public boolean exists(DataIdentifier identifier)
               throws DataStoreException

Check if record identified by identifier exists in Amazon S3.

Specified by:

exists in interface Backend

Parameters:

identifier - identifier to be checked.

Returns:

true if records exists else false.

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.

Specified by:

exists in interface Backend

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.

Specified by:

touchAsync in interface Backend

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.

Specified by:

touch in interface Backend

Throws:

DataStoreException

read

public InputStream read(DataIdentifier identifier)
                 throws DataStoreException

Description copied from interface: Backend

Return inputstream of record identified by identifier.

Specified by:

read in interface Backend

Parameters:

identifier - identifier of record.

Returns:

inputstream of the record.

Throws:

DataStoreException - if record not found or any error.

getAllIdentifiers

public Iterator<DataIdentifier> getAllIdentifiers()
                                           throws DataStoreException

Description copied from interface: Backend

Returns identifiers of all records that exists in backend.

Specified by:

getAllIdentifiers in interface Backend

Returns:

iterator consisting of all identifiers

Throws:

DataStoreException

getLastModified

public long getLastModified(DataIdentifier identifier)
                     throws DataStoreException

Description copied from interface: Backend

Return lastModified of record identified by identifier.

Specified by:

getLastModified in interface Backend

Parameters:

identifier - identifier of record.

Returns:

lastModified 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.

Specified by:

getLength in interface Backend

Parameters:

identifier - identifier of record.

Returns:

length of the record.

Throws:

DataStoreException - if record not found or any error.

deleteRecord

public void deleteRecord(DataIdentifier identifier)
                  throws DataStoreException

Description copied from interface: Backend

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

Specified by:

deleteRecord in interface Backend

Throws:

DataStoreException

deleteAllOlderThan

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

Description copied from interface: Backend

Delete all records which are older than timestamp.

Specified by:

deleteAllOlderThan in interface Backend

Returns:

Set of identifiers which are deleted.

Throws:

DataStoreException

close

public void close()

Description copied from interface: Backend

Close backend and release resources like database connection if any.

Specified by:

close in interface 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