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

Class S3DataStore

java.lang.Object

org.apache.jackrabbit.core.data.AbstractDataStore

org.apache.jackrabbit.oak.plugins.blob.AbstractSharedCachingDataStore

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

All Implemented Interfaces:

org.apache.jackrabbit.core.data.DataStore, org.apache.jackrabbit.core.data.MultiDataStoreAware, org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.ConfigurableDataRecordAccessProvider, org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordAccessProvider, org.apache.jackrabbit.oak.plugins.blob.datastore.TypedDataStore, org.apache.jackrabbit.oak.plugins.blob.SharedDataStore

public class S3DataStore
extends org.apache.jackrabbit.oak.plugins.blob.AbstractSharedCachingDataStore
implements org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.ConfigurableDataRecordAccessProvider

Amazon S3 data store extending from AbstractSharedCachingDataStore.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.plugins.blob.SharedDataStore

org.apache.jackrabbit.oak.plugins.blob.SharedDataStore.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	properties

Fields inherited from class org.apache.jackrabbit.oak.plugins.blob.AbstractSharedCachingDataStore

backend, executor, listeningExecutor, schedulerExecutor

Fields inherited from class org.apache.jackrabbit.core.data.AbstractDataStore

DIGEST

Constructor Summary

Constructors

Constructor and Description
S3DataStore()

Method Summary

Modifier and Type	Method and Description
@NotNull org.apache.jackrabbit.core.data.DataRecord	completeDataRecordUpload(@NotNull String uploadToken)
protected org.apache.jackrabbit.oak.spi.blob.AbstractSharedBackend	createBackend()
org.apache.jackrabbit.oak.spi.blob.SharedBackend	getBackend()
@Nullable URI	getDownloadURI(@NotNull org.apache.jackrabbit.core.data.DataIdentifier identifier, @NotNull org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordDownloadOptions downloadOptions)
int	getMinRecordLength()
@Nullable org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordUpload	initiateDataRecordUpload(long maxUploadSizeInBytes, int maxNumberOfURIs)
void	setBinaryTransferAccelerationEnabled(boolean enabled)
void	setDirectDownloadURICacheSize(int maxSize)
void	setDirectDownloadURIExpirySeconds(int seconds)
void	setDirectUploadURIExpirySeconds(int seconds)
void	setMinRecordLength(int minRecordLength)
void	setProperties(Properties properties) Properties required to configure the S3Backend

Methods inherited from class org.apache.jackrabbit.oak.plugins.blob.AbstractSharedCachingDataStore

addMetadataRecord, addMetadataRecord, addRecord, addRecord, clearInUse, close, deleteAllMetadataRecords, deleteAllOlderThan, deleteMetadataRecord, deleteRecord, exists, getAllIdentifiers, getAllMetadataRecords, getAllRecords, getCache, getMetadataRecord, getOrCreateReferenceKey, getRecord, getRecordForId, getRecordIfStored, getStats, getType, init, setCacheSize, setPath, setStagingPurgeInterval, setStagingRetryInterval, setStagingSplitPercentage, setStatisticsProvider, setUploadThreads, updateModifiedDateOnAccess

Methods inherited from class org.apache.jackrabbit.core.data.AbstractDataStore

encodeHexString, getRecordFromReference, getReferenceFromIdentifier

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected Properties properties

Constructor Detail

S3DataStore

public S3DataStore()

Method Detail

createBackend

protected org.apache.jackrabbit.oak.spi.blob.AbstractSharedBackend createBackend()

Specified by:

createBackend in class org.apache.jackrabbit.oak.plugins.blob.AbstractSharedCachingDataStore

setProperties

public void setProperties(Properties properties)

Properties required to configure the S3Backend

getBackend

public org.apache.jackrabbit.oak.spi.blob.SharedBackend getBackend()

getMinRecordLength

public int getMinRecordLength()

Specified by:

getMinRecordLength in interface org.apache.jackrabbit.core.data.DataStore

setMinRecordLength

public void setMinRecordLength(int minRecordLength)

setDirectUploadURIExpirySeconds

public void setDirectUploadURIExpirySeconds(int seconds)

Specified by:

setDirectUploadURIExpirySeconds in interface org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.ConfigurableDataRecordAccessProvider

setBinaryTransferAccelerationEnabled

public void setBinaryTransferAccelerationEnabled(boolean enabled)

Specified by:

setBinaryTransferAccelerationEnabled in interface org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.ConfigurableDataRecordAccessProvider

initiateDataRecordUpload

@Nullable
public @Nullable org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordUpload initiateDataRecordUpload(long maxUploadSizeInBytes,
                                                                                                                                   int maxNumberOfURIs)
                                                                                                                            throws IllegalArgumentException,
                                                                                                                                   org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordUploadException

Specified by:

initiateDataRecordUpload in interface org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordAccessProvider

Throws:

IllegalArgumentException

org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordUploadException

completeDataRecordUpload

@NotNull
public @NotNull org.apache.jackrabbit.core.data.DataRecord completeDataRecordUpload(@NotNull
                                                                                             @NotNull String uploadToken)
                                                                                      throws IllegalArgumentException,
                                                                                             org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordUploadException,
                                                                                             org.apache.jackrabbit.core.data.DataStoreException

Specified by:

completeDataRecordUpload in interface org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordAccessProvider

Throws:

IllegalArgumentException

org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordUploadException

org.apache.jackrabbit.core.data.DataStoreException

setDirectDownloadURIExpirySeconds

public void setDirectDownloadURIExpirySeconds(int seconds)

Specified by:

setDirectDownloadURIExpirySeconds in interface org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.ConfigurableDataRecordAccessProvider

setDirectDownloadURICacheSize

public void setDirectDownloadURICacheSize(int maxSize)

Specified by:

setDirectDownloadURICacheSize in interface org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.ConfigurableDataRecordAccessProvider

getDownloadURI

@Nullable
public @Nullable URI getDownloadURI(@NotNull
                                              @NotNull org.apache.jackrabbit.core.data.DataIdentifier identifier,
                                              @NotNull
                                              @NotNull org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordDownloadOptions downloadOptions)

Specified by:

getDownloadURI in interface org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordAccessProvider