Interface AccessInternalResource
- All Known Implementing Classes:
AccessInternalResourceImpl
public interface AccessInternalResource
Access Resource REST API
-
Method Summary
Modifier and TypeMethodDescriptionjavax.ws.rs.core.ResponsebulkAtomicUpdateUnits(com.fasterxml.jackson.databind.JsonNode query) Bulk Atomic update of archive units with Json request containing multiple atomic update queriesjavax.ws.rs.core.ResponsecheckAccessRequestStatuses(javax.ws.rs.core.HttpHeaders headers, List<AccessRequestReference> accessRequestReferences) javax.ws.rs.core.ResponsecreateObjectAccessRequestIfRequired(javax.ws.rs.core.HttpHeaders headers, String idObjectGroup) javax.ws.rs.core.ResponsedownloadObjectByPersistentIdentifier(String persistentId) javax.ws.rs.core.ResponsedownloadObjectsByUnitPersistentIdentifier(String persistentIdentifier, String qualifier, Integer version) javax.ws.rs.core.ResponseexportByUsageFilter(ExportRequest exportRequest) javax.ws.rs.core.ResponseexportDIP(com.fasterxml.jackson.databind.JsonNode dslRequest) javax.ws.rs.core.ResponsefindDIPByID(String id) javax.ws.rs.core.Responsejavax.ws.rs.core.ResponsegetAccessLogStreamAsync(javax.ws.rs.core.HttpHeaders headers, com.fasterxml.jackson.databind.JsonNode params) gets accesslog file by id as an InputStreamjavax.ws.rs.core.ResponsegetObjectGroup(String idObjectGroup, com.fasterxml.jackson.databind.JsonNode query) Retrieve an ObjectGroup by its idjavax.ws.rs.core.ResponsegetObjects(com.fasterxml.jackson.databind.JsonNode dslQuery) gets objects group with Json queryjavax.ws.rs.core.ResponsegetObjectsByObjectPersistentIdentifier(String persistentIdentifier, com.fasterxml.jackson.databind.JsonNode selectQuery) javax.ws.rs.core.ResponsegetObjectStreamAsync(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.ResponsegetUnitById(com.fasterxml.jackson.databind.JsonNode dslQuery, String unitId) gets archive units by Id with Json queryjavax.ws.rs.core.ResponsegetUnits(com.fasterxml.jackson.databind.JsonNode dslQuery) gets archive units with Json queryjavax.ws.rs.core.ResponsegetUnitsByUnitPersistentIdentifier(String persistentIdentifier, com.fasterxml.jackson.databind.JsonNode selectQuery) javax.ws.rs.core.ResponsemassUpdateUnits(com.fasterxml.jackson.databind.JsonNode dslQuery) Mass update of archive units with Json queryjavax.ws.rs.core.ResponsemassUpdateUnitsRules(MassUpdateUnitRuleRequest massUpdateUnitRuleRequest) Mass update of archive units rulesjavax.ws.rs.core.ResponseremoveAccessRequest(javax.ws.rs.core.HttpHeaders headers, AccessRequestReference accessRequestReference) javax.ws.rs.core.ResponserevertUpdateUnits(RevertUpdateOptions revertUpdateOptions) gets objects group with Json query Revert an update of archive unitsjavax.ws.rs.core.ResponseselectUnitsWithInheritedRules(com.fasterxml.jackson.databind.JsonNode queryDsl) javax.ws.rs.core.ResponsestartEliminationActionWorkflow(EliminationRequestBody eliminationRequestBody) Starts elimination action workflow.javax.ws.rs.core.ResponsestartEliminationAnalysisWorkflow(EliminationRequestBody eliminationRequestBody) Starts elimination analysis workflow.javax.ws.rs.core.ResponsestartReclassificationWorkflow(com.fasterxml.jackson.databind.JsonNode reclassificationRequest) Starts a reclassification workflow.javax.ws.rs.core.ResponsestreamObjects(com.fasterxml.jackson.databind.JsonNode queryDsl) javax.ws.rs.core.ResponsestreamUnits(com.fasterxml.jackson.databind.JsonNode queryDsl) javax.ws.rs.core.ResponsetransferReply(InputStream transferReply) javax.ws.rs.core.ResponseupdateUnitById(com.fasterxml.jackson.databind.JsonNode dslQuery, String unitId, String requestId) update archive units by Id with Json query
-
Method Details
-
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:
MetaDataDocumentSizeExceptionMetaDataExecutionExceptionMetaDataClientServerException
-
getUnitsByUnitPersistentIdentifier
javax.ws.rs.core.Response getUnitsByUnitPersistentIdentifier(String persistentIdentifier, com.fasterxml.jackson.databind.JsonNode selectQuery) -
downloadObjectsByUnitPersistentIdentifier
-
getObjectsByObjectPersistentIdentifier
javax.ws.rs.core.Response getObjectsByObjectPersistentIdentifier(String persistentIdentifier, com.fasterxml.jackson.databind.JsonNode selectQuery) -
downloadObjectByPersistentIdentifier
javax.ws.rs.core.Response downloadObjectByPersistentIdentifier(String persistentId) throws Exception - Throws:
Exception
-
streamUnits
javax.ws.rs.core.Response streamUnits(com.fasterxml.jackson.databind.JsonNode queryDsl) -
streamObjects
javax.ws.rs.core.Response streamObjects(com.fasterxml.jackson.databind.JsonNode queryDsl) -
selectUnitsWithInheritedRules
javax.ws.rs.core.Response selectUnitsWithInheritedRules(com.fasterxml.jackson.databind.JsonNode queryDsl) -
exportDIP
javax.ws.rs.core.Response exportDIP(com.fasterxml.jackson.databind.JsonNode dslRequest) - Parameters:
dslRequest-- Returns:
-
exportByUsageFilter
- Parameters:
exportRequest-- Returns:
-
findDIPByID
- Parameters:
id- of operation (X-Request-Id)- Returns:
-
findTransferSIPByID
- 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 allowedunitId- units identifier- Returns:
- a archive unit result list on json 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 allowedunitId- units identifierrequestId- 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 idquery- 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
-
createObjectAccessRequestIfRequired
javax.ws.rs.core.Response createObjectAccessRequestIfRequired(javax.ws.rs.core.HttpHeaders headers, String idObjectGroup) -
checkAccessRequestStatuses
javax.ws.rs.core.Response checkAccessRequestStatuses(javax.ws.rs.core.HttpHeaders headers, List<AccessRequestReference> accessRequestReferences) -
removeAccessRequest
javax.ws.rs.core.Response removeAccessRequest(javax.ws.rs.core.HttpHeaders headers, AccessRequestReference accessRequestReference) -
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 headersparams- 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
Mass update of archive units rules- Parameters:
massUpdateUnitRuleRequest- wrapper for {DSL, RuleActions}, null not allowed- Returns:
- the response
-
bulkAtomicUpdateUnits
javax.ws.rs.core.Response bulkAtomicUpdateUnits(com.fasterxml.jackson.databind.JsonNode query) Bulk Atomic update of archive units with Json request containing multiple atomic update queries- Parameters:
dslQuery- DSL, null not allowed- Returns:
- the response
-
revertUpdateUnits
gets objects group with Json query Revert an update of archive units- Parameters:
revertUpdateOptions- wrapper for {DSL, operationId}, 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:
MetaDataDocumentSizeExceptionMetaDataExecutionExceptionMetaDataClientServerException
-
transferReply
-