Package fr.gouv.vitam.access.internal.api

Interface AccessInternalResource

All Known Implementing Classes:
AccessInternalResourceImpl
public interface AccessInternalResource
Access Resource REST API

  • 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:
      MetaDataDocumentSizeException
      MetaDataExecutionException
      MetaDataClientServerException

    • getUnitsByUnitPersistentIdentifier

      javax.ws.rs.core.Response getUnitsByUnitPersistentIdentifier(String persistentIdentifier, com.fasterxml.jackson.databind.JsonNode selectQuery)

    • downloadObjectsByUnitPersistentIdentifier

      javax.ws.rs.core.Response downloadObjectsByUnitPersistentIdentifier(String persistentIdentifier, String qualifier, Integer version)

    • 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

      javax.ws.rs.core.Response exportByUsageFilter(ExportRequest exportRequest)
      Parameters:
      exportRequest -
      Returns:

    • findDIPByID

      javax.ws.rs.core.Response findDIPByID(String id)
      Parameters:
      id - of operation (X-Request-Id)
      Returns:

    • findTransferSIPByID

      javax.ws.rs.core.Response findTransferSIPByID(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

    • 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

    • 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 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

    • 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

      javax.ws.rs.core.Response revertUpdateUnits(RevertUpdateOptions revertUpdateOptions)
      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:
      MetaDataDocumentSizeException
      MetaDataExecutionException
      MetaDataClientServerException

    • transferReply

      javax.ws.rs.core.Response transferReply(InputStream transferReply)