Package org.opencastproject.assetmanager.aws

Class AwsAbstractArchive

java.lang.Object

org.opencastproject.assetmanager.aws.AwsAbstractArchive

All Implemented Interfaces:

AssetStore, StorageUsage

Direct Known Subclasses:

AwsS3AssetStore

public abstract class AwsAbstractArchive
extends Object
implements AssetStore

Field Summary

Fields

Modifier and Type	Field	Description
protected AwsAssetDatabase	database
protected String	regionName	The AWS region
protected String	storeType	The store type e.g. aws (long-term), or other implementations
protected Workspace	workspace

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

STORE_TYPE_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AwsAbstractArchive()

Method Summary

Modifier and Type	Method	Description
protected String	buildFilename(StoragePath path, String ext)	Builds the aws object name.
String	buildObjectName(File origin, StoragePath storagePath)
boolean	contains(StoragePath path)	Check if a resource exists.
boolean	copy(StoragePath from, StoragePath to)	Copy a resource to a new location.
boolean	delete(DeletionSelector sel)	Delete all selected resources.
protected abstract void	deleteObject(AwsAssetMapping map)
Optional<InputStream>	get(StoragePath path)	Get an input stream to a resource.
protected String	getAWSConfigKey(org.osgi.service.component.ComponentContext cc, String key)
protected File	getFileFromWorkspace(Source source)
protected abstract InputStream	getObject(AwsAssetMapping map)
String	getRegion()
String	getStoreType()	Returns the store.type property
Option<Long>	getTotalSpace()	Gets the total space of storage in Bytes
Option<Long>	getUsableSpace()	Gets the available space of storage in Bytes This is free storage that is not reserved
Option<Long>	getUsedSpace()	Gets the used space of storage in Bytes
void	put(StoragePath storagePath, Source source)	Add the content of soure under the given path.
void	setDatabase(AwsAssetDatabase db)	OSGi Di
void	setWorkspace(Workspace workspace)	OSGi Di
protected abstract AwsUploadOperationResult	uploadObject(String orgId, File origin, String objectName, Optional<MimeType> mimeType)

Methods inherited from class java.lang.Object

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

Field Details

workspace

protected Workspace workspace

database

protected AwsAssetDatabase database

storeType

protected String storeType

The store type e.g. aws (long-term), or other implementations

regionName

protected String regionName

The AWS region

Constructor Details

AwsAbstractArchive

public AwsAbstractArchive()

Method Details

getAWSConfigKey

protected String getAWSConfigKey(org.osgi.service.component.ComponentContext cc,
 String key)

getUsedSpace

public Option<Long> getUsedSpace()

Description copied from interface: StorageUsage

Gets the used space of storage in Bytes

Specified by:

getUsedSpace in interface StorageUsage

Returns:

Number of used bytes in storage

getUsableSpace

public Option<Long> getUsableSpace()

Description copied from interface: StorageUsage

Gets the available space of storage in Bytes This is free storage that is not reserved

Specified by:

getUsableSpace in interface StorageUsage

Returns:

Number of available bytes in storage

getTotalSpace

public Option<Long> getTotalSpace()

Description copied from interface: StorageUsage

Gets the total space of storage in Bytes

Specified by:

getTotalSpace in interface StorageUsage

Returns:

Number of all bytes in storage

getStoreType

public String getStoreType()

Description copied from interface: AssetStore

Returns the store.type property

Specified by:

getStoreType in interface AssetStore

Returns:

store type

getRegion

public String getRegion()

setWorkspace

public void setWorkspace(Workspace workspace)

OSGi Di

setDatabase

public void setDatabase(AwsAssetDatabase db)

OSGi Di

copy

public boolean copy(StoragePath from,
 StoragePath to)
             throws AssetStoreException

Description copied from interface: AssetStore

Copy a resource to a new location.

Specified by:

copy in interface AssetStore

Returns:

true, if the selected resource could be found and copied

Throws:

AssetStoreException

See Also:

• AssetStore.copy(StoragePath, StoragePath)

contains

public boolean contains(StoragePath path)
                 throws AssetStoreException

Description copied from interface: AssetStore

Check if a resource exists.

Specified by:

contains in interface AssetStore

Throws:

AssetStoreException

getFileFromWorkspace

protected File getFileFromWorkspace(Source source)

buildObjectName

public String buildObjectName(File origin,
 StoragePath storagePath)

buildFilename

protected String buildFilename(StoragePath path,
 String ext)

Builds the aws object name.

put

public void put(StoragePath storagePath,
 Source source)
         throws AssetStoreException

Description copied from interface: AssetStore

Add the content of soure under the given path.

Specified by:

put in interface AssetStore

Throws:

AssetStoreException

See Also:

• AssetStore.put(StoragePath, Source)

uploadObject

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

Throws:

AssetStoreException

get

public Optional<InputStream> get(StoragePath path)
                          throws AssetStoreException

Description copied from interface: AssetStore

Get an input stream to a resource.

Specified by:

get in interface AssetStore

Throws:

AssetStoreException

See Also:

• AssetStore.get(StoragePath)

getObject

protected abstract InputStream getObject(AwsAssetMapping map)
                                  throws AssetStoreException

Throws:

AssetStoreException

delete

public boolean delete(DeletionSelector sel)
               throws AssetStoreException

Description copied from interface: AssetStore

Delete all selected resources.

Specified by:

delete in interface AssetStore

Returns:

true, if the selected resources could be found and deleted

Throws:

AssetStoreException

See Also:

• AssetStore.delete(DeletionSelector)

deleteObject

protected abstract void deleteObject(AwsAssetMapping map)
                              throws AssetStoreException

Throws:

AssetStoreException