fr.gouv.vitam.worker.common

Interface HandlerIO

All Superinterfaces:

AutoCloseable, VitamAutoCloseable

All Known Implementing Classes:

HandlerIOImpl

public interface HandlerIO
extends VitamAutoCloseable

Interface of HandlerIO for all Handlers

Method Summary

Modifier and Type	Method and Description
void	addInIOParameters(List<IOParameter> list) Add Input parameters
HandlerIO	addOuputResult(int rank, Object object, boolean asyncIO) Add one output result (no delete)
HandlerIO	addOuputResult(int rank, Object object, boolean deleteLocal, boolean asyncIO) Add one output result
void	addOutIOParameters(List<IOParameter> list) Add Output parameters
boolean	checkHandlerIO(int outputNumber, List<Class<?>> clasz) Check if input and output have the very same number of elements and for Input the associated types
void	consumeAnyEntityAndClose(javax.ws.rs.core.Response response) Consume any entity and close response
boolean	deleteLocalFile(String objectName) Helper to delete a local file To be used when not specified within the Input/Output parameters
void	enableAsync(boolean asyncIo) If true then start async manager, if false then waitEndOfTransfer and stop asyncManager
String	getContainerName()
File	getFileFromWorkspace(String objectName) Helper to load a file from Workspace (or local cache) and save it into local cache. To be used when not specified within the Input parameters
LogbookLifeCyclesClientHelper	getHelper()
List<Object>	getInput()
Object	getInput(int rank) Return one Object from input
InputStream	getInputStreamFromWorkspace(String objectName) Helper to get an InputStream (using local cache if possible) from Workspace To be used when not specified within the Input parameters
javax.ws.rs.core.Response	getInputStreamNoCachedFromWorkspace(String objectName) Helper to get an InputStream (without cache) from Workspace To be used when not specified within the Input parameters
com.fasterxml.jackson.databind.JsonNode	getJsonFromWorkspace(String jsonFilePath) Retrieve a json file as a JsonNode from the workspace.
LogbookLifeCyclesClient	getLifecyclesClient()
File	getLocalPathRoot()
File	getNewLocalFile(String name)
List<ProcessingUri>	getOutput()
ProcessingUri	getOutput(int rank) Return one ProcessingUri from output
List<URI>	getUriList(String containerName, String folderName)
String	getWorkerId()
boolean	removeFolder(String folderName) Remove a specific folder
void	reset() Reset after each Action
void	transferFileToWorkspace(String workspacePath, File sourceFile, boolean toDelete, boolean asyncIO) Helper to write a file to Workspace To be used when not specified within the Output Parameters
void	transferInputStreamToWorkspace(String workspacePath, InputStream inputStream, Path filePath, boolean asyncIO) Helper to write an InputStream to Workspace To be used when not specified within the Output Parameters
void	transferJsonToWorkspace(String collectionName, String workspacePath, com.fasterxml.jackson.databind.JsonNode jsonNode, boolean toDelete, boolean asyncIO) Helper to convert and write a file to Workspace
void	unzipInputStreamOnWorkspace(String container, String folderName, String archiveMimeType, InputStream uploadedInputStream, boolean asyncIO)
void	zipWorkspace(String output, String... inputFiles) compress list of file or directory in a specific output file

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

close

Method Detail

addInIOParameters

void addInIOParameters(List<IOParameter> list)

Add Input parameters

Parameters:

list -

Throws:

IllegalArgumentException - if an error occurs

addOutIOParameters

void addOutIOParameters(List<IOParameter> list)

Add Output parameters

Parameters:

list -

Throws:

IllegalArgumentException - if an error occurs

reset

void reset()

Reset after each Action

getInput

List<Object> getInput()

Returns:

list of input

getInput

Object getInput(int rank)

Return one Object from input

Parameters:

rank -

Returns:

the rank-th object

getOutput

List<ProcessingUri> getOutput()

Returns:

list of output

getOutput

ProcessingUri getOutput(int rank)

Return one ProcessingUri from output

Parameters:

rank -

Returns:

the rank-th ProcessingUri

addOuputResult

HandlerIO addOuputResult(int rank,
                         Object object,
                         boolean asyncIO)
                  throws ProcessingException

Add one output result (no delete)

Parameters:

rank - the position in the output

object - the result to store (WORKSPACE to workspace and must be a File, MEMORY to memory whatever it is)

asyncIO - asynchronously send to the workspace

Returns:

this

Throws:

ProcessingException

IllegalArgumentException

addOuputResult

HandlerIO addOuputResult(int rank,
                         Object object,
                         boolean deleteLocal,
                         boolean asyncIO)
                  throws ProcessingException

Add one output result

Parameters:

rank - the position in the output

object - the result to store (WORKSPACE to workspace and must be a File, MEMORY to memory whatever it is)

deleteLocal - if true, will delete the local file in case of WORKSPACE only

asyncIO - asynchronously send to the workspace

Returns:

this

Throws:

ProcessingException

IllegalArgumentException

getContainerName

String getContainerName()

Returns:

the container Name

getWorkerId

String getWorkerId()

Returns:

the worker Id

getLocalPathRoot

File getLocalPathRoot()

Returns:

the localPathRoot

getNewLocalFile

File getNewLocalFile(String name)

Parameters:

name -

Returns:

a File pointing to a local path in Tmp directory under protected Worker instance space

getUriList

List<URI> getUriList(String containerName,
                     String folderName)
              throws ProcessingException

Parameters:

containerName -

folderName -

Returns:

List a list of uri of object in SIP folder

Throws:

ProcessingException

checkHandlerIO

boolean checkHandlerIO(int outputNumber,
                       List<Class<?>> clasz)

Check if input and output have the very same number of elements and for Input the associated types

Parameters:

outputNumber - the number of outputArguments

clasz - the list of Class that should be in the InputParameters

Returns:

true if everything ok

transferFileToWorkspace

void transferFileToWorkspace(String workspacePath,
                             File sourceFile,
                             boolean toDelete,
                             boolean asyncIO)
                      throws ProcessingException

Helper to write a file to Workspace

To be used when not specified within the Output Parameters

Parameters:

workspacePath - path within the workspath, without the container (implicit)

sourceFile - the source file to write

toDelete - if True, will delete the local file

asyncIO - asynchronously send to the workspace

Throws:

ProcessingException

transferInputStreamToWorkspace

void transferInputStreamToWorkspace(String workspacePath,
                                    InputStream inputStream,
                                    Path filePath,
                                    boolean asyncIO)
                             throws ProcessingException

Helper to write an InputStream to Workspace

To be used when not specified within the Output Parameters

Parameters:

workspacePath - path within the workspath, without the container (implicit)

inputStream - the source InputStream to write

asyncIO - asynchronously send to the workspace

Throws:

ProcessingException

getFileFromWorkspace

File getFileFromWorkspace(String objectName)
                   throws IOException,
                          ContentAddressableStorageNotFoundException,
                          ContentAddressableStorageServerException

Helper to load a file from Workspace (or local cache) and save it into local cache.

To be used when not specified within the Input parameters

Parameters:

objectName -

Returns:

file if found

Throws:

IOException

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

getInputStreamFromWorkspace

InputStream getInputStreamFromWorkspace(String objectName)
                                 throws IOException,
                                        ContentAddressableStorageNotFoundException,
                                        ContentAddressableStorageServerException

Helper to get an InputStream (using local cache if possible) from Workspace

To be used when not specified within the Input parameters

Parameters:

objectName -

Returns:

the InputStream

Throws:

IOException

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

getInputStreamNoCachedFromWorkspace

javax.ws.rs.core.Response getInputStreamNoCachedFromWorkspace(String objectName)
                                                       throws ContentAddressableStorageNotFoundException,
                                                              ContentAddressableStorageServerException

Helper to get an InputStream (without cache) from Workspace

To be used when not specified within the Input parameters

Parameters:

objectName -

Returns:

the InputStream

Throws:

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

consumeAnyEntityAndClose

void consumeAnyEntityAndClose(javax.ws.rs.core.Response response)

Consume any entity and close response

Parameters:

response -

getJsonFromWorkspace

com.fasterxml.jackson.databind.JsonNode getJsonFromWorkspace(String jsonFilePath)
                                                      throws ProcessingException

Retrieve a json file as a JsonNode from the workspace.

Parameters:

jsonFilePath - path in workspace of the json File

Returns:

JsonNode of the json file

Throws:

ProcessingException - throws when error occurs

deleteLocalFile

boolean deleteLocalFile(String objectName)

Helper to delete a local file

To be used when not specified within the Input/Output parameters

Parameters:

objectName -

Returns:

True if deleted

getLifecyclesClient

LogbookLifeCyclesClient getLifecyclesClient()

Returns:

the HandlerIO LifecycleClient

getHelper

LogbookLifeCyclesClientHelper getHelper()

Returns:

the helper for bulk lifecycle for LifecyclesClient

transferJsonToWorkspace

void transferJsonToWorkspace(String collectionName,
                             String workspacePath,
                             com.fasterxml.jackson.databind.JsonNode jsonNode,
                             boolean toDelete,
                             boolean asyncIO)
                      throws ProcessingException

Helper to convert and write a file to Workspace

Parameters:

collectionName - : collection type

workspacePath - path within the workspacepath, without the container (implicit)

jsonNode - the json file to write

toDelete - if True, will delete the local file

asyncIO - asynchronously send to the workspace

Throws:

ProcessingException

unzipInputStreamOnWorkspace

void unzipInputStreamOnWorkspace(String container,
                                 String folderName,
                                 String archiveMimeType,
                                 InputStream uploadedInputStream,
                                 boolean asyncIO)
                          throws ContentAddressableStorageException

Parameters:

container -

folderName -

archiveMimeType -

uploadedInputStream -

asyncIO - asynchronously send and unzip file to/in the workspace

Throws:

ContentAddressableStorageException

zipWorkspace

void zipWorkspace(String output,
                  String... inputFiles)
           throws ContentAddressableStorageException

compress list of file or directory in a specific output file

Parameters:

output - path of the zip file

inputFiles - list of file or directory to zip

Throws:

ContentAddressableStorageException

enableAsync

void enableAsync(boolean asyncIo)
          throws WorkerspaceQueueException

If true then start async manager, if false then waitEndOfTransfer and stop asyncManager

Parameters:

asyncIo -

Throws:

WorkerspaceQueueException

removeFolder

boolean removeFolder(String folderName)
              throws ContentAddressableStorageException

Remove a specific folder

Parameters:

folderName - the folderName to delete

Returns:

true if the folder was removed, false if it does not exist

Throws:

ContentAddressableStorageException - when storage error occurs