fr.gouv.vitam.worker.core.impl

Class HandlerIOImpl

java.lang.Object

fr.gouv.vitam.worker.core.impl.HandlerIOImpl

All Implemented Interfaces:

VitamAutoCloseable, HandlerIO, AutoCloseable

public class HandlerIOImpl
extends Object
implements HandlerIO, VitamAutoCloseable

Handler input and output parameter

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOT_CONFORM_PARAM Not Conform Param
static String	NOT_ENOUGH_PARAM Not Enough Param

Constructor Summary

Constructors

Constructor and Description
HandlerIOImpl(String containerName, String workerId) Constructor with local root path
HandlerIOImpl(WorkspaceClient workspaceClient, String containerName, String workerId) Constructor with workspaceClient, local root path he is used for test purpose

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	close()
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 async) 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()
void	partialClose() Close the HandlerIO, including temporary files and directories at the end of the step Workflow execution, but do not close the WorkspaceClient
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 objectName, 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 outputFile, String... inputFiles) compress list of file or directory in a specific output file

Methods inherited from class java.lang.Object

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

Field Detail

NOT_ENOUGH_PARAM

public static final String NOT_ENOUGH_PARAM

Not Enough Param

See Also:

Constant Field Values

NOT_CONFORM_PARAM

public static final String NOT_CONFORM_PARAM

Not Conform Param

See Also:

Constant Field Values

Constructor Detail

HandlerIOImpl

public HandlerIOImpl(String containerName,
                     String workerId)

Constructor with local root path

Parameters:

containerName - the container name

workerId - the worker id

HandlerIOImpl

public HandlerIOImpl(WorkspaceClient workspaceClient,
                     String containerName,
                     String workerId)

Constructor with workspaceClient, local root path he is used for test purpose

Parameters:

workspaceClient -

containerName - the container name

workerId - the worker id

Method Detail

getLifecyclesClient

public LogbookLifeCyclesClient getLifecyclesClient()

Specified by:

getLifecyclesClient in interface HandlerIO

Returns:

the HandlerIO LifecycleClient

getHelper

public LogbookLifeCyclesClientHelper getHelper()

Specified by:

getHelper in interface HandlerIO

Returns:

the helper for bulk lifecycle for LifecyclesClient

addInIOParameters

public void addInIOParameters(List<IOParameter> list)

Description copied from interface: HandlerIO

Add Input parameters

Specified by:

addInIOParameters in interface HandlerIO

addOutIOParameters

public void addOutIOParameters(List<IOParameter> list)

Description copied from interface: HandlerIO

Add Output parameters

Specified by:

addOutIOParameters in interface HandlerIO

reset

public void reset()

Description copied from interface: HandlerIO

Reset after each Action

Specified by:

reset in interface HandlerIO

close

public void close()

Specified by:

close in interface VitamAutoCloseable

Specified by:

close in interface AutoCloseable

partialClose

public void partialClose()

Close the HandlerIO, including temporary files and directories at the end of the step Workflow execution, but do not close the WorkspaceClient

getInput

public List<Object> getInput()

Specified by:

getInput in interface HandlerIO

Returns:

list of input

getInput

public Object getInput(int rank)

Description copied from interface: HandlerIO

Return one Object from input

Specified by:

getInput in interface HandlerIO

Returns:

the rank-th object

getOutput

public List<ProcessingUri> getOutput()

Specified by:

getOutput in interface HandlerIO

Returns:

list of output

getOutput

public ProcessingUri getOutput(int rank)

Description copied from interface: HandlerIO

Return one ProcessingUri from output

Specified by:

getOutput in interface HandlerIO

Returns:

the rank-th ProcessingUri

addOuputResult

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

Description copied from interface: HandlerIO

Add one output result (no delete)

Specified by:

addOuputResult in interface HandlerIO

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

addOuputResult

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

Description copied from interface: HandlerIO

Add one output result

Specified by:

addOuputResult in interface HandlerIO

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

getContainerName

public String getContainerName()

Specified by:

getContainerName in interface HandlerIO

Returns:

the container Name

getWorkerId

public String getWorkerId()

Specified by:

getWorkerId in interface HandlerIO

Returns:

the worker Id

getLocalPathRoot

public File getLocalPathRoot()

Specified by:

getLocalPathRoot in interface HandlerIO

Returns:

the localPathRoot

getNewLocalFile

public File getNewLocalFile(String name)

Specified by:

getNewLocalFile in interface HandlerIO

Returns:

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

checkHandlerIO

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

Description copied from interface: HandlerIO

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

Specified by:

checkHandlerIO in interface HandlerIO

Parameters:

outputNumber - the number of outputArguments

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

Returns:

true if everything ok

transferFileToWorkspace

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

Description copied from interface: HandlerIO

Helper to write a file to Workspace

To be used when not specified within the Output Parameters

Specified by:

transferFileToWorkspace in interface HandlerIO

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

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

Description copied from interface: HandlerIO

Helper to write an InputStream to Workspace

To be used when not specified within the Output Parameters

Specified by:

transferInputStreamToWorkspace in interface HandlerIO

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

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

Description copied from interface: HandlerIO

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

Specified by:

getFileFromWorkspace in interface HandlerIO

Returns:

file if found

Throws:

IOException

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

getInputStreamFromWorkspace

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

Description copied from interface: HandlerIO

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

To be used when not specified within the Input parameters

Specified by:

getInputStreamFromWorkspace in interface HandlerIO

Returns:

the InputStream

Throws:

IOException

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

getInputStreamNoCachedFromWorkspace

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

Description copied from interface: HandlerIO

Helper to get an InputStream (without cache) from Workspace

To be used when not specified within the Input parameters

Specified by:

getInputStreamNoCachedFromWorkspace in interface HandlerIO

Returns:

the InputStream

Throws:

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

consumeAnyEntityAndClose

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

Description copied from interface: HandlerIO

Consume any entity and close response

Specified by:

consumeAnyEntityAndClose in interface HandlerIO

getJsonFromWorkspace

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

Description copied from interface: HandlerIO

Retrieve a json file as a JsonNode from the workspace.

Specified by:

getJsonFromWorkspace in interface HandlerIO

Parameters:

jsonFilePath - path in workspace of the json File

Returns:

JsonNode of the json file

Throws:

ProcessingException - throws when error occurs

deleteLocalFile

public boolean deleteLocalFile(String objectName)

Description copied from interface: HandlerIO

Helper to delete a local file

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

Specified by:

deleteLocalFile in interface HandlerIO

Returns:

True if deleted

getUriList

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

Specified by:

getUriList in interface HandlerIO

Returns:

List a list of uri of object in SIP folder

Throws:

ProcessingException

transferJsonToWorkspace

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

Description copied from interface: HandlerIO

Helper to convert and write a file to Workspace

Specified by:

transferJsonToWorkspace in interface HandlerIO

Parameters:

collectionName - : collection type

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

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

Specified by:

unzipInputStreamOnWorkspace in interface HandlerIO

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

Throws:

ContentAddressableStorageException

zipWorkspace

public void zipWorkspace(String outputFile,
                         String... inputFiles)
                  throws ContentAddressableStorageException

Description copied from interface: HandlerIO

compress list of file or directory in a specific output file

Specified by:

zipWorkspace in interface HandlerIO

Parameters:

outputFile - path of the zip file

inputFiles - list of file or directory to zip

Throws:

ContentAddressableStorageException

enableAsync

public void enableAsync(boolean async)
                 throws WorkerspaceQueueException

Description copied from interface: HandlerIO

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

Specified by:

enableAsync in interface HandlerIO

Throws:

WorkerspaceQueueException

removeFolder

public boolean removeFolder(String folderName)
                     throws ContentAddressableStorageException

Description copied from interface: HandlerIO

Remove a specific folder

Specified by:

removeFolder in interface HandlerIO

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