Package fr.gouv.vitam.common.storage.s3

Class AmazonS3V1

java.lang.Object

fr.gouv.vitam.common.storage.cas.container.api.ContentAddressableStorageAbstract

fr.gouv.vitam.common.storage.s3.AmazonS3V1

All Implemented Interfaces:

VitamAutoCloseable, ContentAddressableStorage, AutoCloseable

public class AmazonS3V1
extends ContentAddressableStorageAbstract

Amazon SDK S3 V1 abstract implementation Manage with all common amazon sdk s3 v1 methods.

Field Summary

Fields inherited from class fr.gouv.vitam.common.storage.cas.container.api.ContentAddressableStorageAbstract

LISTING_MAX_RESULTS

Constructor Summary

Constructors

Constructor	Description
AmazonS3V1(StorageConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
void	checkObjectDigestAndStoreDigest(String containerName, String objectName, String objectDigest, DigestType digestType, long size)	Checks objet digest & update persist its digest in object metadata
void	close()
void	createContainer(String containerName)	Creates a container
void	deleteObject(String containerName, String objectName)	Deletes a object representing the data at location containerName/objectName
String	generateBucketName(String containerName)	Generate a valid bucket name from the container name : replace non alphanumeric values by '.', lowercase every alphabetic value and remove '.
ContainerInformation	getContainerInformation(String containerName)	Get container information like capacity
ObjectContent	getObject(String containerName, String objectName)	Retrieves an object representing the data at location containerName/objectName
String	getObjectDigest(String containerName, String objectName, DigestType digestType, boolean noCache)	compute Object Digest using a defined algorithm
MetadatasObject	getObjectMetadata(String containerName, String objectId, boolean noCache)	get metadata of the object
boolean	isExistingContainer(String containerName)	Determines if a container exists
boolean	isExistingObject(String containerName, String objectName)	Determines if an object exists
void	listContainer(String containerName, ObjectListingListener objectListingListener)	List container objects
void	writeObject(String containerName, String objectName, InputStream inputStream, DigestType digestType, long size)	Adds an object representing the data at location containerName/objectName

Methods inherited from class fr.gouv.vitam.common.storage.cas.container.api.ContentAddressableStorageAbstract

cacheExistsContainer, computeObjectDigest, disableContainerCaching, getConfiguration, isExistingContainerInCache

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.gouv.vitam.common.storage.cas.container.api.ContentAddressableStorage

checkAccessRequestStatuses, checkObjectAvailability, createAccessRequest, putObject, removeAccessRequest

Constructor Details

AmazonS3V1

public AmazonS3V1(StorageConfiguration configuration)
           throws KeyManagementException,
NoSuchAlgorithmException,
KeyStoreException,
CertificateException,
IOException

Throws:

KeyManagementException

NoSuchAlgorithmException

KeyStoreException

CertificateException

IOException

Method Details

createContainer

public void createContainer(String containerName)
                     throws ContentAddressableStorageServerException

Description copied from interface: ContentAddressableStorage

Creates a container

Parameters:

containerName - name of container to create

Throws:

ContentAddressableStorageServerException - Thrown when internal server error happens

isExistingContainer

public boolean isExistingContainer(String containerName)
                            throws ContentAddressableStorageServerException

Description copied from interface: ContentAddressableStorage

Determines if a container exists

Parameters:

containerName - name of container

Returns:

boolean type

Throws:

ContentAddressableStorageServerException - Thrown when internal server error happens

writeObject

public void writeObject(String containerName,
 String objectName,
 InputStream inputStream,
 DigestType digestType,
 long size)
                 throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

Adds an object representing the data at location containerName/objectName

Parameters:

containerName - container to place the object.

objectName - fully qualified object name relative to the container.

inputStream - the data

digestType - parameter to compute an hash.

size - size off the input stream

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageException - Thrown when put action failed due some other failure

ContentAddressableStorageAlreadyExistException - Thrown when object creating exists

checkObjectDigestAndStoreDigest

public void checkObjectDigestAndStoreDigest(String containerName,
 String objectName,
 String objectDigest,
 DigestType digestType,
 long size)
                                     throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

Checks objet digest & update persist its digest in object metadata

Parameters:

containerName - container to place the object.

objectName - fully qualified object name relative to the container.

objectDigest - object digest value

digestType - object digest type

size - size off the input stream

Throws:

ContentAddressableStorageException

getObject

public ObjectContent getObject(String containerName,
 String objectName)
                        throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

Retrieves an object representing the data at location containerName/objectName

Parameters:

containerName - container where this exists.

objectName - fully qualified name relative to the container.

Returns:

the object you intended to receive

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageUnavailableDataFromAsyncOfferException - Thrown when object cannot be read due to missing access request on AsyncRead ContentAddressableStorage

ContentAddressableStorageException - Thrown when get action failed due some other failure

deleteObject

public void deleteObject(String containerName,
 String objectName)
                  throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

Deletes a object representing the data at location containerName/objectName

Parameters:

containerName - container where this exists.

objectName - fully qualified name relative to the container.

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located or the blob cannot be located in the container.

ContentAddressableStorageException - Thrown when delete action failed due some other failure

isExistingObject

public boolean isExistingObject(String containerName,
 String objectName)
                         throws ContentAddressableStorageServerException

Description copied from interface: ContentAddressableStorage

Determines if an object exists

Parameters:

containerName - container where the object resides

objectName - fully qualified name relative to the container.

Returns:

boolean type

Throws:

ContentAddressableStorageServerException - Thrown when internal server error happens

getObjectDigest

public String getObjectDigest(String containerName,
 String objectName,
 DigestType digestType,
 boolean noCache)
                       throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

compute Object Digest using a defined algorithm

Parameters:

containerName - container where this exists.

objectName - fully qualified name relative to the container.

digestType - Digest algo

noCache - forces full digest computation

Returns:

the digest object as String

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container or the object cannot be located

ContentAddressableStorageServerException - Thrown when internal server error happens

ContentAddressableStorageException - Thrown when put action failed due some other failure

getContainerInformation

public ContainerInformation getContainerInformation(String containerName)
                                             throws ContentAddressableStorageNotFoundException,
ContentAddressableStorageServerException

Description copied from interface: ContentAddressableStorage

Get container information like capacity

Parameters:

containerName - the container name

Returns:

container information like usableSpace

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageServerException - Thrown when internal server error happens

getObjectMetadata

public MetadatasObject getObjectMetadata(String containerName,
 String objectId,
 boolean noCache)
                                  throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

get metadata of the object

Parameters:

containerName - the container name

objectId - the objectId to check

Returns:

MetadatasObjectResult

Throws:

ContentAddressableStorageException - Thrown when get action failed due some other failure

listContainer

public void listContainer(String containerName,
 ObjectListingListener objectListingListener)
                   throws ContentAddressableStorageNotFoundException,
ContentAddressableStorageServerException,
IOException

Description copied from interface: ContentAddressableStorage

List container objects

Parameters:

containerName - the container name

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageServerException - Thrown when internal server error happens

IOException

close

public void close()

generateBucketName

public String generateBucketName(String containerName)

Generate a valid bucket name from the container name : replace non alphanumeric values by '.', lowercase every alphabetic value and remove '. 'at start and end.

Parameters:

containerName - vitam container name

Returns:

bucket name valid according to s3 API specification

See Also:

• Bucket restrictions and limitations