Package org.opencastproject.assetmanager.aws.s3

Class AwsS3AssetStore

java.lang.Object

org.opencastproject.assetmanager.aws.AwsAbstractArchive

org.opencastproject.assetmanager.aws.s3.AwsS3AssetStore

All Implemented Interfaces:

AssetStore, RemoteAssetStore, StorageUsage

public class AwsS3AssetStore
extends AwsAbstractArchive
implements RemoteAssetStore

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AWS_GLACIER_RESTORE_DAYS
static final String	AWS_S3_ACCESS_KEY_ID_CONFIG
static final String	AWS_S3_BUCKET_CONFIG
static final String	AWS_S3_CONNECTION_TIMEOUT
static final String	AWS_S3_ENABLED
static final String	AWS_S3_ENDPOINT_CONFIG
static final Integer	AWS_S3_GLACIER_RESTORE_DAYS_DEFAULT
static final String	AWS_S3_MAX_CONNECTIONS
static final String	AWS_S3_MAX_RETRIES
static final String	AWS_S3_PATH_STYLE_CONFIG
static final String	AWS_S3_REGION_CONFIG
static final String	AWS_S3_SECRET_ACCESS_KEY_CONFIG
protected boolean	bucketCreated
static final int	DEFAULT_CONNECTION_TIMEOUT
static final int	DEFAULT_MAX_CONNECTIONS
static final int	DEFAULT_MAX_RETRIES
static final long	DOWNLOAD_URL_EXPIRATION_MS

Fields inherited from class org.opencastproject.assetmanager.aws.AwsAbstractArchive

database, regionName, storeType, workspace

Fields inherited from interface org.opencastproject.assetmanager.api.storage.AssetStore

STORE_TYPE_PROPERTY

Fields inherited from interface org.opencastproject.assetmanager.api.storage.RemoteAssetStore

ASSET_STORE_CACHE_ROOT

Constructor Summary

Constructors

Constructor	Description
AwsS3AssetStore()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Service activator, called via declarative services configuration.
protected void	deleteObject(AwsAssetMapping map)
String	getAssetObjectKey(StoragePath storagePath)	Return the object key of the asset in S3
String	getAssetRestoreStatusString(StoragePath storagePath)
String	getAssetStorageClass(StoragePath storagePath)	Return the storage class of the asset in S3
protected InputStream	getObject(AwsAssetMapping map)
Integer	getRestorePeriod()
void	initiateRestoreAsset(StoragePath storagePath, Integer assetRestorePeriod)
String	modifyAssetStorageClass(StoragePath storagePath, String storageClassId)	Change the storage class of the object if possible
void	setDatabase(AwsAssetDatabase db)	OSGi Di
void	setWorkspace(Workspace workspace)	OSGi Di
protected AwsUploadOperationResult	uploadObject(File origin, String objectName, Optional<MimeType> mimeType)	Returns the aws s3 object id created by aws

Methods inherited from class org.opencastproject.assetmanager.aws.AwsAbstractArchive

buildFilename, buildObjectName, contains, copy, delete, get, getAWSConfigKey, getFileFromWorkspace, getRegion, getStoreType, getTotalSpace, getUsableSpace, getUsedSpace, put

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencastproject.assetmanager.api.storage.AssetStore

contains, copy, delete, get, getStoreType, put

Methods inherited from interface org.opencastproject.storage.StorageUsage

getTotalSpace, getUsableSpace, getUsedSpace

Field Details

AWS_S3_ENABLED

public static final String AWS_S3_ENABLED

See Also:

• Constant Field Values

AWS_S3_ACCESS_KEY_ID_CONFIG

public static final String AWS_S3_ACCESS_KEY_ID_CONFIG

See Also:

• Constant Field Values

AWS_S3_SECRET_ACCESS_KEY_CONFIG

public static final String AWS_S3_SECRET_ACCESS_KEY_CONFIG

See Also:

• Constant Field Values

AWS_S3_REGION_CONFIG

public static final String AWS_S3_REGION_CONFIG

See Also:

• Constant Field Values

AWS_S3_BUCKET_CONFIG

public static final String AWS_S3_BUCKET_CONFIG

See Also:

• Constant Field Values

AWS_S3_ENDPOINT_CONFIG

public static final String AWS_S3_ENDPOINT_CONFIG

See Also:

• Constant Field Values

AWS_S3_PATH_STYLE_CONFIG

public static final String AWS_S3_PATH_STYLE_CONFIG

See Also:

• Constant Field Values

AWS_S3_MAX_CONNECTIONS

public static final String AWS_S3_MAX_CONNECTIONS

See Also:

• Constant Field Values

AWS_S3_CONNECTION_TIMEOUT

public static final String AWS_S3_CONNECTION_TIMEOUT

See Also:

• Constant Field Values

AWS_S3_MAX_RETRIES

public static final String AWS_S3_MAX_RETRIES

See Also:

• Constant Field Values

AWS_GLACIER_RESTORE_DAYS

public static final String AWS_GLACIER_RESTORE_DAYS

See Also:

• Constant Field Values

AWS_S3_GLACIER_RESTORE_DAYS_DEFAULT

public static final Integer AWS_S3_GLACIER_RESTORE_DAYS_DEFAULT

DEFAULT_MAX_CONNECTIONS

public static final int DEFAULT_MAX_CONNECTIONS

See Also:

• Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

See Also:

• Constant Field Values

DEFAULT_MAX_RETRIES

public static final int DEFAULT_MAX_RETRIES

See Also:

• Constant Field Values

DOWNLOAD_URL_EXPIRATION_MS

public static final long DOWNLOAD_URL_EXPIRATION_MS

See Also:

• Constant Field Values

bucketCreated

protected boolean bucketCreated

Constructor Details

AwsS3AssetStore

public AwsS3AssetStore()

Method Details

setWorkspace

public void setWorkspace(Workspace workspace)

OSGi Di

Overrides:

setWorkspace in class AwsAbstractArchive

setDatabase

public void setDatabase(AwsAssetDatabase db)

OSGi Di

Overrides:

setDatabase in class AwsAbstractArchive

activate

public void activate(org.osgi.service.component.ComponentContext cc)
              throws IllegalStateException,
ConfigurationException

Service activator, called via declarative services configuration.

Parameters:

cc - the component context

Throws:

IllegalStateException

ConfigurationException

uploadObject

protected AwsUploadOperationResult uploadObject(File origin,
 String objectName,
 Optional<MimeType> mimeType)
                                         throws AssetStoreException

Returns the aws s3 object id created by aws

Specified by:

uploadObject in class AwsAbstractArchive

Throws:

AssetStoreException

getAssetObjectKey

public String getAssetObjectKey(StoragePath storagePath)
                         throws AssetStoreException

Return the object key of the asset in S3

Parameters:

storagePath - asset storage path

Throws:

AssetStoreException

getAssetStorageClass

public String getAssetStorageClass(StoragePath storagePath)
                            throws AssetStoreException

Return the storage class of the asset in S3

Parameters:

storagePath - asset storage path

Throws:

AssetStoreException

modifyAssetStorageClass

public String modifyAssetStorageClass(StoragePath storagePath,
 String storageClassId)
                               throws AssetStoreException

Change the storage class of the object if possible

Parameters:

storagePath - asset storage path

storageClassId - metadata storage class id

Throws:

AssetStoreException

See Also:

• The S3 storage class docs

getObject

protected InputStream getObject(AwsAssetMapping map)

Specified by:

getObject in class AwsAbstractArchive

getAssetRestoreStatusString

public String getAssetRestoreStatusString(StoragePath storagePath)

initiateRestoreAsset

public void initiateRestoreAsset(StoragePath storagePath,
 Integer assetRestorePeriod)
                          throws AssetStoreException

Throws:

AssetStoreException

deleteObject

protected void deleteObject(AwsAssetMapping map)

Specified by:

deleteObject in class AwsAbstractArchive

getRestorePeriod

public Integer getRestorePeriod()