Interface ProcessingManagementClient
- All Superinterfaces:
AutoCloseable,MockOrRestClient,VitamAutoCloseable
- All Known Implementing Classes:
ProcessingManagementClientMock
Processing Management Client
-
Method Summary
Modifier and TypeMethodDescriptioncancelOperationProcessExecution(String id, boolean force) cancelOperationProcessExecution : cancel processing operationexecuteOperationProcess(String operationId, String workflowId, String actionId) ExecuteOperationProcess : execute an operation processing Other than INIT process, only operation id and action id are requiredforcePause(ProcessPause info) Add a forced pause on the tenant and/or the type of processgetOperationProcessExecutionDetails : get operation processing execution detailsgetOperationProcessStatus: get operation process status**Retrieve all the workflow definitions.getWorkflowDetails(String WorkflowIdentifier) voidinitVitamProcess(ProcessingEntry entry) initVitamProcess woth processing entryvoidinitVitamProcess(String container, String workflowId) initVitamProcessRetrieve all the workflow operationsvoidregisterWorker(String familyId, String workerId, WorkerBean workerDescription) Register a new worker knowing its family and with a WorkerBean.removeForcePause(ProcessPause info) Removed the forced pause on the tenant and/or the type of processvoidunregisterWorker(String familyId, String workerId) Unregister a worker knowing its family and its workerId.updateOperationActionProcess(String actionId, String operationId) updateOperationActionProcess : update operation processing statusMethods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient
checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl
-
Method Details
-
registerWorker
void registerWorker(String familyId, String workerId, WorkerBean workerDescription) throws VitamClientInternalException, ProcessingBadRequestException 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 registeredworkerId- the id of the worker to be registeredworkerDescription- the description of the worker as a workerBean- Throws:
ProcessingBadRequestException- if a bad request has been sentVitamClientInternalException
-
unregisterWorker
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 registeredworkerId- the id of the worker to be registered- Throws:
ProcessingBadRequestException- if the worker or the family does not exist
-
getWorkflowDefinitions
Retrieve all the workflow definitions.- Returns:
- map of workflow definitions by id
- Throws:
VitamClientException
-
getWorkflowDetails
- Parameters:
WorkflowIdentifier-- Returns:
- Throws:
VitamClientException
-
removeForcePause
Removed the forced pause on the tenant and/or the type of process- Parameters:
info-- Throws:
ProcessingException
-
forcePause
Add a forced pause on the tenant and/or the type of process- Parameters:
info-- Throws:
ProcessingException
-
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:
VitamClientExceptionInternalServerExceptionBadRequestException
-
getOperationProcessExecutionDetails
RequestResponse<ItemStatus> getOperationProcessExecutionDetails(String id) throws VitamClientException, InternalServerException getOperationProcessExecutionDetails : get operation processing execution details- Parameters:
id- : operation identifier- Returns:
- Engine response containing message and status
- Throws:
VitamClientExceptionInternalServerException
-
cancelOperationProcessExecution
RequestResponse<ItemStatus> cancelOperationProcessExecution(String id, boolean force) throws InternalServerException, VitamClientException cancelOperationProcessExecution : cancel processing operation- Parameters:
id- : operation identifier- Returns:
- ItemStatus response containing message and status
- Throws:
VitamClientExceptionInternalServerException
-
updateOperationActionProcess
RequestResponse<ItemStatus> updateOperationActionProcess(String actionId, String operationId) throws InternalServerException, 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 containing message and status
- Throws:
InternalServerExceptionVitamClientException
-
executeOperationProcess
RequestResponse<ItemStatus> executeOperationProcess(String operationId, String workflowId, String actionId) throws InternalServerException, VitamClientException ExecuteOperationProcess : execute an operation processing Other than INIT process, only operation id and action id are required- Parameters:
operationId- id of the operation (required)workflowId- id of the workflow (optional)actionId- identify the action to be executed by the workflow(next , pause,resume) (required)- Returns:
- RequestResponse
- Throws:
InternalServerExceptionVitamClientException
-
initVitamProcess
void initVitamProcess(String container, String workflowId) throws BadRequestException, InternalServerException initVitamProcess- Parameters:
container-workflowId-- Throws:
InternalServerExceptionBadRequestException
-
initVitamProcess
initVitamProcess woth processing entry- Parameters:
entry-- Throws:
InternalServerExceptionBadRequestException
-
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
-