fr.gouv.vitam.ingest.internal.client

Class IngestInternalClientMock

java.lang.Object

fr.gouv.vitam.common.client.AbstractMockClient

fr.gouv.vitam.ingest.internal.client.IngestInternalClientMock

All Implemented Interfaces:

MockOrRestClient, OperationManagementClient, VitamAutoCloseable, IngestInternalClient, AutoCloseable

public class IngestInternalClientMock
extends AbstractMockClient
implements IngestInternalClient

Mock client implementation for Ingest Internal

Nested Class Summary

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

AbstractMockClient.FakeInboundResponse

Field Summary

Fields

Modifier and Type	Field and Description
protected StatusCode	globalStatus
static String	ID identifier of execution
static String	MOCK_INGEST_INTERNAL_RESPONSE_STREAM mock ingest response

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

INTERNAL_SERVER_ERROR

Constructor Summary

Constructors

Constructor and Description
IngestInternalClientMock()

Method Summary

Modifier and Type	Method and Description
ItemStatus	cancelOperationProcessExecution(String id) cancelOperationProcessExecution : cancel processing operation
javax.ws.rs.core.Response	downloadObjectAsync(String objectId, IngestCollection type) Download object stored by ingest 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
void	storeATR(GUID guid, InputStream input) Store ATR in storage
RequestResponse<ItemStatus>	updateOperationActionProcess(String actionId, String operationId) updateOperationActionProcess : update operation processing status
void	upload(InputStream inputStream, javax.ws.rs.core.MediaType archiveType, String contextId) Upload compressed SIP as stream
void	uploadFinalLogbook(Iterable<LogbookOperationParameters> logbookParametersList) Finalize the ingest operation by sending back the final Logbook Operation entries from Ingest external
javax.ws.rs.core.Response	uploadInitialLogbook(Iterable<LogbookOperationParameters> logbookParametersList) Create only Logbook

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

Field Detail

MOCK_INGEST_INTERNAL_RESPONSE_STREAM

public static final String MOCK_INGEST_INTERNAL_RESPONSE_STREAM

mock ingest response

See Also:

Constant Field Values

ID

public static final String ID

identifier of execution

See Also:

Constant Field Values

globalStatus

protected StatusCode globalStatus

Constructor Detail

IngestInternalClientMock

public IngestInternalClientMock()

Method Detail

upload

public void upload(InputStream inputStream,
                   javax.ws.rs.core.MediaType archiveType,
                   String contextId)
            throws VitamException

Description copied from interface: IngestInternalClient

Upload compressed SIP as stream

Specified by:

upload in interface IngestInternalClient

Parameters:

inputStream - SIP

archiveType - is a format (mime type) of SIP (should be zip ,tar, tar.gz or tar.bz2)

contextId - context Identifier

Throws:

VitamException - if stream is null

uploadInitialLogbook

public javax.ws.rs.core.Response uploadInitialLogbook(Iterable<LogbookOperationParameters> logbookParametersList)
                                               throws VitamException

Description copied from interface: IngestInternalClient

Create only Logbook

Specified by:

uploadInitialLogbook in interface IngestInternalClient

Returns:

Response as just CREATED

Throws:

VitamException

uploadFinalLogbook

public void uploadFinalLogbook(Iterable<LogbookOperationParameters> logbookParametersList)
                        throws VitamClientException

Description copied from interface: IngestInternalClient

Finalize the ingest operation by sending back the final Logbook Operation entries from Ingest external

Specified by:

uploadFinalLogbook in interface IngestInternalClient

Throws:

VitamClientException

downloadObjectAsync

public javax.ws.rs.core.Response downloadObjectAsync(String objectId,
                                                     IngestCollection type)

Description copied from interface: IngestInternalClient

Download object stored by ingest operation

Specified by:

downloadObjectAsync in interface IngestInternalClient

Returns:

object as stream

storeATR

public void storeATR(GUID guid,
                     InputStream input)
              throws VitamClientException

Description copied from interface: IngestInternalClient

Store ATR in storage

Specified by:

storeATR in interface IngestInternalClient

Throws:

VitamClientException

getOperationProcessStatus

public ItemStatus getOperationProcessStatus(String id)
                                     throws VitamClientException

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

getOperationProcessExecutionDetails

public ItemStatus getOperationProcessExecutionDetails(String id)
                                               throws VitamClientException

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

cancelOperationProcessExecution

public ItemStatus cancelOperationProcessExecution(String id)
                                           throws 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:

VitamClientException

updateOperationActionProcess

public RequestResponse<ItemStatus> updateOperationActionProcess(String actionId,
                                                                String operationId)
                                                         throws 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:

VitamClientException

executeOperationProcess

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> executeOperationProcess(String operationId,
                                                                                        String workflow,
                                                                                        String contextId,
                                                                                        String actionId)
                                                                                 throws 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:

VitamClientException

initWorkFlow

public void initWorkFlow(String contextId)
                  throws VitamClientException,
                         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

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 VitamClientInternalException

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:

VitamClientInternalException

getWorkflowDefinitions

public RequestResponse<WorkFlow> getWorkflowDefinitions()
                                                 throws VitamClientException

Description copied from interface: OperationManagementClient

Retrieve all the workflow definitions.

Specified by:

getWorkflowDefinitions in interface OperationManagementClient

Returns:

workflow definitions

Throws:

VitamClientException