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

Class S3Backend

java.lang.Object

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

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

All Implemented Interfaces:

org.apache.jackrabbit.oak.spi.blob.SharedBackend

public class S3Backend
extends org.apache.jackrabbit.oak.spi.blob.AbstractSharedBackend

A data store backend that stores data on Amazon S3.

Constructor Summary

Constructors

Constructor	Description
S3Backend()

Method Summary

Modifier and Type	Method	Description
void	addMetadataRecord(File input, String name)
void	addMetadataRecord(InputStream input, String name)
void	close()
void	deleteAllMetadataRecords(String prefix)
boolean	deleteMetadataRecord(String name)
void	deleteRecord(DataIdentifier identifier)
boolean	exists(DataIdentifier identifier)	Check if record identified by identifier exists in Amazon S3.
Iterator<DataIdentifier>	getAllIdentifiers()
List<DataRecord>	getAllMetadataRecords(String prefix)
Iterator<DataRecord>	getAllRecords()
String	getBucket()
DataRecord	getMetadataRecord(String name)
byte[]	getOrCreateReferenceKey()
DataRecord	getRecord(DataIdentifier identifier)
void	init()
boolean	metadataRecordExists(String name)
InputStream	read(DataIdentifier identifier)
void	setBucket(String bucket)
void	setProperties(Properties properties)	Properties used to configure the backend.
void	write(DataIdentifier identifier, File file)	It uploads file to Amazon S3.

Methods inherited from class org.apache.jackrabbit.oak.spi.blob.AbstractSharedBackend

getReferenceFromIdentifier

Methods inherited from class java.lang.Object

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

Constructor Details

S3Backend

public S3Backend()

Method Details

init

public void init()
          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.

Throws:

DataStoreException

exists

public boolean exists(DataIdentifier identifier)
               throws DataStoreException

Check if record identified by identifier exists in Amazon S3.

Throws:

DataStoreException

read

public InputStream read(DataIdentifier identifier)
                 throws DataStoreException

Throws:

DataStoreException

getAllIdentifiers

public Iterator<DataIdentifier> getAllIdentifiers()
                                           throws DataStoreException

Throws:

DataStoreException

deleteRecord

public void deleteRecord(DataIdentifier identifier)
                  throws DataStoreException

Throws:

DataStoreException

close

public void close()

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 DataStoreException

Throws:

DataStoreException

addMetadataRecord

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

Throws:

DataStoreException

getMetadataRecord

public DataRecord getMetadataRecord(String name)

getAllMetadataRecords

public List<DataRecord> getAllMetadataRecords(String prefix)

deleteMetadataRecord

public boolean deleteMetadataRecord(String name)

deleteAllMetadataRecords

public void deleteAllMetadataRecords(String prefix)

getAllRecords

public Iterator<DataRecord> getAllRecords()

getRecord

public DataRecord getRecord(DataIdentifier identifier)
                     throws DataStoreException

Throws:

DataStoreException

getOrCreateReferenceKey

public byte[] getOrCreateReferenceKey()
                               throws DataStoreException

Overrides:

getOrCreateReferenceKey in class org.apache.jackrabbit.oak.spi.blob.AbstractSharedBackend

Throws:

DataStoreException

metadataRecordExists

public boolean metadataRecordExists(String name)