Package 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	Description
void	addInIOParameters(List<IOParameter> list)	Add Input parameters
void	addOutIOParameters(List<IOParameter> list)	Add Output parameters
HandlerIO	addOutputResult(int rank, Object object)
HandlerIO	addOutputResult(int rank, Object object, boolean asyncIO)	Add one output result (no delete)
HandlerIO	addOutputResult(int rank, Object object, boolean deleteLocal, boolean asyncIO)	Add one output result
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(jakarta.ws.rs.core.Response response)	Consume any entity and close response
void	enableAsync(boolean asyncIo)	If true then start async manager, if false then waitEndOfTransfer and stop asyncManager
AdminManagementClient	getAdminManagementClient()
AdminManagementClientFactory	getAdminManagementClientFactory()
BatchReportClient	getBatchReportClient()
BatchReportClientFactory	getBatchReportClientFactory()
CollectInternalClient	getCollectInternalClient()
CollectInternalClientFactory	getCollectInternalClientFactory()
String	getContainerName()
File	getFile(int rank)
File	getFileFromWorkspace(WorkFlowExecutionContext executionContext, 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
File	getFileFromWorkspace(String objectName)	Deprecated. use getFileFromWorkspace(WorkFlowExecutionContext, String) instead so that the workspace is explicitly chosen
Map<String,Long>	getFilesWithParamsFromWorkspace(WorkFlowExecutionContext executionContext, String containerName, String folderName)	get Map of File With Params From folder in Workspace
Map<String,Long>	getFilesWithParamsFromWorkspace(String containerName, String folderName)	get Map of File With Params From folder in Workspace
LogbookLifeCyclesClientHelper	getHelper()
List<Object>	getInput()
Object	getInput(int rank)	Return one Object from input
<T> T	getInput(int rank, Class<T> type)	Return one Object casted to type from input
InputStream	getInputStreamFromWorkspace(WorkFlowExecutionContext executionContext, String objectName)	Helper to get an InputStream (using local cache if possible) from Workspace To be used when not specified within the Input parameters
InputStream	getInputStreamFromWorkspace(String objectName)	Deprecated. use getInputStreamFromWorkspace(WorkFlowExecutionContext, String) instead so that the workspace is explicitly chosen
com.fasterxml.jackson.databind.JsonNode	getJsonFromWorkspace(WorkFlowExecutionContext executionContext, String jsonFilePath)	Retrieve a json file as a JsonNode from the workspace.
com.fasterxml.jackson.databind.JsonNode	getJsonFromWorkspace(String jsonFilePath)	Deprecated. use getJsonFromWorkspace(WorkFlowExecutionContext, String) instead so that the workspace is explicitly chosen
LogbookLifeCyclesClient	getLifeCyclesClient()
LogbookLifeCyclesClientFactory	getLifeCyclesClientFactory()
LogbookOperationsClient	getLogbookOperationsClient()
LogbookOperationsClientFactory	getLogbookOperationsClientFactory()
MetaDataClient	getMetaDataClient()
MetaDataClientFactory	getMetaDataClientFactory()
File	getNewLocalFile(WorkFlowExecutionContext executionContext, String name)
File	getNewLocalFile(String name)	Deprecated. Use getNewLocalFile(WorkFlowExecutionContext, String) instead so that the workspace is explicitly chosen
List<ProcessingUri>	getOutput()
ProcessingUri	getOutput(int rank)	Return one ProcessingUri from output
StorageClient	getStorageClient()
StorageClientFactory	getStorageClientFactory()
List<URI>	getUriList(String containerName, String folderName)
String	getWorkerId()
WorkFlowExecutionContext	getWorkFlowExecutionContext()
WorkspaceClient	getWorkspaceClient()	Deprecated. Use getWorkspaceClient(WorkFlowExecutionContext) instead so that the workspace is explicitly chosen
WorkspaceClient	getWorkspaceClient(WorkFlowExecutionContext executionContext)
WorkspaceClientFactory	getWorkspaceClientFactory()
WorkspaceClient	getWorkspaceCollectClient()
WorkspaceCollectClientFactory	getWorkspaceCollectClientFactory()
boolean	isExistingFileInWorkspace(String workspacePath)
boolean	removeFolder(String folderName)	Remove a specific folder
void	reset()	Reset after each Action
void	setCurrentObjectId(String currentObjectId)
void	transferAtomicFileToWorkspace(String workspacePath, File sourceFile)
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(WorkFlowExecutionContext executionContext, String collectionName, String workspacePath, com.fasterxml.jackson.databind.JsonNode jsonNode, boolean toDelete, boolean asyncIO)	Helper to convert and write a file to Workspace
void	transferJsonToWorkspace(String collectionName, String workspacePath, com.fasterxml.jackson.databind.JsonNode jsonNode, boolean toDelete, boolean asyncIO)	Deprecated. use transferJsonToWorkspace(WorkFlowExecutionContext, String, String, JsonNode, boolean, boolean) instead so that the workspace is explicitly chosen
void	unzipInputStreamOnWorkspace(String container, String folderName, String archiveMimeType, InputStream uploadedInputStream, boolean asyncIO)

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

close

Method Details

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

getInput

<T> T getInput(int rank,
 Class<T> type)

Return one Object casted to type from input

Parameters:

rank -

Returns:

the rank-th object

getFile

File getFile(int rank)

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

addOutputResult

HandlerIO addOutputResult(int rank,
 Object object)
                   throws ProcessingException

Throws:

ProcessingException

addOutputResult

HandlerIO addOutputResult(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

addOutputResult

HandlerIO addOutputResult(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

getNewLocalFile

File getNewLocalFile(WorkFlowExecutionContext executionContext,
 String name)

Parameters:

executionContext - the execution context

name -

Returns:

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

getNewLocalFile

File getNewLocalFile(String name)

Deprecated.

Use getNewLocalFile(WorkFlowExecutionContext, String) instead so that the workspace is explicitly chosen

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

isExistingFileInWorkspace

boolean isExistingFileInWorkspace(String workspacePath)
                           throws ProcessingException

Throws:

ProcessingException

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

transferAtomicFileToWorkspace

void transferAtomicFileToWorkspace(String workspacePath,
 File sourceFile)
                            throws ProcessingException

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(WorkFlowExecutionContext executionContext,
 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:

executionContext -

objectName -

Returns:

file if found

Throws:

IOException

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

getFileFromWorkspace

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

Deprecated.

use getFileFromWorkspace(WorkFlowExecutionContext, String) instead so that the workspace is explicitly chosen

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

getFilesWithParamsFromWorkspace

Map<String,Long> getFilesWithParamsFromWorkspace(WorkFlowExecutionContext executionContext,
 String containerName,
 String folderName)
                                          throws ProcessingException

get Map of File With Params From folder in Workspace

Parameters:

executionContext -

containerName -

folderName -

Returns:

Throws:

ProcessingException

getFilesWithParamsFromWorkspace

Map<String,Long> getFilesWithParamsFromWorkspace(String containerName,
 String folderName)
                                          throws ProcessingException

get Map of File With Params From folder in Workspace

Parameters:

containerName -

folderName -

Returns:

Throws:

ProcessingException

getInputStreamFromWorkspace

InputStream getInputStreamFromWorkspace(WorkFlowExecutionContext executionContext,
 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:

executionContext -

objectName -

Returns:

the InputStream

Throws:

IOException

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

getInputStreamFromWorkspace

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

Deprecated.

use getInputStreamFromWorkspace(WorkFlowExecutionContext, String) instead so that the workspace is explicitly chosen

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

consumeAnyEntityAndClose

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

Consume any entity and close response

Parameters:

response -

getJsonFromWorkspace

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

Retrieve a json file as a JsonNode from the workspace.

Parameters:

executionContext - the execution context

jsonFilePath - path in workspace of the json File

Returns:

JsonNode of the json file

Throws:

ProcessingException - throws when error occurs

getJsonFromWorkspace

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

Deprecated.

use getJsonFromWorkspace(WorkFlowExecutionContext, String) instead so that the workspace is explicitly chosen

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

getHelper

LogbookLifeCyclesClientHelper getHelper()

Returns:

the helper for bulk lifecycle for LifecyclesClient

transferJsonToWorkspace

void transferJsonToWorkspace(WorkFlowExecutionContext executionContext,
 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:

executionContext - the execution context

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

transferJsonToWorkspace

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

Deprecated.

use transferJsonToWorkspace(WorkFlowExecutionContext, String, String, JsonNode, boolean, boolean) instead so that the workspace is explicitly chosen

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

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

setCurrentObjectId

void setCurrentObjectId(String currentObjectId)

getLifeCyclesClientFactory

LogbookLifeCyclesClientFactory getLifeCyclesClientFactory()

Returns:

the LogbookLifeCyclesClientFactory for the current execution context

getLifeCyclesClient

LogbookLifeCyclesClient getLifeCyclesClient()

Returns:

the HandlerIO LifecycleClient

getWorkspaceClientFactory

WorkspaceClientFactory getWorkspaceClientFactory()

Returns:

the WorkspaceClientFactory for the current execution context

getWorkspaceClient

WorkspaceClient getWorkspaceClient()

Deprecated.

Use getWorkspaceClient(WorkFlowExecutionContext) instead so that the workspace is explicitly chosen

Returns:

the WorkspaceClient for the current execution context

getWorkspaceClient

WorkspaceClient getWorkspaceClient(WorkFlowExecutionContext executionContext)

Parameters:

executionContext - the execution context

Returns:

the WorkspaceClient for a given execution context

getWorkspaceCollectClientFactory

WorkspaceCollectClientFactory getWorkspaceCollectClientFactory()

Returns:

the WorkspaceCollectClientFactory for the current execution context

getWorkspaceCollectClient

WorkspaceClient getWorkspaceCollectClient()

Returns:

the WorkspaceCollectClient for the current execution context

getMetaDataClientFactory

MetaDataClientFactory getMetaDataClientFactory()

Returns:

the metadata client for the current execution context

getMetaDataClient

MetaDataClient getMetaDataClient()

Returns:

the metadata client for the current execution context

getAdminManagementClientFactory

AdminManagementClientFactory getAdminManagementClientFactory()

Returns:

the metadata client for the current execution context

getAdminManagementClient

AdminManagementClient getAdminManagementClient()

Returns:

the metadata client for the current execution context

getBatchReportClientFactory

BatchReportClientFactory getBatchReportClientFactory()

Returns:

the batch report client factory for the current execution context

getBatchReportClient

BatchReportClient getBatchReportClient()

Returns:

the batch report client for the current execution context

getLogbookOperationsClientFactory

LogbookOperationsClientFactory getLogbookOperationsClientFactory()

Returns:

the logbook operations client factory for the current execution context

getLogbookOperationsClient

LogbookOperationsClient getLogbookOperationsClient()

Returns:

the logbook operations client for the current execution context

getStorageClientFactory

StorageClientFactory getStorageClientFactory()

Returns:

the storage client factory for the current execution context

getStorageClient

StorageClient getStorageClient()

Returns:

the storage client for the current execution context

getCollectInternalClientFactory

CollectInternalClientFactory getCollectInternalClientFactory()

Returns:

the collect internal client factory for the current execution context

getCollectInternalClient

CollectInternalClient getCollectInternalClient()

Returns:

the collect internal client for the current execution context

getWorkFlowExecutionContext

WorkFlowExecutionContext getWorkFlowExecutionContext()