Package fr.gouv.vitam.common.storage.filesystem.v2

Class HashFileSystem

java.lang.Object

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

fr.gouv.vitam.common.storage.filesystem.v2.HashFileSystem

All Implemented Interfaces:

VitamAutoCloseable, ContentAddressableStorage, java.lang.AutoCloseable

public class HashFileSystem
extends ContentAddressableStorageAbstract

FileSystem implements a Content Addressable Storage that stores objects on the file system with a hierarchical vision

Field Summary

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

LISTING_MAX_RESULTS

Constructor Summary

Constructors

Constructor	Description
HashFileSystem(StorageConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
void	close()
void	createContainer(java.lang.String containerName)	Creates a container
java.lang.String	createReadOrderRequest(java.lang.String containerName, java.util.List<java.lang.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(java.lang.String containerName, java.lang.String objectName)	Deletes a object representing the data at location containerName/objectName
ContainerInformation	getContainerInformation(java.lang.String containerName)	Get container information like capacity
ObjectContent	getObject(java.lang.String containerName, java.lang.String objectName)	Retrieves an object representing the data at location containerName/objectName
java.lang.String	getObjectDigest(java.lang.String containerName, java.lang.String objectName, DigestType algo, boolean noCache)	compute Object Digest using a defined algorithm
MetadatasObject	getObjectMetadata(java.lang.String containerName, java.lang.String objectId, boolean noCache)	get metadata of the object
boolean	isExistingContainer(java.lang.String containerName)	Determines if a container exists
boolean	isExistingObject(java.lang.String containerName, java.lang.String objectName)	Determines if an object exists
void	listContainer(java.lang.String containerName, ObjectListingListener objectListingListener)	List container objects
java.lang.String	putObject(java.lang.String containerName, java.lang.String objectName, java.io.InputStream stream, DigestType digestType, java.lang.Long size)	Adds an object representing the data at location containerName/objectName
void	removeReadOrderRequest(java.lang.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

HashFileSystem

public HashFileSystem(StorageConfiguration configuration)

Parameters:

configuration -

Method Detail

createContainer

public void createContainer(java.lang.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(java.lang.String containerName)

Description copied from interface: ContentAddressableStorage

Determines if a container exists

Parameters:

containerName - name of container

Returns:

boolean type

putObject

public java.lang.String putObject(java.lang.String containerName,
                                  java.lang.String objectName,
                                  java.io.InputStream stream,
                                  DigestType digestType,
                                  java.lang.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(java.lang.String containerName,
                               java.lang.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

createReadOrderRequest

public java.lang.String createReadOrderRequest(java.lang.String containerName,
                                               java.util.List<java.lang.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(java.lang.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(java.lang.String containerName,
                         java.lang.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(java.lang.String containerName,
                                java.lang.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 java.lang.String getObjectDigest(java.lang.String containerName,
                                        java.lang.String objectName,
                                        DigestType algo,
                                        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.

algo - 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(java.lang.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(java.lang.String containerName,
                                         java.lang.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(java.lang.String containerName,
                          ObjectListingListener objectListingListener)
                   throws ContentAddressableStorageNotFoundException,
                          ContentAddressableStorageServerException,
                          java.io.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

java.io.IOException

close

public void close()