AccessInternalClient (Vitam API Reference (1.0.0))

All Superinterfaces:

AutoCloseable, MockOrRestClient, VitamAutoCloseable
```
public interface AccessInternalClient
extends MockOrRestClient
```
Access client interface

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`checkTraceabilityOperation(com.fasterxml.jackson.databind.JsonNode query)` Checks operation traceability
`javax.ws.rs.core.Response`	`downloadTraceabilityFile(String operationId)`
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`exportDIP(com.fasterxml.jackson.databind.JsonNode queryJson)` launch a DIP operation by a DSL query
`javax.ws.rs.core.Response`	`findDIPByID(String id)` get a zip file containing a DIP by an operation id
`javax.ws.rs.core.Response`	`getObject(String objectGroupId, String usage, int version)` Retrieve an Object data as an input stream
`javax.ws.rs.core.Response`	`getObjectByIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode queryDsl, String objectId)` Retrieve object group by id with XML format (DIP)
`javax.ws.rs.core.Response`	`getObjectByUnitIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode queryDsl, String unitId)` Retrieve object group by unit id with XML format (DIP)
`javax.ws.rs.core.Response`	`getUnitByIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode queryDsl, String idUnit)`
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`selectObjectbyId(com.fasterxml.jackson.databind.JsonNode selectObjectQuery, String objectId)` Retrieve an ObjectGroup as Json data based on the provided ObjectGroup id
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`selectObjectGroupLifeCycleById(String idObject, com.fasterxml.jackson.databind.JsonNode queryDsl)` selectObjectGroupLifeCycleById
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`selectOperation(com.fasterxml.jackson.databind.JsonNode select)` selectOperation
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`selectOperationById(String processId, com.fasterxml.jackson.databind.JsonNode queryDsl)` selectOperationbyId
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`selectUnitbyId(com.fasterxml.jackson.databind.JsonNode sqlQuery, String id)` select Unit By Id
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`selectUnitLifeCycle(com.fasterxml.jackson.databind.JsonNode queryDsl)` selectUnitLifeCycleById
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`selectUnitLifeCycleById(String idUnit, com.fasterxml.jackson.databind.JsonNode queryDsl)` selectUnitLifeCycleById
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`selectUnits(com.fasterxml.jackson.databind.JsonNode selectQuery)` Select Units
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`updateUnitbyId(com.fasterxml.jackson.databind.JsonNode updateQuery, String unitId)` update Unit By 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(com.fasterxml.jackson.databind.JsonNode selectQuery)
                                                              throws InvalidParseOperationException,
                                                                     AccessInternalClientServerException,
                                                                     AccessInternalClientNotFoundException,
                                                                     AccessUnauthorizedException,
                                                                     BadRequestException,
                                                                     VitamDBException

Select Units

Parameters:: selectQuery - the query used to select units
Returns:: a response containing a json node object including DSL queries and results
Throws:: InvalidParseOperationException - if the query is not well formatted; AccessInternalClientServerException - if the server encountered an exception; AccessInternalClientNotFoundException - if the requested unit does not exist; AccessUnauthorizedException; BadRequestException - if empty query is found; VitamDBException

selectUnitbyId

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectUnitbyId(com.fasterxml.jackson.databind.JsonNode sqlQuery,
                                                                        String id)
                                                                 throws InvalidParseOperationException,
                                                                        AccessInternalClientServerException,
                                                                        AccessInternalClientNotFoundException,
                                                                        AccessUnauthorizedException

select Unit By Id

Parameters:: sqlQuery - the query to be executed; id - the id of the unit
Returns:: a response containing a json node object including DSL queries, context and results
Throws:: InvalidParseOperationException - if the query is not well formatted; AccessInternalClientServerException - if the server encountered an exception; AccessInternalClientNotFoundException - if the requested unit does not exist; AccessUnauthorizedException

updateUnitbyId

RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateUnitbyId(com.fasterxml.jackson.databind.JsonNode updateQuery,
                                                                        String unitId)
                                                                 throws InvalidParseOperationException,
                                                                        AccessInternalClientServerException,
                                                                        AccessInternalClientNotFoundException,
                                                                        NoWritingPermissionException,
                                                                        AccessUnauthorizedException

update Unit By Id

Parameters:: updateQuery - the query to be executed as an update; unitId - the id of the unit
Returns:: a response containing a json node object including DSL queries, context and results
Throws:: InvalidParseOperationException - if the query is not well formatted; AccessInternalClientServerException - if the server encountered an exception; AccessInternalClientNotFoundException - if the requested unit does not exist; AccessUnauthorizedException; AccessInternalRuleExecutionException; NoWritingPermissionException

selectObjectbyId

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectObjectbyId(com.fasterxml.jackson.databind.JsonNode selectObjectQuery,
                                                                          String objectId)
                                                                   throws InvalidParseOperationException,
                                                                          AccessInternalClientServerException,
                                                                          AccessInternalClientNotFoundException,
                                                                          AccessUnauthorizedException

Retrieve an ObjectGroup as Json data based on the provided ObjectGroup id

Parameters:: selectObjectQuery - the query to be executed; objectId - the Id of the ObjectGroup
Returns:: a response containing a json node object including DSL queries, context and results
Throws:: InvalidParseOperationException - if the query is not well formatted; AccessInternalClientServerException - if the server encountered an exception; AccessInternalClientNotFoundException - if the requested object does not exist; AccessUnauthorizedException

getObject

javax.ws.rs.core.Response getObject(String objectGroupId,
                                    String usage,
                                    int version)
                             throws InvalidParseOperationException,
                                    AccessInternalClientServerException,
                                    AccessInternalClientNotFoundException,
                                    AccessUnauthorizedException

Retrieve an Object data as an input stream

Parameters:: objectGroupId - the Id of the ObjectGroup; usage - the requested usage; version - the requested version of the usage
Returns:: Response containing InputStream for the object data
Throws:: InvalidParseOperationException - if the query is not well formatted; AccessInternalClientServerException - if the server encountered an exception; AccessInternalClientNotFoundException - if the requested object does not exist; AccessUnauthorizedException

selectOperation

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectOperation(com.fasterxml.jackson.databind.JsonNode select)
                                                                  throws LogbookClientException,
                                                                         InvalidParseOperationException,
                                                                         AccessUnauthorizedException,
                                                                         VitamDBException

selectOperation

Parameters:: select -
Returns:: a response containing a json node
Throws:: LogbookClientException; InvalidParseOperationException; AccessUnauthorizedException; VitamDBException

selectOperationById

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectOperationById(String processId,
                                                                             com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                      throws LogbookClientException,
                                                                             InvalidParseOperationException,
                                                                             AccessUnauthorizedException

selectOperationbyId

Parameters:: processId - ID of the operation; queryDsl - query to be executed
Returns:: a response containing a json node
Throws:: LogbookClientException; InvalidParseOperationException; AccessUnauthorizedException

selectUnitLifeCycleById

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectUnitLifeCycleById(String idUnit,
                                                                                 com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                          throws LogbookClientException,
                                                                                 InvalidParseOperationException,
                                                                                 AccessUnauthorizedException

selectUnitLifeCycleById

Parameters:: idUnit -; queryDsl - query to be executed
Returns:: a response containing a json node
Throws:: LogbookClientException; InvalidParseOperationException; AccessUnauthorizedException

selectUnitLifeCycle

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectUnitLifeCycle(com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                      throws LogbookClientException,
                                                                             InvalidParseOperationException,
                                                                             AccessUnauthorizedException

selectUnitLifeCycleById

Parameters:: queryDsl -
Returns:: a response containing a json node
Throws:: LogbookClientException; InvalidParseOperationException; AccessUnauthorizedException

selectObjectGroupLifeCycleById

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectObjectGroupLifeCycleById(String idObject,
                                                                                        com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                                 throws LogbookClientException,
                                                                                        InvalidParseOperationException,
                                                                                        AccessUnauthorizedException

selectObjectGroupLifeCycleById

Parameters:: idObject -; queryDsl - query to be executed
Returns:: a response containing a json node
Throws:: LogbookClientException; InvalidParseOperationException; AccessUnauthorizedException

checkTraceabilityOperation

RequestResponse<com.fasterxml.jackson.databind.JsonNode> checkTraceabilityOperation(com.fasterxml.jackson.databind.JsonNode query)
                                                                             throws LogbookClientServerException,
                                                                                    InvalidParseOperationException,
                                                                                    AccessUnauthorizedException

Checks operation traceability

Parameters:: query - to be executed
Returns:: a response containing a json node
Throws:: LogbookClientServerException; AccessUnauthorizedException; InvalidParseOperationException

downloadTraceabilityFile

javax.ws.rs.core.Response downloadTraceabilityFile(String operationId)
                                            throws AccessInternalClientServerException,
                                                   AccessInternalClientNotFoundException,
                                                   InvalidParseOperationException,
                                                   AccessUnauthorizedException

Parameters:: operationId -
Returns:: a response containing the traceability file
Throws:: AccessUnauthorizedException; AccessInternalClientServerException; AccessInternalClientNotFoundException; InvalidParseOperationException

getUnitByIdWithXMLFormat

javax.ws.rs.core.Response getUnitByIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode queryDsl,
                                                   String idUnit)
                                            throws AccessInternalClientServerException,
                                                   AccessInternalClientNotFoundException,
                                                   AccessUnauthorizedException,
                                                   InvalidParseOperationException

Parameters:: queryDsl -; idUnit -
Returns:: unit with a xml representation
Throws:: AccessInternalClientServerException; AccessInternalClientNotFoundException; AccessUnauthorizedException; InvalidParseOperationException

getObjectByIdWithXMLFormat

javax.ws.rs.core.Response getObjectByIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode queryDsl,
                                                     String objectId)
                                              throws AccessInternalClientServerException,
                                                     AccessInternalClientNotFoundException,
                                                     AccessUnauthorizedException,
                                                     InvalidParseOperationException

Retrieve object group by id with XML format (DIP)

Parameters:: queryDsl - the given query dsl; objectId - the given object group id
Returns:: unit with a xml representation
Throws:: AccessInternalClientServerException; AccessInternalClientNotFoundException; AccessUnauthorizedException; InvalidParseOperationException

getObjectByUnitIdWithXMLFormat

javax.ws.rs.core.Response getObjectByUnitIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode queryDsl,
                                                         String unitId)
                                                  throws AccessInternalClientServerException,
                                                         AccessInternalClientNotFoundException,
                                                         AccessUnauthorizedException,
                                                         InvalidParseOperationException

Retrieve object group by unit id with XML format (DIP)

Parameters:: queryDsl - the given query dsl; unitId - the given object group id
Returns:: unit with a xml representation
Throws:: AccessInternalClientServerException; AccessInternalClientNotFoundException; AccessUnauthorizedException; InvalidParseOperationException

exportDIP

RequestResponse<com.fasterxml.jackson.databind.JsonNode> exportDIP(com.fasterxml.jackson.databind.JsonNode queryJson)
                                                            throws AccessInternalClientServerException

launch a DIP operation by a DSL query

Parameters:: queryJson - query for the DIP creation
Returns:
Throws:: AccessInternalClientServerException

findDIPByID
```
javax.ws.rs.core.Response findDIPByID(String id)
                               throws AccessInternalClientServerException
```
get a zip file containing a DIP by an operation id

Parameters:

id - operationId

Returns:

stream containing zip file

Throws:

AccessInternalClientServerException

Interface AccessInternalClient

Method Summary

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

Method Detail

selectUnits

selectUnitbyId

updateUnitbyId

selectObjectbyId

getObject

selectOperation

selectOperationById

selectUnitLifeCycleById

selectUnitLifeCycle

selectObjectGroupLifeCycleById

checkTraceabilityOperation

downloadTraceabilityFile

getUnitByIdWithXMLFormat

getObjectByIdWithXMLFormat

getObjectByUnitIdWithXMLFormat

exportDIP

findDIPByID