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, 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 and Description
HashFileSystem(StorageConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
void	close()
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
String	getObjectDigestFromMD(String containerName, String objectName, DigestType algo)
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
String	readExtendedMetadata(Path p, String name)

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

checkObject

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(String containerName)
                     throws ContentAddressableStorageAlreadyExistException,
                            ContentAddressableStorageServerException

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

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

countObjects

public long countObjects(String containerName)
                  throws ContentAddressableStorageNotFoundException,
                         ContentAddressableStorageServerException

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.

ContentAddressableStorageServerException - Thrown when internal server error happens

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

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

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

Overrides:

computeObjectDigest in class ContentAddressableStorageAbstract

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

getObjectDigestFromMD

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

Parameters:

containerName - the container name

objectName - the object name

algo - the algo type

Returns:

the digest

Throws:

ContentAddressableStorageException - if workspace could not be reached

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

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageServerException - Thrown when internal server error happens

getObjectInformation

public com.fasterxml.jackson.databind.JsonNode getObjectInformation(String containerName,
                                                                    String objectName)
                                                             throws ContentAddressableStorageNotFoundException,
                                                                    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

getObjectMetadatas

public 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

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,
                                                                      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()

readExtendedMetadata

public String readExtendedMetadata(Path p,
                                   String name)
                            throws IOException

Throws:

IOException