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

Class ContentAddressableStorageAbstract

java.lang.Object

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

All Implemented Interfaces:

VitamAutoCloseable, ContentAddressableStorage, AutoCloseable

Direct Known Subclasses:

ContentAddressableStorageJcloudsAbstract, HashFileSystem, Swift

public abstract class ContentAddressableStorageAbstract
extends Object
implements ContentAddressableStorage

Abstract class of CAS that contains common methos

Field Summary

Fields

Modifier and Type	Field and Description
static int	LISTING_MAX_RESULTS Max result for listing option TODO: have to be configurable ?

Constructor Summary

Constructors

Constructor and Description
ContentAddressableStorageAbstract()

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

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

countObjects, createContainer, deleteObject, getContainerInformation, getObject, getObjectAsync, getObjectInformation, getObjectMetadatas, isExistingContainer, isExistingObject, listContainer, listContainerNext, putObject

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

close

Field Detail

LISTING_MAX_RESULTS

public static final int LISTING_MAX_RESULTS

Max result for listing option TODO: have to be configurable ?

See Also:

Constant Field Values

Constructor Detail

ContentAddressableStorageAbstract

public ContentAddressableStorageAbstract()

Method Detail

computeObjectDigest

public String computeObjectDigest(String containerName,
                                  String objectName,
                                  DigestType algo)
                           throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

compute Object Digest using a defined algorithm

Specified by:

computeObjectDigest in interface ContentAddressableStorage

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

checkObject

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

Description copied from interface: ContentAddressableStorage

Check object

Specified by:

checkObject in interface ContentAddressableStorage

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