fr.gouv.vitam.common.client

Interface OperationManagementClient

All Superinterfaces:

AutoCloseable, MockOrRestClient, VitamAutoCloseable

All Known Subinterfaces:

IngestInternalClient, ProcessingManagementClient

All Known Implementing Classes:

IngestInternalClientMock, ProcessingManagementClientMock

public interface OperationManagementClient
extends MockOrRestClient

OperationManagementClient include all common method between ProcessManagement and Ingest Internal

Method Summary

Modifier and Type	Method and Description
ItemStatus	cancelOperationProcessExecution(String id) cancelOperationProcessExecution : cancel processing operation
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	executeOperationProcess(String operationId, String workflow, String contextId, String actionId) executeOperationProcess : execute an operation processing
ItemStatus	getOperationProcessExecutionDetails(String id) getOperationProcessExecutionDetails : get operation processing execution details
ItemStatus	getOperationProcessStatus(String id) getOperationProcessStatus: get operation process status**
RequestResponse<WorkFlow>	getWorkflowDefinitions() Retrieve all the workflow definitions.
void	initVitamProcess(String contextId, String container, String workflow) initVitamProcess
void	initWorkFlow(String contextId) initWorkFlow : init workFlow Process
RequestResponse<ProcessDetail>	listOperationsDetails(ProcessQuery query) Retrieve all the workflow operations
RequestResponse<ItemStatus>	updateOperationActionProcess(String actionId, String operationId) updateOperationActionProcess : update operation processing status

Methods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Method Detail

getOperationProcessStatus

ItemStatus getOperationProcessStatus(String id)
                              throws VitamClientException,
                                     InternalServerException,
                                     BadRequestException

getOperationProcessStatus: get operation process status**

Parameters:

id - : operation identifier*

Returns:

ItemStatus response containing message and status*

Throws:

VitamClientException

InternalServerException

BadRequestException

getOperationProcessExecutionDetails

ItemStatus getOperationProcessExecutionDetails(String id)
                                        throws VitamClientException,
                                               InternalServerException,
                                               BadRequestException

getOperationProcessExecutionDetails : get operation processing execution details

Parameters:

id - : operation identifier

Returns:

Engine response containing message and status

Throws:

VitamClientException

InternalServerException

BadRequestException

cancelOperationProcessExecution

ItemStatus cancelOperationProcessExecution(String id)
                                    throws InternalServerException,
                                           BadRequestException,
                                           VitamClientException

cancelOperationProcessExecution : cancel processing operation

Parameters:

id - : operation identifier

Returns:

ItemStatus response containing message and status

Throws:

VitamClientException

InternalServerException

BadRequestException

updateOperationActionProcess

RequestResponse<ItemStatus> updateOperationActionProcess(String actionId,
                                                         String operationId)
                                                  throws InternalServerException,
                                                         BadRequestException,
                                                         VitamClientException

updateOperationActionProcess : update operation processing status

Parameters:

actionId - : identify the action to be executed by the workflow(next , pause,resume)

operationId - : operation identifier

Returns:

Response response containing message and status

Throws:

InternalServerException

BadRequestException

VitamClientException

executeOperationProcess

RequestResponse<com.fasterxml.jackson.databind.JsonNode> executeOperationProcess(String operationId,
                                                                                 String workflow,
                                                                                 String contextId,
                                                                                 String actionId)
                                                                          throws InternalServerException,
                                                                                 BadRequestException,
                                                                                 VitamClientException,
                                                                                 WorkflowNotFoundException

executeOperationProcess : execute an operation processing

Parameters:

operationId - id of the operation

workflow - id of the workflow

contextId - define the execution context of workflow

actionId - identify the action to be executed by the workflow(next , pause,resume)

Returns:

RequestResponse

Throws:

InternalServerException

BadRequestException

VitamClientException

WorkflowNotFoundException

initWorkFlow

void initWorkFlow(String contextId)
           throws VitamException

initWorkFlow : init workFlow Process

Parameters:

contextId - :define the execution context of workflow

Throws:

VitamClientException

VitamException

initVitamProcess

void initVitamProcess(String contextId,
                      String container,
                      String workflow)
               throws InternalServerException,
                      VitamClientException,
                      BadRequestException

initVitamProcess

Parameters:

contextId -

container -

workflow -

Throws:

InternalServerException

VitamClientException

BadRequestException

listOperationsDetails

RequestResponse<ProcessDetail> listOperationsDetails(ProcessQuery query)
                                              throws VitamClientException

Retrieve all the workflow operations

Parameters:

query - Query model

Returns:

All details of the operations

Throws:

VitamClientException

getWorkflowDefinitions

RequestResponse<WorkFlow> getWorkflowDefinitions()
                                          throws VitamClientException

Retrieve all the workflow definitions.

Returns:

workflow definitions

Throws:

VitamClientException