fr.gouv.vitam.processing.management.client

Class ProcessingManagementClientMock

java.lang.Object

fr.gouv.vitam.common.client.AbstractMockClient

fr.gouv.vitam.processing.management.client.ProcessingManagementClientMock

All Implemented Interfaces:

MockOrRestClient, OperationManagementClient, VitamAutoCloseable, ProcessingManagementClient, AutoCloseable

public class ProcessingManagementClientMock
extends AbstractMockClient
implements ProcessingManagementClient

Nested Class Summary

Nested classes/interfaces inherited from class fr.gouv.vitam.common.client.AbstractMockClient

AbstractMockClient.FakeInboundResponse

Field Summary

Fields inherited from class fr.gouv.vitam.common.client.AbstractMockClient

INTERNAL_SERVER_ERROR

Method Summary

Modifier and Type	Method and Description
ItemStatus	cancelOperationProcessExecution(String id) cancelOperationProcessExecution : cancel processing operation
javax.ws.rs.core.Response	executeCheckTraceabilityWorkFlow(String checkOperationId, com.fasterxml.jackson.databind.JsonNode query, String workflow, String contextId, String actionId)
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, ProcessingEntry entry) initVitamProcess woth processing entry
void	initVitamProcess(String contextId, String container, String workflow) initVitamProcess
void	initWorkFlow(String contextId) initWorkFlow : init workFlow Process
boolean	isOperationCompleted(String operationId) Check if process workflow is completed of not TODO Move this method to OperationManagementClient
RequestResponse<ProcessDetail>	listOperationsDetails(ProcessQuery query) Retrieve all the workflow operations
void	registerWorker(String familyId, String workerId, WorkerBean workerDescription) Register a new worker knowing its family and with a WorkerBean.
void	unregisterWorker(String familyId, String workerId) Unregister a worker knowing its family and its workerId.
RequestResponse<ItemStatus>	updateOperationActionProcess(String actionId, String operationId) updateOperationActionProcess : update operation processing status

Methods inherited from class fr.gouv.vitam.common.client.AbstractMockClient

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Method Detail

isOperationCompleted

public boolean isOperationCompleted(String operationId)

Description copied from interface: ProcessingManagementClient

Check if process workflow is completed of not TODO Move this method to OperationManagementClient

Specified by:

isOperationCompleted in interface ProcessingManagementClient

Returns:

boolean true/false

getOperationProcessStatus

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

Description copied from interface: OperationManagementClient

getOperationProcessStatus: get operation process status**

Specified by:

getOperationProcessStatus in interface OperationManagementClient

Parameters:

id - : operation identifier*

Returns:

ItemStatus response containing message and status*

Throws:

VitamClientException

InternalServerException

BadRequestException

getOperationProcessExecutionDetails

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

Description copied from interface: OperationManagementClient

getOperationProcessExecutionDetails : get operation processing execution details

Specified by:

getOperationProcessExecutionDetails in interface OperationManagementClient

Parameters:

id - : operation identifier

Returns:

Engine response containing message and status

Throws:

VitamClientException

InternalServerException

BadRequestException

cancelOperationProcessExecution

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

Description copied from interface: OperationManagementClient

cancelOperationProcessExecution : cancel processing operation

Specified by:

cancelOperationProcessExecution in interface OperationManagementClient

Parameters:

id - : operation identifier

Returns:

ItemStatus response containing message and status

Throws:

InternalServerException

BadRequestException

VitamClientException

updateOperationActionProcess

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

Description copied from interface: OperationManagementClient

updateOperationActionProcess : update operation processing status

Specified by:

updateOperationActionProcess in interface OperationManagementClient

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

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

Description copied from interface: OperationManagementClient

executeOperationProcess : execute an operation processing

Specified by:

executeOperationProcess in interface OperationManagementClient

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

initWorkFlow

public void initWorkFlow(String contextId)
                  throws VitamException

Description copied from interface: OperationManagementClient

initWorkFlow : init workFlow Process

Specified by:

initWorkFlow in interface OperationManagementClient

Parameters:

contextId - :define the execution context of workflow

Throws:

VitamClientException

VitamException

registerWorker

public void registerWorker(String familyId,
                           String workerId,
                           WorkerBean workerDescription)
                    throws ProcessingBadRequestException,
                           WorkerAlreadyExistsException

Description copied from interface: ProcessingManagementClient

Register a new worker knowing its family and with a WorkerBean. If a problem is encountered, an exception is thrown.

Specified by:

registerWorker in interface ProcessingManagementClient

Parameters:

familyId - the id of the family to which the worker has to be registered

workerId - the id of the worker to be registered

workerDescription - the description of the worker as a workerBean

Throws:

ProcessingBadRequestException - if a bad request has been sent

WorkerAlreadyExistsException - if the worker family does not exist

unregisterWorker

public void unregisterWorker(String familyId,
                             String workerId)
                      throws ProcessingBadRequestException

Description copied from interface: ProcessingManagementClient

Unregister a worker knowing its family and its workerId. If the familyId or the workerId is unknown, an exception is thrown.

Specified by:

unregisterWorker in interface ProcessingManagementClient

Parameters:

familyId - the id of the family to which the worker has to be registered

workerId - the id of the worker to be registered

Throws:

ProcessingBadRequestException - if the worker or the family does not exist

initVitamProcess

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

Description copied from interface: OperationManagementClient

initVitamProcess

Specified by:

initVitamProcess in interface OperationManagementClient

Throws:

InternalServerException

VitamClientException

BadRequestException

listOperationsDetails

public RequestResponse<ProcessDetail> listOperationsDetails(ProcessQuery query)
                                                     throws VitamClientException

Description copied from interface: OperationManagementClient

Retrieve all the workflow operations

Specified by:

listOperationsDetails in interface OperationManagementClient

Parameters:

query - Query model

Returns:

All details of the operations

Throws:

VitamClientException

executeCheckTraceabilityWorkFlow

public javax.ws.rs.core.Response executeCheckTraceabilityWorkFlow(String checkOperationId,
                                                                  com.fasterxml.jackson.databind.JsonNode query,
                                                                  String workflow,
                                                                  String contextId,
                                                                  String actionId)
                                                           throws InternalServerException,
                                                                  BadRequestException,
                                                                  WorkflowNotFoundException

Specified by:

executeCheckTraceabilityWorkFlow in interface ProcessingManagementClient

Returns:

Response

Throws:

InternalServerException

BadRequestException

WorkflowNotFoundException

getWorkflowDefinitions

public RequestResponse<WorkFlow> getWorkflowDefinitions()
                                                 throws VitamClientException

Description copied from interface: ProcessingManagementClient

Retrieve all the workflow definitions.

Specified by:

getWorkflowDefinitions in interface OperationManagementClient

Specified by:

getWorkflowDefinitions in interface ProcessingManagementClient

Returns:

map of workflow definitions by id

Throws:

VitamClientException

initVitamProcess

public void initVitamProcess(String contextId,
                             ProcessingEntry entry)
                      throws InternalServerException,
                             BadRequestException

Description copied from interface: ProcessingManagementClient

initVitamProcess woth processing entry

Specified by:

initVitamProcess in interface ProcessingManagementClient

Throws:

InternalServerException

BadRequestException