Package fr.gouv.vitam.processing.distributor.api

Interface ProcessDistributor

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

ProcessDistributorImpl

public interface ProcessDistributor
extends java.lang.AutoCloseable

interface ProcessDistributor

improves a availability and scalability
Various methods Distributor engine

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DISTRIBUTOR_INDEX
static java.lang.String	ELEMENT_UNITS
static java.lang.String	EXCEPTION_MESSAGE
static java.lang.String	JSON_EXTENSION
static java.lang.String	NOLEVEL
static java.lang.String	OBJECTS_LIST_EMPTY

Method Summary

Modifier and Type	Method	Description
boolean	cancel(java.lang.String operationId)	Get the current step if the processWorkflow corresponding to the operationId and update his pauseCancelAction parameter to be PauseOrCancelAction.ACTION_CANCEL WorkerTask check this parameter and can cancel the not yet running tasks
ItemStatus	distribute(WorkerParameters workParams, Step step, java.lang.String operationId, PauseRecover pauseRecover)	Distribute different steps (execute a workflow actions step by step)
ProcessDataAccess	getProcessDataAccess()
ProcessDataManagement	getProcessDataManagement()
WorkerClientFactory	getWorkerClientFactory()
IWorkerManager	getWorkerManager()
WorkspaceClientFactory	getWorkspaceClientFactory()
boolean	pause(java.lang.String operationId)	Get the current step of the processWorkflow corresponding to the operationId and update his pauseCancelAction parameter to be PauseOrCancelAction.ACTION_PAUSE WorkerTask check this parameter and can pause the not yet running tasks

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

JSON_EXTENSION

static final java.lang.String JSON_EXTENSION

See Also:

Constant Field Values

EXCEPTION_MESSAGE

static final java.lang.String EXCEPTION_MESSAGE

See Also:

Constant Field Values

OBJECTS_LIST_EMPTY

static final java.lang.String OBJECTS_LIST_EMPTY

See Also:

Constant Field Values

ELEMENT_UNITS

static final java.lang.String ELEMENT_UNITS

See Also:

Constant Field Values

DISTRIBUTOR_INDEX

static final java.lang.String DISTRIBUTOR_INDEX

See Also:

Constant Field Values

NOLEVEL

static final java.lang.String NOLEVEL

See Also:

Constant Field Values

Method Detail

distribute

ItemStatus distribute(WorkerParameters workParams,
                      Step step,
                      java.lang.String operationId,
                      PauseRecover pauseRecover)

Distribute different steps (execute a workflow actions step by step)

Parameters:

workParams - WorkerParameters null not allowed

step - ProcessStep null not allowed

operationId - operationId

pauseRecover - prevent recover from pause action

Returns:

CompositeItemStatus : list of action response

pause

boolean pause(java.lang.String operationId)

Get the current step of the processWorkflow corresponding to the operationId and update his pauseCancelAction parameter to be PauseOrCancelAction.ACTION_PAUSE WorkerTask check this parameter and can pause the not yet running tasks

Parameters:

operationId - concerning operation id

Returns:

true if pause applied, false else

cancel

boolean cancel(java.lang.String operationId)

Get the current step if the processWorkflow corresponding to the operationId and update his pauseCancelAction parameter to be PauseOrCancelAction.ACTION_CANCEL WorkerTask check this parameter and can cancel the not yet running tasks

Parameters:

operationId - concerning operation id

Returns:

true if pause applied, false else

getProcessDataAccess

ProcessDataAccess getProcessDataAccess()

getProcessDataManagement

ProcessDataManagement getProcessDataManagement()

getWorkerManager

IWorkerManager getWorkerManager()

getWorkspaceClientFactory

WorkspaceClientFactory getWorkspaceClientFactory()

getWorkerClientFactory

WorkerClientFactory getWorkerClientFactory()