Interface IngestInternalClient
- All Superinterfaces:
AutoCloseable,MockOrRestClient,VitamAutoCloseable
- All Known Implementing Classes:
IngestInternalClientMock
Ingest Internal client interface
-
Method Summary
Modifier and TypeMethodDescriptioncancelOperationProcessExecution(String id, boolean force) cancelOperationProcessExecution : cancel processing operationjavax.ws.rs.core.ResponsedownloadObjectAsync(String objectId, IngestCollection type) Download object stored by ingest operationgetOperationProcessExecutionDetails : get operation processing execution detailsgetOperationProcessStatus: get operation process status**Retrieve all the workflow definitions.getWorkflowDetails(String WorkflowIdentifier) voidinitWorkflow(WorkFlow workFlow) initWorkflow : init workFlow ProcessRetrieve all the workflow operationsvoidsaveObjectToWorkspace(String id, String objectName, InputStream inputStream) updateOperationActionProcess(String actionId, String operationId) updateOperationActionProcess : update operation processing statusvoidupload(InputStream inputStream, javax.ws.rs.core.MediaType archiveType, WorkFlow workflow, String action) Upload compressed SIP as streamvoiduploadInitialLogbook(Iterable<LogbookOperationParameters> logbookParametersList) Create only LogbookMethods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient
checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl
-
Method Details
-
upload
void upload(InputStream inputStream, javax.ws.rs.core.MediaType archiveType, WorkFlow workflow, String action) throws VitamException Upload compressed SIP as stream- Parameters:
archiveType- is a format (mime type) of SIP (should be zip ,tar, tar.gz or tar.bz2)inputStream- SIPworkflow- workflow informationaction- Identifier- Throws:
VitamException- if stream is null
-
uploadInitialLogbook
void uploadInitialLogbook(Iterable<LogbookOperationParameters> logbookParametersList) throws VitamException Create only Logbook- Parameters:
logbookParametersList-- Throws:
VitamException
-
downloadObjectAsync
javax.ws.rs.core.Response downloadObjectAsync(String objectId, IngestCollection type) throws InvalidParseOperationException, IngestInternalClientServerException, IngestInternalClientNotFoundException Download object stored by ingest operation- Parameters:
objectId-type-- Returns:
- object as stream
- Throws:
InvalidParseOperationExceptionIngestInternalClientServerExceptionIngestInternalClientNotFoundException
-
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 getOperationProcessExecutionDetails : get operation processing execution details- Parameters:
id- : operation identifier- Returns:
- Engine response containing message and status
- Throws:
VitamClientException
-
cancelOperationProcessExecution
RequestResponse<ItemStatus> cancelOperationProcessExecution(String id, boolean force) throws VitamClientException cancelOperationProcessExecution : cancel processing operation- Parameters:
id- operation identifierforce- force operation if step is not cancellable- Returns:
- ItemStatus response containing message and status
- Throws:
VitamClientException
-
updateOperationActionProcess
RequestResponse<ItemStatus> updateOperationActionProcess(String actionId, String operationId) throws 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:
VitamClientException
-
initWorkflow
initWorkflow : init workFlow Process- Parameters:
workFlow- information- Throws:
VitamClientExceptionVitamException
-
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
Retrieve all the workflow definitions.- Returns:
- workflow definitions
- Throws:
VitamClientException
-
getWorkflowDetails
- Parameters:
WorkflowIdentifier-- Returns:
- Throws:
VitamClientException
-
saveObjectToWorkspace
void saveObjectToWorkspace(String id, String objectName, InputStream inputStream) throws VitamClientException - Throws:
VitamClientException
-