fr.gouv.vitam.access.external.client

Interface AccessExternalClient

All Superinterfaces:

AutoCloseable, BasicClient, MockOrRestClient, VitamAutoCloseable

public interface AccessExternalClient
extends BasicClient

Access External Client Interface

Field Summary

Fields inherited from interface fr.gouv.vitam.common.external.client.BasicClient

STATUS_URL

Method Summary

Modifier and Type	Method and Description
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	exportDIP(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode selectQuery)
javax.ws.rs.core.Response	getDIPById(VitamContext vitamContext, String dipId) getDIPById The caller is responsible to close the Response after consuming the inputStream.
javax.ws.rs.core.Response	getObjectStreamByUnitId(VitamContext vitamContext, String unitId, String usage, int version) getObjectAsInputStream The caller is responsible to close the Response after consuming the inputStream.
RequestResponse<LogbookLifecycle>	selectObjectGroupLifeCycleById(VitamContext vitamContext, String objectGroupLifeCycleId, com.fasterxml.jackson.databind.JsonNode select) selectObjectGroupLifeCycleById
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	selectObjectMetadatasByUnitId(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode selectQuery, String unitId) selectObjectById
RequestResponse<LogbookOperation>	selectOperationbyId(VitamContext vitamContext, String operationId, com.fasterxml.jackson.databind.JsonNode select) selectOperationbyId
RequestResponse<LogbookOperation>	selectOperations(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select) selectOperation
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	selectUnitbyId(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode selectQuery, String unitId) selectUnitbyId GET(POST overrided) /units/{id}
RequestResponse<LogbookLifecycle>	selectUnitLifeCycleById(VitamContext vitamContext, String unitLifeCycleId, com.fasterxml.jackson.databind.JsonNode select) selectUnitLifeCycleById
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	selectUnits(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode selectQuery) selectUnits /units
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	updateUnitbyId(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode updateQuery, String unitId) updateUnitbyId UPDATE /units/{id}

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

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Method Detail

selectUnits

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectUnits(VitamContext vitamContext,
                                                                     com.fasterxml.jackson.databind.JsonNode selectQuery)
                                                              throws VitamClientException

selectUnits /units

Parameters:

vitamContext - the vitam context

selectQuery - the select query

Returns:

Json representation

Throws:

VitamClientException

selectUnitbyId

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectUnitbyId(VitamContext vitamContext,
                                                                        com.fasterxml.jackson.databind.JsonNode selectQuery,
                                                                        String unitId)
                                                                 throws VitamClientException

selectUnitbyId GET(POST overrided) /units/{id}

Parameters:

vitamContext - the vitam context

selectQuery - the select query

unitId - the unit id to select

Returns:

Json representation

Throws:

VitamClientException

updateUnitbyId

RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateUnitbyId(VitamContext vitamContext,
                                                                        com.fasterxml.jackson.databind.JsonNode updateQuery,
                                                                        String unitId)
                                                                 throws VitamClientException

updateUnitbyId UPDATE /units/{id}

Parameters:

vitamContext - the vitam context

updateQuery - the update query

unitId - the unit id to update

Returns:

Json representation

Throws:

VitamClientException

selectObjectMetadatasByUnitId

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectObjectMetadatasByUnitId(VitamContext vitamContext,
                                                                                       com.fasterxml.jackson.databind.JsonNode selectQuery,
                                                                                       String unitId)
                                                                                throws VitamClientException

selectObjectById

Parameters:

vitamContext - the vitam context

selectQuery - the select query

unitId - the unit id for getting object

Returns:

Json representation

Throws:

VitamClientException

getObjectStreamByUnitId

javax.ws.rs.core.Response getObjectStreamByUnitId(VitamContext vitamContext,
                                                  String unitId,
                                                  String usage,
                                                  int version)
                                           throws VitamClientException

getObjectAsInputStream

The caller is responsible to close the Response after consuming the inputStream.

Parameters:

vitamContext - the vitam context

unitId - the unit id for getting the object

usage - kind of usage

version - the version

Returns:

Response including InputStream

Throws:

InvalidParseOperationException

AccessExternalClientServerException

AccessExternalClientNotFoundException

AccessUnauthorizedException

VitamClientException

selectOperations

RequestResponse<LogbookOperation> selectOperations(VitamContext vitamContext,
                                                   com.fasterxml.jackson.databind.JsonNode select)
                                            throws VitamClientException

selectOperation

Parameters:

vitamContext - the vitam context

select - the select query

Returns:

logbookOperation representation

Throws:

LogbookClientException

InvalidParseOperationException

AccessUnauthorizedException

VitamClientException

selectOperationbyId

RequestResponse<LogbookOperation> selectOperationbyId(VitamContext vitamContext,
                                                      String operationId,
                                                      com.fasterxml.jackson.databind.JsonNode select)
                                               throws VitamClientException

selectOperationbyId

Parameters:

vitamContext - the vitam context

operationId - the operation id

select - the select query

Returns:

logbookOperation representation

Throws:

VitamClientException

selectUnitLifeCycleById

RequestResponse<LogbookLifecycle> selectUnitLifeCycleById(VitamContext vitamContext,
                                                          String unitLifeCycleId,
                                                          com.fasterxml.jackson.databind.JsonNode select)
                                                   throws VitamClientException

selectUnitLifeCycleById

Parameters:

vitamContext - the vitam context

unitLifeCycleId - the unit LFC id

select - the select query

Returns:

logbooklifecycle representation

Throws:

VitamClientException

selectObjectGroupLifeCycleById

RequestResponse<LogbookLifecycle> selectObjectGroupLifeCycleById(VitamContext vitamContext,
                                                                 String objectGroupLifeCycleId,
                                                                 com.fasterxml.jackson.databind.JsonNode select)
                                                          throws VitamClientException

selectObjectGroupLifeCycleById

Parameters:

vitamContext - the vitam context

objectGroupLifeCycleId - the objectGroup LFC id

select - the select query

Returns:

logbooklifecycle representation

Throws:

VitamClientException

exportDIP

RequestResponse<com.fasterxml.jackson.databind.JsonNode> exportDIP(VitamContext vitamContext,
                                                                   com.fasterxml.jackson.databind.JsonNode selectQuery)
                                                            throws VitamClientException

Parameters:

vitamContext - the vitam context

selectQuery - the DSL query used to select unit to export as DIP

Returns:

the result of the information obtained in the DIP

Throws:

VitamClientException

getDIPById

javax.ws.rs.core.Response getDIPById(VitamContext vitamContext,
                                     String dipId)
                              throws VitamClientException

getDIPById

The caller is responsible to close the Response after consuming the inputStream.

Parameters:

vitamContext - the vitam context

dipId - the previously generated DIP id to download the DIP

Returns:

Response including InputStream

Throws:

VitamClientException