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

Class ContentAddressableStorageJcloudsAbstract

java.lang.Object

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

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

All Implemented Interfaces:

VitamAutoCloseable, ContentAddressableStorage, AutoCloseable

Direct Known Subclasses:

FileSystem, OpenstackSwift

public abstract class ContentAddressableStorageJcloudsAbstract
extends ContentAddressableStorageAbstract

Abstract class of CAS that contains common methods for a Jclouds backend

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jclouds.blobstore.BlobStoreContext	context

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

LISTING_MAX_RESULTS

Constructor Summary

Constructors

Constructor and Description
ContentAddressableStorageJcloudsAbstract(StorageConfiguration configuration) creates a new ContentAddressableStorageImpl with a storage configuration param

Method Summary

Modifier and Type	Method and Description
abstract void	closeContext() Close context according to implementation (http client not closed)
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
StorageConfiguration	getConfiguration()
abstract ContainerInformation	getContainerInformation(String containerName) Get container information like capacity
abstract org.jclouds.blobstore.BlobStoreContext	getContext(StorageConfiguration configuration) enables the connection to a storage service with the param provided
int	getMaxResults()
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
abstract 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
ContentAddressableStorageJcloudsAbstract	setConfiguration(StorageConfiguration configuration)

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

checkObject, computeObjectDigest

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.model.VitamAutoCloseable

close

Field Detail

context

protected final org.jclouds.blobstore.BlobStoreContext context

Constructor Detail

ContentAddressableStorageJcloudsAbstract

public ContentAddressableStorageJcloudsAbstract(StorageConfiguration configuration)

creates a new ContentAddressableStorageImpl with a storage configuration param

Parameters:

configuration - StorageConfiguration

Method Detail

getContext

public abstract org.jclouds.blobstore.BlobStoreContext getContext(StorageConfiguration configuration)

enables the connection to a storage service with the param provided

Parameters:

configuration - the storage configuration

Returns:

BlobStoreContext

closeContext

public abstract void closeContext()

Close context according to implementation (http client not closed)

createContainer

public void createContainer(String containerName)
                     throws ContentAddressableStorageAlreadyExistException

Description copied from interface: ContentAddressableStorage

Creates a container

Parameters:

containerName - name of container to create

Throws:

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

isExistingContainer

public boolean isExistingContainer(String containerName)

Description copied from interface: ContentAddressableStorage

Determines if a container exists

Parameters:

containerName - name of container

Returns:

boolean type

countObjects

public long countObjects(String containerName)
                  throws ContentAddressableStorageNotFoundException

Description copied from interface: ContentAddressableStorage

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.

putObject

public void 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 javax.ws.rs.core.Response getObject(String containerName,
                                           String objectName)
                                    throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

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

public javax.ws.rs.core.Response getObjectAsync(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.

ContentAddressableStorageException - Thrown when get action failed due some other failure

ContentAddressableStorageAlreadyExistException - Thrown when object creating exists

deleteObject

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

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.

isExistingObject

public boolean isExistingObject(String containerName,
                                String objectName)

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

getContainerInformation

public abstract ContainerInformation getContainerInformation(String containerName)
                                                      throws ContentAddressableStorageNotFoundException

Description copied from interface: ContentAddressableStorage

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.

getObjectInformation

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

Description copied from interface: ContentAddressableStorage

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

getConfiguration

public StorageConfiguration getConfiguration()

Returns:

the configuration

setConfiguration

public ContentAddressableStorageJcloudsAbstract setConfiguration(StorageConfiguration configuration)

Parameters:

configuration - the configuration to set

Returns:

this

getMaxResults

public int getMaxResults()

Returns:

the maxResults

listContainer

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

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.

listContainerNext

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

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.

getObjectMetadatas

public abstract MetadatasObject getObjectMetadatas(String containerName,
                                                   String objectId)
                                            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