fr.gouv.vitam.access.internal.api

Interface AccessInternalResource

All Superinterfaces:

VitamResource

All Known Implementing Classes:

AccessInternalResourceImpl

public interface AccessInternalResource
extends VitamResource

Access Resource REST API

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exportDIP(DipExportRequest dipExportRequest)
javax.ws.rs.core.Response	findDIPByID(String id)
javax.ws.rs.core.Response	getAccessLogStreamAsync(javax.ws.rs.core.HttpHeaders headers, com.fasterxml.jackson.databind.JsonNode params) gets accesslog file by id as an InputStream
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	getObjects(com.fasterxml.jackson.databind.JsonNode dslQuery) gets objects group with Json query
javax.ws.rs.core.Response	getObjectStreamAsync(javax.ws.rs.core.HttpHeaders headers, String idObjectGroup, String idUnit) 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	massUpdateUnits(com.fasterxml.jackson.databind.JsonNode dslQuery) Mass update of archive units with Json query
javax.ws.rs.core.Response	massUpdateUnitsRules(MassUpdateUnitRuleRequest massUpdateUnitRuleRequest) Mass update of archive units rules
javax.ws.rs.core.Response	selectUnitsWithInheritedRules(com.fasterxml.jackson.databind.JsonNode queryDsl)
javax.ws.rs.core.Response	startEliminationActionWorkflow(EliminationRequestBody eliminationRequestBody) Starts elimination action workflow.
javax.ws.rs.core.Response	startEliminationAnalysisWorkflow(EliminationRequestBody eliminationRequestBody) Starts elimination analysis workflow.
javax.ws.rs.core.Response	startReclassificationWorkflow(com.fasterxml.jackson.databind.JsonNode reclassificationRequest) Starts a reclassification workflow.
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

selectUnitsWithInheritedRules

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

exportDIP

javax.ws.rs.core.Response exportDIP(DipExportRequest dipExportRequest)

Parameters:

dipExportRequest -

Returns:

findDIPByID

javax.ws.rs.core.Response findDIPByID(String id)

Parameters:

id - of operation (X-Request-Id)

Returns:

startReclassificationWorkflow

javax.ws.rs.core.Response startReclassificationWorkflow(com.fasterxml.jackson.databind.JsonNode reclassificationRequest)

Starts a reclassification workflow.

Parameters:

reclassificationRequest - Reclassification request.

Returns:

response

startEliminationAnalysisWorkflow

javax.ws.rs.core.Response startEliminationAnalysisWorkflow(EliminationRequestBody eliminationRequestBody)

Starts elimination analysis workflow.

Parameters:

eliminationRequestBody - elimination DSL request

Returns:

response

startEliminationActionWorkflow

javax.ws.rs.core.Response startEliminationActionWorkflow(EliminationRequestBody eliminationRequestBody)

Starts elimination action workflow.

Parameters:

eliminationRequestBody - elimination DSL request

Returns:

response

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 - DSL, 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(javax.ws.rs.core.HttpHeaders headers,
                                               String idObjectGroup,
                                               String idUnit)

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

Parameters:

headers -

idObjectGroup -

Returns:

response

getAccessLogStreamAsync

javax.ws.rs.core.Response getAccessLogStreamAsync(javax.ws.rs.core.HttpHeaders headers,
                                                  com.fasterxml.jackson.databind.JsonNode params)

gets accesslog file by id as an InputStream

Parameters:

headers - request headers

params - given params in order to filter accessLog files

Returns:

massUpdateUnits

javax.ws.rs.core.Response massUpdateUnits(com.fasterxml.jackson.databind.JsonNode dslQuery)

Mass update of archive units with Json query

Parameters:

dslQuery - DSL, null not allowed

Returns:

the response

massUpdateUnitsRules

javax.ws.rs.core.Response massUpdateUnitsRules(MassUpdateUnitRuleRequest massUpdateUnitRuleRequest)

Mass update of archive units rules

Parameters:

massUpdateUnitRuleRequest - wrapper for {DSL, RuleActions}, null not allowed

Returns:

the response

getObjects

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

gets objects group with Json query

Parameters:

dslQuery - null not allowed

Returns:

a objects group result list

Throws:

MetaDataDocumentSizeException

MetaDataExecutionException

MetaDataClientServerException