AmazonS3V1 (Vitam API Reference (2.15.1-1))

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 and Description

AmazonS3V1(StorageConfiguration configuration)
Constructor TODO gafou define exceptions + tu

Constructors
Constructor and Description
`AmazonS3V1(StorageConfiguration configuration)` Constructor TODO gafou define exceptions + tu

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`createContainer(String containerName)` Creates a container
`String`	`createReadOrderRequest(String containerName, List<String> objectsIds)` Create read order (asynchronous read from tape to local FS) for the given objects representing the data at location containerName/objectId.
`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
`VitamPageSet<? extends VitamStorageMetadata>`	`listContainer(String containerName)` List container (create cursor)
`VitamPageSet<? extends VitamStorageMetadata>`	`listContainerNext(String containerName, String nextMarker)` List container (next on cursor)
`String`	`putObject(String containerName, String objectName, InputStream stream, DigestType digestType, Long size)` Adds an object representing the data at location containerName/objectName
`void`	`removeReadOrderRequest(String readRequestID)` Purge all read request id to cleanup local FS

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

- Constructor Detail
  - AmazonS3V1
```
public AmazonS3V1(StorageConfiguration configuration)
           throws KeyManagementException,
                  NoSuchAlgorithmException,
                  KeyStoreException,
                  CertificateException,
                  IOException
```
    Constructor TODO gafou define exceptions + tu
    
    Throws:
    
    IOException
    
    CertificateException
    
    KeyStoreException
    
    NoSuchAlgorithmException
    
    KeyManagementException
- Method Detail
  - 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
  - putObject
```
public String putObject(String containerName,
                        String objectName,
                        InputStream stream,
                        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.
    
    stream - 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
  - getObject
```
public ObjectContent getObject(String containerName,
                               String objectName)
                        throws ContentAddressableStorageNotFoundException,
                               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.
    
    ContentAddressableStorageException - Thrown when get action failed due some other failure
    
    ContentAddressableStorageAlreadyExistException - Thrown when object creating exists
  - createReadOrderRequest
```
public String createReadOrderRequest(String containerName,
                                     List<String> objectsIds)
```
    Description copied from interface: ContentAddressableStorage
    
    Create read order (asynchronous read from tape to local FS) for the given objects representing the data at location containerName/objectId. Return read order entity
    
    Parameters:
    
    containerName - container where this exists.
    
    objectsIds - list of the fully qualified name relative to the container.
    
    Returns:
    
    read order request id
  - removeReadOrderRequest
```
public void removeReadOrderRequest(String readRequestID)
```
    Description copied from interface: ContentAddressableStorage
    
    Purge all read request id to cleanup local FS
    
    Parameters:
    
    readRequestID - the read request ID.
  - deleteObject
```
public void deleteObject(String containerName,
                         String objectName)
                  throws ContentAddressableStorageNotFoundException,
                         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 ContentAddressableStorageNotFoundException,
                              ContentAddressableStorageServerException,
                              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,
                                         IOException
```
    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
    
    IOException - if an IOException is encountered with files
  - listContainer
```
public VitamPageSet<? extends VitamStorageMetadata> listContainer(String containerName)
                                                           throws ContentAddressableStorageNotFoundException,
                                                                  ContentAddressableStorageServerException
```
    Description copied from interface: ContentAddressableStorage
    
    List container (create cursor)
    
    Parameters:
    
    containerName - the container name
    
    Returns:
    
    container listing
    
    Throws:
    
    ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.
    
    ContentAddressableStorageServerException - Thrown when internal server error happens
  - listContainerNext
```
public VitamPageSet<? extends VitamStorageMetadata> listContainerNext(String containerName,
                                                                      String nextMarker)
                                                               throws ContentAddressableStorageNotFoundException,
                                                                      ContentAddressableStorageServerException
```
    Description copied from interface: ContentAddressableStorage
    
    List container (next on cursor)
    
    Parameters:
    
    containerName - the container name
    
    nextMarker - the last id of the list to get next
    
    Returns:
    
    container listing
    
    Throws:
    
    ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.
    
    ContentAddressableStorageServerException - Thrown when internal server error happens
  - 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:
    
    https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html

Class AmazonS3V1

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

AmazonS3V1

Method Detail

createContainer

isExistingContainer

putObject

getObject

createReadOrderRequest

removeReadOrderRequest

deleteObject

isExistingObject

getObjectDigest

getContainerInformation

getObjectMetadata

listContainer

listContainerNext

close

generateBucketName