fr.gouv.vitam.processing.management.client

Interface ProcessingManagementClient

All Superinterfaces:

AutoCloseable, MockOrRestClient, OperationManagementClient, VitamAutoCloseable

All Known Implementing Classes:

ProcessingManagementClientMock

public interface ProcessingManagementClient
extends OperationManagementClient

Processing Management Client

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	executeCheckTraceabilityWorkFlow(String checkOperationId, com.fasterxml.jackson.databind.JsonNode query, String workflow, String contextId, String actionId)
RequestResponse<WorkFlow>	getWorkflowDefinitions() Retrieve all the workflow definitions.
void	initVitamProcess(String contextId, ProcessingEntry entry) initVitamProcess woth processing entry
boolean	isOperationCompleted(String operationId) Check if process workflow is completed of not TODO Move this method to OperationManagementClient
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.

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

cancelOperationProcessExecution, executeOperationProcess, getOperationProcessExecutionDetails, getOperationProcessStatus, initVitamProcess, initWorkFlow, listOperationsDetails, updateOperationActionProcess

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

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Method Detail

isOperationCompleted

boolean isOperationCompleted(String operationId)

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

Parameters:

operationId -

Returns:

boolean true/false

registerWorker

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

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

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

void unregisterWorker(String familyId,
                      String workerId)
               throws ProcessingBadRequestException

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

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

executeCheckTraceabilityWorkFlow

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

Parameters:

query -

workflow -

contextId -

actionId -

Returns:

Response

Throws:

InternalServerException

BadRequestException

WorkflowNotFoundException

getWorkflowDefinitions

RequestResponse<WorkFlow> getWorkflowDefinitions()
                                          throws VitamClientException

Retrieve all the workflow definitions.

Specified by:

getWorkflowDefinitions in interface OperationManagementClient

Returns:

map of workflow definitions by id

Throws:

VitamClientException

initVitamProcess

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

initVitamProcess woth processing entry

Parameters:

contextId -

entry -

Throws:

InternalServerException

BadRequestException