AccessInternalResource (Vitam API Reference (1.0.0))

All Superinterfaces:

VitamResource

All Known Implementing Classes:

AccessInternalResourceImpl
```
public interface AccessInternalResource
extends VitamResource
```
Access Resource REST API

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`exportDIP(com.fasterxml.jackson.databind.JsonNode queryDsl)`
`javax.ws.rs.core.Response`	`findDIPByID(String id)`
`javax.ws.rs.core.Response`	`getObjectByIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode dslQuery, String objectId)` gets object group by Id with Json query
`javax.ws.rs.core.Response`	`getObjectByUnitIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode dslQuery, String unitId)` gets object group by Id with Json query
`javax.ws.rs.core.Response`	`getObjectGroup(String idObjectGroup, com.fasterxml.jackson.databind.JsonNode query)` Retrieve an ObjectGroup by its id
`javax.ws.rs.core.Response`	`getObjectStreamAsync(javax.ws.rs.core.HttpHeaders headers, String idObjectGroup)` Retrieve an Object associated to the given ObjectGroup id based on given (via headers) Qualifier and Version (Async version)
`javax.ws.rs.core.Response`	`getUnitById(com.fasterxml.jackson.databind.JsonNode dslQuery, String unitId)` gets archive units by Id with Json query
`javax.ws.rs.core.Response`	`getUnitByIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode dslQuery, String unitId)` gets archive units by Id with Json query
`javax.ws.rs.core.Response`	`getUnits(com.fasterxml.jackson.databind.JsonNode dslQuery)` gets archive units with Json query
`javax.ws.rs.core.Response`	`updateUnitById(com.fasterxml.jackson.databind.JsonNode dslQuery, String unitId, String requestId)` update archive units by Id with Json query

Method Detail

getUnits

javax.ws.rs.core.Response getUnits(com.fasterxml.jackson.databind.JsonNode dslQuery)
                            throws MetaDataDocumentSizeException,
                                   MetaDataExecutionException,
                                   MetaDataClientServerException

gets archive units with Json query

Parameters:: dslQuery - null not allowed
Returns:: a archive unit result list
Throws:: MetaDataDocumentSizeException; MetaDataExecutionException; MetaDataClientServerException

exportDIP

javax.ws.rs.core.Response exportDIP(com.fasterxml.jackson.databind.JsonNode queryDsl)

Parameters:: queryDsl -
Returns:

findDIPByID
```
javax.ws.rs.core.Response findDIPByID(String id)
```
Parameters:

id - of operation (X-Request-Id)

Returns:

getUnitById

javax.ws.rs.core.Response getUnitById(com.fasterxml.jackson.databind.JsonNode dslQuery,
                                      String unitId)

gets archive units by Id with Json query

Parameters:: dslQuery - DSL, null not allowed; unitId - units identifier
Returns:: a archive unit result list on json format

getUnitByIdWithXMLFormat

javax.ws.rs.core.Response getUnitByIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode dslQuery,
                                                   String unitId)

gets archive units by Id with Json query

Parameters:: dslQuery - DSL, null not allowed; unitId - units identifier
Returns:: a archive unit result list on xml format

getObjectByIdWithXMLFormat

javax.ws.rs.core.Response getObjectByIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode dslQuery,
                                                     String objectId)

gets object group by Id with Json query

Parameters:: dslQuery - DSL, null not allowed; objectId - units identifier
Returns:: an object group result list on xml format

getObjectByUnitIdWithXMLFormat

javax.ws.rs.core.Response getObjectByUnitIdWithXMLFormat(com.fasterxml.jackson.databind.JsonNode dslQuery,
                                                         String unitId)

gets object group by Id with Json query

Parameters:: dslQuery - DSL, null not allowed; unitId - units identifier
Returns:: an object group result list on xml format

updateUnitById

javax.ws.rs.core.Response updateUnitById(com.fasterxml.jackson.databind.JsonNode dslQuery,
                                         String unitId,
                                         String requestId)

update archive units by Id with Json query

Parameters:: dslQuery - DSK, null not allowed; unitId - units identifier; requestId - request identifier
Returns:: a archive unit result list

getObjectGroup
```
javax.ws.rs.core.Response getObjectGroup(String idObjectGroup,
                                         com.fasterxml.jackson.databind.JsonNode query)
```
Retrieve an ObjectGroup by its id

Parameters:

idObjectGroup - the ObjectGroup id

query - the json query

Returns:

an http response containing the objectGroup as json or a json serialized error

getObjectStreamAsync

javax.ws.rs.core.Response getObjectStreamAsync(@Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @PathParam(value="id_object_group")
                                               String idObjectGroup)

Retrieve an Object associated to the given ObjectGroup id based on given (via headers) Qualifier and Version (Async version)

Parameters:: headers -; idObjectGroup -
Returns:: response

Interface AccessInternalResource