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

Class HashFileSystemHelper

java.lang.Object

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

public class HashFileSystemHelper
extends Object

Helper for the FileSystem offer

Constructor Summary

Constructors

Constructor and Description
HashFileSystemHelper(String rootPath) Constructor

Method Summary

Modifier and Type	Method and Description
void	createContainer(String container) Create a directory recursively in the sub tree
void	createDirectories(Path path) Create recursively the directories
List<String>	getListContainers()
Path	getPathContainer(String containerName) Get the path of a container
Path	getPathObject(String container, String objectId) Get the path of an object based on its container and the objectId
boolean	isContainer(String subpath)
List<String>	splitObjectId(String objectId) Split objectId without extension
FileVisitResult	walkFileTreeOrdered(Path directory, FileVisitor<Path> fv) A walkFile where we goes in the child in the lexicographic order

Methods inherited from class java.lang.Object

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

Constructor Detail

HashFileSystemHelper

public HashFileSystemHelper(String rootPath)

Constructor

Parameters:

rootPath - : the base path of the storage . Will be appended to all requests

Throws:

IllegalArgumentException - : if rootPath is equals to / (to prevent error)

Method Detail

getPathContainer

public Path getPathContainer(String containerName)

Get the path of a container

Parameters:

containerName -

Returns:

the Path Object representing the container directory

getListContainers

public List<String> getListContainers()

Returns:

a list of current containers

splitObjectId

public List<String> splitObjectId(String objectId)
                           throws ContentAddressableStorageServerException

Split objectId without extension

Parameters:

objectId -

Returns:

a list of tokens that will represent the directory structure

Throws:

ContentAddressableStorageServerException

getPathObject

public Path getPathObject(String container,
                          String objectId)
                   throws ContentAddressableStorageNotFoundException,
                          ContentAddressableStorageServerException

Get the path of an object based on its container and the objectId

Parameters:

container -

objectId -

Returns:

Path of the object

Throws:

ContentAddressableStorageNotFoundException - : container not found

ContentAddressableStorageServerException - : The objectId contains Separator character

createContainer

public void createContainer(String container)
                     throws ContentAddressableStorageAlreadyExistException,
                            ContentAddressableStorageServerException

Create a directory recursively in the sub tree

Parameters:

container - : relative path that will be appended at the end of the rootPath

Throws:

ContentAddressableStorageAlreadyExistException - : if the directory already exists

ContentAddressableStorageServerException - : on I/O Errors

isContainer

public boolean isContainer(String subpath)

Parameters:

subpath - : relative path that will be appended at the end of the rootPath

Returns:

true if the subpath is a directory

createDirectories

public void createDirectories(Path path)
                       throws ContentAddressableStorageServerException,
                              ContentAddressableStorageAlreadyExistException

Create recursively the directories

Parameters:

path -

Throws:

ContentAddressableStorageServerException

ContentAddressableStorageAlreadyExistException

walkFileTreeOrdered

public FileVisitResult walkFileTreeOrdered(Path directory,
                                           FileVisitor<Path> fv)
                                    throws IOException

A walkFile where we goes in the child in the lexicographic order

Parameters:

directory - : root of the tree that will be visited

fv - : FileVisitor which will be used for the action

Returns:

FileVisitResult (only useful for the recursive call and not for the external call)

Throws:

IOException