Package fr.gouv.vitam.workspace.common

Class WorkspaceFileSystem

java.lang.Object

fr.gouv.vitam.workspace.common.WorkspaceFileSystem

All Implemented Interfaces:

WorkspaceContentAddressableStorage

public class WorkspaceFileSystem
extends Object
implements WorkspaceContentAddressableStorage

Workspace Filesystem implementation

Constructor Summary

Constructors

Constructor	Description
WorkspaceFileSystem(StorageConfiguration configuration)	Default constructor Define the root of workspace with the storagePath property from configuration

Method Summary

Modifier and Type	Method	Description
File	checkWorkspaceContainerSanity(String container)
File	checkWorkspaceDirSanity(String container, String directory)
void	checkWorkspaceFileSanity(String containerName, String relativeObjectName)
void	compress(String containerName, List<String> folderNames, String zipName, String outputContainer)
String	computeObjectDigest(String containerName, String objectName, DigestType algo)	compute Object Digest using a defined algorithm
void	createContainer(String containerName)	Creates a container
void	createFolder(String containerName, String folderName)	Creates a folder (or a directory) marker depending on the service
void	deleteContainer(String containerName, boolean recursive)	Deletes everything inside a container recursively.
void	deleteFolder(String containerName, String folderName)	Deletes a folder (or a directory) marker depending on the service
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
Map<String,FileParams>	getFilesWithParamsFromFolder(String containerName, String folderName)	This method get all files in folder and return a map with the uri as a key and the value is a FileParams that contains whatever it needs.
List<URI>	getListUriDigitalObjectFromFolder(String containerName, String folderName, int limit)	Retrieves recursively the uri list of object inside a folder rootFolder/subfolder/ with batch size
jakarta.ws.rs.core.Response	getObject(String containerName, String objectName, Long chunkOffset, Long maxChunkSize)	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
int	getWorkspaceFreeSpace()
boolean	isExistingContainer(String containerName)	Determines if a container exists
boolean	isExistingFolder(String containerName, String folderName)	Determines if a folder (or a directory) exists
boolean	isExistingObject(String containerName, String objectName)	Determines if an object exists
void	moveObjects(String containerName, List<BulkMoveEntry> entries)	Bulk move objects of a container
void	purgeContainer(String containerName)	Deletes the contents of a container at its root path without deleting the container
void	purgeOldFilesInContainer(String containerName, TimeToLive timeToLive)
void	putAtomicObject(String containerName, String objectName, InputStream stream, long size)
void	putObject(String containerName, String objectName, InputStream stream)	Adds an object representing the data at location containerName/objectName
void	uncompressObject(String containerName, String folderName, String archiveMimeType, InputStream inputStreamObject)	create container: will be identified by GUID and extract objects and push it on the container

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkspaceFileSystem

public WorkspaceFileSystem(StorageConfiguration configuration)
                    throws IOException

Default constructor Define the root of workspace with the storagePath property from configuration

Parameters:

configuration - the configuration, just StoragePath property is required

Throws:

IOException - when error occurs to create root directory

Method Details

checkWorkspaceContainerSanity

public File checkWorkspaceContainerSanity(String container)
                                   throws IllegalPathException

Throws:

IllegalPathException

checkWorkspaceDirSanity

public File checkWorkspaceDirSanity(String container,
 String directory)
                             throws IllegalPathException

Throws:

IllegalPathException

checkWorkspaceFileSanity

public void checkWorkspaceFileSanity(String containerName,
 String relativeObjectName)
                              throws IllegalPathException

Throws:

IllegalPathException

createContainer

public void createContainer(String containerName)
                     throws ContentAddressableStorageAlreadyExistException,
ContentAddressableStorageServerException

Description copied from interface: WorkspaceContentAddressableStorage

Creates a container

Specified by:

createContainer in interface WorkspaceContentAddressableStorage

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

purgeContainer

public void purgeContainer(String containerName)
                    throws ContentAddressableStorageNotFoundException,
ContentAddressableStorageServerException

Description copied from interface: WorkspaceContentAddressableStorage

Deletes the contents of a container at its root path without deleting the container

Note: this function will delete everything inside a container recursively.

Specified by:

purgeContainer in interface WorkspaceContentAddressableStorage

Parameters:

containerName - name of container to purge

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageServerException - Thrown when internal server error happens

purgeOldFilesInContainer

public void purgeOldFilesInContainer(String containerName,
 TimeToLive timeToLive)
                              throws ContentAddressableStorageException

Specified by:

purgeOldFilesInContainer in interface WorkspaceContentAddressableStorage

Throws:

ContentAddressableStorageException

deleteContainer

public void deleteContainer(String containerName,
 boolean recursive)
                     throws ContentAddressableStorageNotFoundException,
ContentAddressableStorageServerException

Description copied from interface: WorkspaceContentAddressableStorage

Deletes everything inside a container recursively.

Specified by:

deleteContainer in interface WorkspaceContentAddressableStorage

Parameters:

containerName - name of the container to delete

recursive - false : deletes a container if it is empty, true : deletes everything recursively

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageServerException - Thrown when internal server error happens

isExistingContainer

public boolean isExistingContainer(String containerName)

Description copied from interface: WorkspaceContentAddressableStorage

Determines if a container exists

Specified by:

isExistingContainer in interface WorkspaceContentAddressableStorage

Parameters:

containerName - name of container

Returns:

boolean type

createFolder

public void createFolder(String containerName,
 String folderName)
                  throws ContentAddressableStorageNotFoundException,
ContentAddressableStorageAlreadyExistException,
ContentAddressableStorageServerException

Description copied from interface: WorkspaceContentAddressableStorage

Creates a folder (or a directory) marker depending on the service

Specified by:

createFolder in interface WorkspaceContentAddressableStorage

Parameters:

containerName - container to create the directory in

folderName - full path to the folder (or directory)

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageAlreadyExistException - Thrown when creating a directory while it already exists

ContentAddressableStorageServerException - Thrown when internal server error happens

deleteFolder

public void deleteFolder(String containerName,
 String folderName)
                  throws ContentAddressableStorageNotFoundException,
ContentAddressableStorageServerException

Description copied from interface: WorkspaceContentAddressableStorage

Deletes a folder (or a directory) marker depending on the service

Specified by:

deleteFolder in interface WorkspaceContentAddressableStorage

Parameters:

containerName - container to delete the folder from

folderName - full path to the folder to delete

Throws:

ContentAddressableStorageNotFoundException - Thrown when the directory cannot be located.

ContentAddressableStorageServerException - Thrown when internal server error happens

isExistingFolder

public boolean isExistingFolder(String containerName,
 String folderName)

Description copied from interface: WorkspaceContentAddressableStorage

Determines if a folder (or a directory) exists

Specified by:

isExistingFolder in interface WorkspaceContentAddressableStorage

Parameters:

containerName - container where the folder resides

folderName - full path to the folder

Returns:

boolean type

getListUriDigitalObjectFromFolder

public List<URI> getListUriDigitalObjectFromFolder(String containerName,
 String folderName,
 int limit)
                                            throws ContentAddressableStorageException

Description copied from interface: WorkspaceContentAddressableStorage

Retrieves recursively the uri list of object inside a folder rootFolder/subfolder/ with batch size

Specified by:

getListUriDigitalObjectFromFolder in interface WorkspaceContentAddressableStorage

Parameters:

containerName - not null allowed container where this exists.

folderName - not null allowed fully qualified folder name relative to the container.

limit - the maximum number of URIs to return

Returns:

a list of URI limited by the batch size

Throws:

ContentAddressableStorageException - Thrown when get action failed due some other failure

uncompressObject

public void uncompressObject(String containerName,
 String folderName,
 String archiveMimeType,
 InputStream inputStreamObject)
                      throws ContentAddressableStorageException

Description copied from interface: WorkspaceContentAddressableStorage

create container: will be identified by GUID and extract objects and push it on the container

Specified by:

uncompressObject in interface WorkspaceContentAddressableStorage

Parameters:

containerName - : the container name (will be Guid created in ingest module)

folderName - : the folder name

archiveMimeType - : the archive type (zip, tar, tar.gz, tar.bz2)

inputStreamObject - : SIP input stream

Throws:

ContentAddressableStorageException - Thrown when get action failed due some other failure

putObject

public void putObject(String containerName,
 String objectName,
 InputStream stream)
               throws ContentAddressableStorageException

Description copied from interface: WorkspaceContentAddressableStorage

Adds an object representing the data at location containerName/objectName

Specified by:

putObject in interface WorkspaceContentAddressableStorage

Parameters:

containerName - container to place the object.

objectName - fully qualified object name relative to the container.

stream - the data

Throws:

ContentAddressableStorageException - Thrown when put action failed due some other failure

putAtomicObject

public void putAtomicObject(String containerName,
 String objectName,
 InputStream stream,
 long size)
                     throws ContentAddressableStorageException

Specified by:

putAtomicObject in interface WorkspaceContentAddressableStorage

Throws:

ContentAddressableStorageException

getObject

public jakarta.ws.rs.core.Response getObject(String containerName,
 String objectName,
 Long chunkOffset,
 Long maxChunkSize)
                                      throws ContentAddressableStorageException

Description copied from interface: WorkspaceContentAddressableStorage

Retrieves an object representing the data at location containerName/objectName

WARNING : use this method only if the response has to be consumed right away.

Specified by:

getObject in interface WorkspaceContentAddressableStorage

Parameters:

containerName - container where this exists.

objectName - fully qualified name relative to the container.

Returns:

the object you intended to receive

Throws:

ContentAddressableStorageException - Thrown when get action failed due some other failure

deleteObject

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

Description copied from interface: WorkspaceContentAddressableStorage

Deletes a object representing the data at location containerName/objectName

Specified by:

deleteObject in interface WorkspaceContentAddressableStorage

Parameters:

containerName - container where this exists.

objectName - fully qualified name relative to the container.

Throws:

ContentAddressableStorageException - Thrown when get action failed due some other failure

isExistingObject

public boolean isExistingObject(String containerName,
 String objectName)

Description copied from interface: WorkspaceContentAddressableStorage

Determines if an object exists

Specified by:

isExistingObject in interface WorkspaceContentAddressableStorage

Parameters:

containerName - container where the object resides

objectName - fully qualified name relative to the container.

Returns:

boolean type

computeObjectDigest

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

Description copied from interface: WorkspaceContentAddressableStorage

compute Object Digest using a defined algorithm

Specified by:

computeObjectDigest in interface WorkspaceContentAddressableStorage

Parameters:

containerName - container where this exists.

objectName - fully qualified name relative to the container.

algo - Digest algo

Returns:

the digest object as String

Throws:

ContentAddressableStorageException - Thrown when put action failed due some other failure

getContainerInformation

public ContainerInformation getContainerInformation(String containerName)
                                             throws ContentAddressableStorageNotFoundException,
ContentAddressableStorageServerException

Description copied from interface: WorkspaceContentAddressableStorage

Get container information like capacity

Specified by:

getContainerInformation in interface WorkspaceContentAddressableStorage

Parameters:

containerName - the container name

Returns:

container information like usableSpace

Throws:

ContentAddressableStorageNotFoundException - thrown when storage is not available or container does not exist

ContentAddressableStorageServerException

getObjectInformation

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

Description copied from interface: WorkspaceContentAddressableStorage

Retrieves information about an object at location containerName/objectName

Specified by:

getObjectInformation in interface WorkspaceContentAddressableStorage

Parameters:

containerName - container where the object is.

objectName - fully qualified name relative to the container.

Returns:

the object informations as a JsonNode object

Throws:

ContentAddressableStorageException - Thrown when get action failed due some other failure

getFilesWithParamsFromFolder

public Map<String,FileParams> getFilesWithParamsFromFolder(String containerName,
 String folderName)
                                                    throws ContentAddressableStorageException

This method get all files in folder and return a map with the uri as a key and the value is a FileParams that contains whatever it needs. This method can have a huge usage of memory so extract only useful data in callable clients.

Specified by:

getFilesWithParamsFromFolder in interface WorkspaceContentAddressableStorage

Parameters:

containerName -

folderName -

Returns:

Throws:

ContentAddressableStorageException

compress

public void compress(String containerName,
 List<String> folderNames,
 String zipName,
 String outputContainer)
              throws IOException,
org.apache.commons.compress.archivers.ArchiveException

Parameters:

containerName - name of the container

folderNames - list of file or directory to archive

zipName - name of the archive file

outputContainer -

Throws:

IOException

org.apache.commons.compress.archivers.ArchiveException

getWorkspaceFreeSpace

public int getWorkspaceFreeSpace()

moveObjects

public void moveObjects(String containerName,
 List<BulkMoveEntry> entries)
                 throws ContentAddressableStorageException

Description copied from interface: WorkspaceContentAddressableStorage

Bulk move objects of a container

Specified by:

moveObjects in interface WorkspaceContentAddressableStorage

Parameters:

containerName - the container name in which data is persisted

entries - list of source/destination object name pairs

Throws:

ContentAddressableStorageException