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

Interface ContentAddressableStorage

All Superinterfaces:

AutoCloseable, VitamAutoCloseable

All Known Implementing Classes:

ContentAddressableStorageAbstract, ContentAddressableStorageJcloudsAbstract, FileSystem, HashFileSystem, OpenstackSwift, Swift

public interface ContentAddressableStorage
extends VitamAutoCloseable

The ContentAddressableStorage interface.

Method Summary

Modifier and Type	Method and Description
boolean	checkObject(String containerName, String objectId, String digest, DigestType digestAlgorithm) Check object
String	computeObjectDigest(String containerName, String objectName, DigestType algo) compute Object Digest using a defined algorithm
long	countObjects(String containerName) Determines if a container exists
void	createContainer(String containerName) Creates a container
void	deleteObject(String containerName, String objectName) Deletes a object representing the data at location containerName/objectName
ContainerInformation	getContainerInformation(String containerName) Get container information like capacity
javax.ws.rs.core.Response	getObject(String containerName, String objectName) Retrieves an object representing the data at location containerName/objectName
javax.ws.rs.core.Response	getObjectAsync(String containerName, String objectName) Retrieves an object representing the data at location containerName/objectName
com.fasterxml.jackson.databind.JsonNode	getObjectInformation(String containerName, String objectName) Retrieves information about an object at location containerName/objectName
MetadatasObject	getObjectMetadatas(String containerName, String objectId) 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)
void	putObject(String containerName, String objectName, InputStream stream, DigestType digestType, Long size) Adds an object representing the data at location containerName/objectName

Methods inherited from interface fr.gouv.vitam.common.model.VitamAutoCloseable

close

Method Detail

createContainer

void createContainer(String containerName)
              throws ContentAddressableStorageAlreadyExistException,
                     ContentAddressableStorageServerException

Creates a container

Parameters:

containerName - name of container to create

Throws:

ContentAddressableStorageAlreadyExistException - Thrown when creating a container while it (containerName) already exists

ContentAddressableStorageServerException - Thrown when internal server error happens

isExistingContainer

boolean isExistingContainer(String containerName)
                     throws ContentAddressableStorageServerException

Determines if a container exists

Parameters:

containerName - name of container

Returns:

boolean type

Throws:

ContentAddressableStorageServerException - Thrown when internal server error happens

countObjects

long countObjects(String containerName)
           throws ContentAddressableStorageNotFoundException,
                  ContentAddressableStorageServerException

Determines if a container exists

Parameters:

containerName - name of container

Returns:

long number of binary objects (excluding directory markers)

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageServerException - Thrown when internal server error happens

putObject

void putObject(String containerName,
               String objectName,
               InputStream stream,
               DigestType digestType,
               Long size)
        throws ContentAddressableStorageException

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

javax.ws.rs.core.Response getObject(String containerName,
                                    String objectName)
                             throws ContentAddressableStorageNotFoundException,
                                    ContentAddressableStorageException

Retrieves an object representing the data at location containerName/objectName

WARNING : use this method only if the response has to be consumed right away. If the response has to be forwarded, you should use the method getObjectAsync instead

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

getObjectAsync

javax.ws.rs.core.Response getObjectAsync(String containerName,
                                         String objectName)
                                  throws ContentAddressableStorageNotFoundException,
                                         ContentAddressableStorageException

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

deleteObject

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

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

boolean isExistingObject(String containerName,
                         String objectName)
                  throws ContentAddressableStorageServerException

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

computeObjectDigest

String computeObjectDigest(String containerName,
                           String objectName,
                           DigestType algo)
                    throws ContentAddressableStorageNotFoundException,
                           ContentAddressableStorageServerException,
                           ContentAddressableStorageException

compute Object Digest using a defined algorithm

Parameters:

containerName - container where this exists.

objectName - fully qualified name relative to the container.

algo - Digest algo

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

ContainerInformation getContainerInformation(String containerName)
                                      throws ContentAddressableStorageNotFoundException,
                                             ContentAddressableStorageServerException

Get container information like capacity

Parameters:

containerName - the container name

Returns:

container information like usableSpace and usedSpace

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageServerException - Thrown when internal server error happens

getObjectInformation

com.fasterxml.jackson.databind.JsonNode getObjectInformation(String containerName,
                                                             String objectName)
                                                      throws ContentAddressableStorageNotFoundException,
                                                             ContentAddressableStorageException

Retrieves information about an object at location containerName/objectName

Parameters:

containerName - container where the object is.

objectName - fully qualified name relative to the container.

Returns:

the object informations as a JsonNode object

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageException - Thrown when get action failed due some other failure

checkObject

boolean checkObject(String containerName,
                    String objectId,
                    String digest,
                    DigestType digestAlgorithm)
             throws ContentAddressableStorageException

Check object

Parameters:

containerName - the container name

objectId - the objectId to check

digest - the digest to be compared with

digestAlgorithm - the digest Algorithm

Returns:

true if the digest is correct

Throws:

ContentAddressableStorageException - Thrown when check action failed due some other failure

getObjectMetadatas

MetadatasObject getObjectMetadatas(String containerName,
                                   String objectId)
                            throws ContentAddressableStorageException,
                                   IOException

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

IllegalArgumentException - thrown when containerName or objectId is null

listContainer

VitamPageSet<? extends VitamStorageMetadata> listContainer(String containerName)
                                                    throws ContentAddressableStorageNotFoundException,
                                                           ContentAddressableStorageServerException

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

VitamPageSet<? extends VitamStorageMetadata> listContainerNext(String containerName,
                                                               String nextMarker)
                                                        throws ContentAddressableStorageNotFoundException,
                                                               ContentAddressableStorageServerException

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