fr.gouv.vitam.processing.distributor.api

Interface ProcessDistributor

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ProcessDistributorImpl

public interface ProcessDistributor
extends AutoCloseable

interface ProcessDistributor

improves a availability and scalability
Various methods Distributor engine

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISTRIBUTOR_INDEX
static String	ELEMENT_UNITS
static String	EXCEPTION_MESSAGE
static String	INGEST_LEVEL_STACK
static String	JSON_EXTENSION
static String	NOLEVEL
static String	OBJECTS_LIST_EMPTY
static String	UNITS_LEVEL
static String	WORKER_CALL_EXCEPTION

Method Summary

Modifier and Type	Method and Description
boolean	cancel(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, String operationId, PauseRecover pauseRecover) Distribute different steps (execute a workflow actions step by step)
boolean	pause(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

UNITS_LEVEL

static final String UNITS_LEVEL

See Also:

Constant Field Values

JSON_EXTENSION

static final String JSON_EXTENSION

See Also:

Constant Field Values

EXCEPTION_MESSAGE

static final String EXCEPTION_MESSAGE

See Also:

Constant Field Values

INGEST_LEVEL_STACK

static final String INGEST_LEVEL_STACK

See Also:

Constant Field Values

OBJECTS_LIST_EMPTY

static final String OBJECTS_LIST_EMPTY

See Also:

Constant Field Values

ELEMENT_UNITS

static final String ELEMENT_UNITS

See Also:

Constant Field Values

DISTRIBUTOR_INDEX

static final String DISTRIBUTOR_INDEX

See Also:

Constant Field Values

NOLEVEL

static final String NOLEVEL

See Also:

Constant Field Values

WORKER_CALL_EXCEPTION

static final String WORKER_CALL_EXCEPTION

See Also:

Constant Field Values

Method Detail

distribute

ItemStatus distribute(WorkerParameters workParams,
                      Step step,
                      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(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(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