Package fr.gouv.vitam.processing.engine.api

Interface ProcessEngine

All Known Implementing Classes:

ProcessEngineImpl

public interface ProcessEngine

Process Engine Interface Provides access to all the services and to manage a workflow of operations.

Method Summary

Modifier and Type	Method	Description
boolean	cancel(java.lang.String operationId)	Cancel the execution of the current step Send message to the distributor to cancel the execution of the current step
boolean	pause(java.lang.String operationId)	Pause the execution of the current step Send message to the distributor to cancel the execution of the current step
void	setCallback(IEventsProcessEngine callback)	Set the state machine where the ProcessEngine return response on complete or on error
void	start(ProcessStep step, WorkerParameters workerParameters, PauseRecover pauseRecover)	Start the execution of the given step

Method Detail

setCallback

void setCallback(IEventsProcessEngine callback)

Set the state machine where the ProcessEngine return response on complete or on error

Parameters:

callback -

start

void start(ProcessStep step,
           WorkerParameters workerParameters,
           PauseRecover pauseRecover)
    throws ProcessingEngineException

Start the execution of the given step

Parameters:

step - the ProcessStep object

workerParameters - the worker parameters

pauseRecover - prevent recover from pause action

Throws:

ProcessingEngineException - thrown if step could not be started

pause

boolean pause(java.lang.String operationId)

Pause the execution of the current step Send message to the distributor to cancel the execution of the current step

Parameters:

operationId - the operation identifier

Returns:

true if pause applied, false else

cancel

boolean cancel(java.lang.String operationId)

Cancel the execution of the current step Send message to the distributor to cancel the execution of the current step

Parameters:

operationId - the operation identifier

Returns:

true if pause applied, false else