Package fr.gouv.vitam.processing.management.api

Interface ProcessManagement

All Superinterfaces:

java.lang.AutoCloseable, ProcessLifeCycle, VitamAutoCloseable

All Known Implementing Classes:

ProcessManagementImpl

public interface ProcessManagement
extends ProcessLifeCycle, VitamAutoCloseable

ProcessManagement interface This service will be invoked by Ingest Module

Method Summary

Modifier and Type	Method	Description
ItemStatus	cancel(java.lang.String operationId, java.lang.Integer tenantId)	Handle a cancel action for the corresponding process workflow
java.util.List<ProcessWorkflow>	findAllProcessWorkflow(java.lang.Integer tenantId)	Retrieve All the workflow process for monitoring purpose The final business scope of this feature is likely to be redefined, to match the future need
ProcessWorkflow	findOneProcessWorkflow(java.lang.String operationId, java.lang.Integer tenantId)	find the workflow process according to the operation_id and the tenant_id
void	forcePause(ProcessPause pause)	Add a forced pause on the tenant and/or the type of process
ServerConfiguration	getConfiguration()	server configuration
java.util.List<ProcessDetail>	getFilteredProcess(ProcessQuery query, java.lang.Integer tenantId)	Get filtered process workflow
java.util.Map<java.lang.String,IEventsState>	getProcessMonitorList()	sProcessMonitorList
java.util.Map<java.lang.String,WorkFlow>	getWorkflowDefinitions()	Retrieve the loaded workflow definitions
java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,ProcessWorkflow>>	getWorkFlowList()
ProcessWorkflow	init(WorkerParameters workerParameters, java.lang.String workflowId)	Init a new process workflow
ItemStatus	next(WorkerParameters workerParameters, java.lang.Integer tenantId)	Handle a next action for the corresponding process workflow
ItemStatus	pause(java.lang.String operationId, java.lang.Integer tenantId)	Handle a pause action for the corresponding process workflow
void	reloadWorkflowDefinitions()	Reload workflow definitions
void	removeForcePause(ProcessPause pause)	Removed the forced pause on the tenant and/or the type of process
ItemStatus	replay(WorkerParameters workerParameters, java.lang.Integer tenantId)	Handle a replay action for the corresponding process workflow
ItemStatus	resume(WorkerParameters workerParameters, java.lang.Integer tenantId, boolean useForcedPause)	Handle a resume action for the corresponding process workflow

Methods inherited from interface fr.gouv.vitam.common.lifecycle.ProcessLifeCycle

startProcess, stopProcess

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

close

Method Detail

init

ProcessWorkflow init(WorkerParameters workerParameters,
                     java.lang.String workflowId)
              throws ProcessingException

Init a new process workflow

Parameters:

workerParameters - parameters to be passed to ProcessEngine

workflowId - the workflow identifier

Returns:

ProcessWorkflow

Throws:

ProcessingException - if the process could not be initialized

next

ItemStatus next(WorkerParameters workerParameters,
                java.lang.Integer tenantId)
         throws ProcessingException,
                StateNotAllowedException

Handle a next action for the corresponding process workflow

Parameters:

workerParameters - parameters to be passed to ProcessEngine

tenantId - the tenant identifier

Returns:

the status

Throws:

ProcessingException - if next could not be applied

StateNotAllowedException - if the process state is incorrect

replay

ItemStatus replay(WorkerParameters workerParameters,
                  java.lang.Integer tenantId)
           throws ProcessingException,
                  StateNotAllowedException

Handle a replay action for the corresponding process workflow

Parameters:

workerParameters - parameters to be passed to ProcessEngine

tenantId - the tenant identifier

Returns:

the status

Throws:

ProcessingException - if replay could not be applied

StateNotAllowedException - if the process state is incorrect

resume

ItemStatus resume(WorkerParameters workerParameters,
                  java.lang.Integer tenantId,
                  boolean useForcedPause)
           throws ProcessingException,
                  StateNotAllowedException

Handle a resume action for the corresponding process workflow

Parameters:

workerParameters - parameters to be passed to ProcessEngine

tenantId - the tenant identifier

useForcedPause - if the forced pause must be applied

Returns:

the status

Throws:

ProcessingException - if resume could not be applied

StateNotAllowedException - if the process state is incorrect

pause

ItemStatus pause(java.lang.String operationId,
                 java.lang.Integer tenantId)
          throws ProcessingException,
                 StateNotAllowedException

Handle a pause action for the corresponding process workflow

Parameters:

operationId - the operation identifier

tenantId - the tenant identifier

Returns:

the status

Throws:

ProcessingException - if pause could not be applied

StateNotAllowedException - if the process state is incorrect

cancel

ItemStatus cancel(java.lang.String operationId,
                  java.lang.Integer tenantId)
           throws ProcessingException,
                  StateNotAllowedException

Handle a cancel action for the corresponding process workflow

Parameters:

operationId - the operation identifier

tenantId - the tenant identifier

Returns:

the status

Throws:

ProcessingException - if cancel could not be applied

StateNotAllowedException - if the process state is incorrect

findAllProcessWorkflow

java.util.List<ProcessWorkflow> findAllProcessWorkflow(java.lang.Integer tenantId)

Retrieve All the workflow process for monitoring purpose The final business scope of this feature is likely to be redefined, to match the future need

Parameters:

tenantId - the tenant identifier

Returns:

All the workflow process details

findOneProcessWorkflow

ProcessWorkflow findOneProcessWorkflow(java.lang.String operationId,
                                       java.lang.Integer tenantId)

find the workflow process according to the operation_id and the tenant_id

Parameters:

operationId - the operation identifier

tenantId - the tenant identifier

Returns:

the workFlow process

getWorkflowDefinitions

java.util.Map<java.lang.String,WorkFlow> getWorkflowDefinitions()

Retrieve the loaded workflow definitions

Returns:

the workflow definitions by ID

reloadWorkflowDefinitions

void reloadWorkflowDefinitions()

Reload workflow definitions

getFilteredProcess

java.util.List<ProcessDetail> getFilteredProcess(ProcessQuery query,
                                                 java.lang.Integer tenantId)

Get filtered process workflow

Parameters:

query - to filter

tenantId - the tenandId

Returns:

filtered process list

getWorkFlowList

java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,ProcessWorkflow>> getWorkFlowList()

Returns:

WorkFlow List

getProcessMonitorList

java.util.Map<java.lang.String,IEventsState> getProcessMonitorList()

sProcessMonitorList

Returns:

getConfiguration

ServerConfiguration getConfiguration()

server configuration

Returns:

removeForcePause

void removeForcePause(ProcessPause pause)
               throws ProcessingException

Removed the forced pause on the tenant and/or the type of process

Parameters:

pause -

Throws:

ProcessingException

forcePause

void forcePause(ProcessPause pause)
         throws ProcessingException

Add a forced pause on the tenant and/or the type of process

Parameters:

pause -

Throws:

ProcessingException