Package fr.gouv.vitam.processing.data.core.management

Interface ProcessDataManagement

All Known Implementing Classes:

WorkspaceProcessDataManagement

public interface ProcessDataManagement

Interface for process datas management service (persist and restore workflow)

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DISTRIBUTOR_INDEX
static java.lang.String	PROCESS_CONTAINER	Container name

Method Summary

Modifier and Type	Method	Description
boolean	createFolder(java.lang.String folderName)	Create a folder with the name {folderName} if does not exist on the process container
boolean	createProcessContainer()	Create the process container (initialisation) if does not exist
java.util.Optional<DistributorIndex>	getDistributorIndex(java.lang.String fileName)
ProcessWorkflow	getProcessWorkflow(java.lang.String folderName, java.lang.String asyncId)	Retrieve a workflow instance on process container
java.util.Map<java.lang.String,ProcessWorkflow>	getProcessWorkflowFor(java.lang.Integer tenantId, java.lang.String folderName)	Get process workflow map for tenantId and folderName (server id from serverIdentity)
boolean	isFolderExist(java.lang.String folderName)	Check if the folder with name {folderName} exists on process container
boolean	isProcessContainerExist()	Check if the process container exists
void	persistDistributorIndex(java.lang.String fileName, DistributorIndex distributorIndex)
void	persistProcessWorkflow(java.lang.String folderName, ProcessWorkflow processWorkflow)	Put process workflow instance in workspace
boolean	removeFolder(java.lang.String folderName)	Delete folder with name {folderName} if exists on process container
boolean	removeOperationContainer(ProcessWorkflow processWorkflow, WorkspaceClientFactory workspaceClientFactory)
void	removeProcessWorkflow(java.lang.String folderName, java.lang.String asyncId)	Delete process workflow from the workspace

Field Detail

PROCESS_CONTAINER

static final java.lang.String PROCESS_CONTAINER

Container name

See Also:

Constant Field Values

DISTRIBUTOR_INDEX

static final java.lang.String DISTRIBUTOR_INDEX

See Also:

Constant Field Values

Method Detail

createProcessContainer

boolean createProcessContainer()
                        throws ProcessingStorageWorkspaceException

Create the process container (initialisation) if does not exist

Returns:

true if the container was created, false if it already exists

Throws:

ProcessingStorageWorkspaceException - when storage error occurs

isProcessContainerExist

boolean isProcessContainerExist()
                         throws ProcessingStorageWorkspaceException

Check if the process container exists

Returns:

true if the container exists, false otherwise

Throws:

ProcessingStorageWorkspaceException - when storage error occurs

createFolder

boolean createFolder(java.lang.String folderName)
              throws ProcessingStorageWorkspaceException

Create a folder with the name {folderName} if does not exist on the process container

Parameters:

folderName - the name of the folder to create

Returns:

true if the folder was created, false if it already exists

Throws:

ProcessingStorageWorkspaceException - when storage error occurs

isFolderExist

boolean isFolderExist(java.lang.String folderName)
               throws ProcessingStorageWorkspaceException

Check if the folder with name {folderName} exists on process container

Parameters:

folderName - the folder name to check

Returns:

true if folder exists on process container, false otherwise

Throws:

ProcessingStorageWorkspaceException - when storage error occurs

removeFolder

boolean removeFolder(java.lang.String folderName)
              throws ProcessingStorageWorkspaceException

Delete folder with name {folderName} if exists on process container

Parameters:

folderName - the folderName to delete

Returns:

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

Throws:

ProcessingStorageWorkspaceException - when storage error occurs

persistProcessWorkflow

void persistProcessWorkflow(java.lang.String folderName,
                            ProcessWorkflow processWorkflow)
                     throws ProcessingStorageWorkspaceException,
                            InvalidParseOperationException

Put process workflow instance in workspace

Parameters:

folderName - the folder to put workflow instance on process container

processWorkflow - the instance to save

Throws:

ProcessingStorageWorkspaceException - when storage error occurs

InvalidParseOperationException - when serializing object to json fail

persistDistributorIndex

void persistDistributorIndex(java.lang.String fileName,
                             DistributorIndex distributorIndex)
                      throws ProcessingStorageWorkspaceException,
                             InvalidParseOperationException

Throws:

ProcessingStorageWorkspaceException

InvalidParseOperationException

getDistributorIndex

java.util.Optional<DistributorIndex> getDistributorIndex(java.lang.String fileName)
                                                  throws ProcessingStorageWorkspaceException,
                                                         InvalidParseOperationException

Throws:

ProcessingStorageWorkspaceException

InvalidParseOperationException

getProcessWorkflow

ProcessWorkflow getProcessWorkflow(java.lang.String folderName,
                                   java.lang.String asyncId)
                            throws ProcessingStorageWorkspaceException,
                                   InvalidParseOperationException

Retrieve a workflow instance on process container

Parameters:

folderName - the folder on process container to get workflow instance

asyncId - the request id (asynchronous id)

Returns:

the workflow instance

Throws:

ProcessingStorageWorkspaceException - when storage error occurs

InvalidParseOperationException - when deserializing object to json fail

removeProcessWorkflow

void removeProcessWorkflow(java.lang.String folderName,
                           java.lang.String asyncId)
                    throws ProcessingStorageWorkspaceException

Delete process workflow from the workspace

Parameters:

folderName - the folder on process container to remove workflow instance

asyncId - the request id (asynchronous id)

Throws:

ProcessingStorageWorkspaceException - when storage error occurs

getProcessWorkflowFor

java.util.Map<java.lang.String,ProcessWorkflow> getProcessWorkflowFor(java.lang.Integer tenantId,
                                                                            java.lang.String folderName)
                                                                     throws ProcessingStorageWorkspaceException

Get process workflow map for tenantId and folderName (server id from serverIdentity)

Parameters:

tenantId - the tenant ID

folderName - the folder name (server id from serverIdentity)

Returns:

map of tenantID process for a server id

Throws:

ProcessingStorageWorkspaceException - thrown if an error ocurred when loading process file

removeOperationContainer

boolean removeOperationContainer(ProcessWorkflow processWorkflow,
                                 WorkspaceClientFactory workspaceClientFactory)