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

Interface AccessInternalResource

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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
      javax.ws.rs.core.Response checkAccessRequestStatuses​(javax.ws.rs.core.HttpHeaders headers, java.util.List<AccessRequestReference> accessRequestReferences)  
      javax.ws.rs.core.Response createObjectAccessRequestIfRequired​(javax.ws.rs.core.HttpHeaders headers, java.lang.String idObjectGroup)  
      javax.ws.rs.core.Response exportByUsageFilter​(ExportRequest exportRequest)  
      javax.ws.rs.core.Response exportDIP​(com.fasterxml.jackson.databind.JsonNode dslRequest)  
      javax.ws.rs.core.Response findDIPByID​(java.lang.String id)  
      javax.ws.rs.core.Response findTransferSIPByID​(java.lang.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, java.lang.String objectId)
      gets object group by Id with Json query
      javax.ws.rs.core.Response getObjectByUnitIdWithXMLFormat​(com.fasterxml.jackson.databind.JsonNode dslQuery, java.lang.String unitId)
      gets object group by Id with Json query
      javax.ws.rs.core.Response getObjectGroup​(java.lang.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, java.lang.String idObjectGroup, java.lang.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, java.lang.String unitId)
      gets archive units by Id with Json query
      javax.ws.rs.core.Response getUnitByIdWithXMLFormat​(com.fasterxml.jackson.databind.JsonNode dslQuery, java.lang.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 removeAccessRequest​(javax.ws.rs.core.HttpHeaders headers, AccessRequestReference accessRequestReference)  
      javax.ws.rs.core.Response revertUpdateUnits​(RevertUpdateOptions revertUpdateOptions)
      gets objects group with Json query Revert an update of archive units
      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 streamUnits​(com.fasterxml.jackson.databind.JsonNode queryDsl)  
      javax.ws.rs.core.Response transferReply​(java.io.InputStream transferReply)  
      javax.ws.rs.core.Response updateUnitById​(com.fasterxml.jackson.databind.JsonNode dslQuery, java.lang.String unitId, java.lang.String requestId)
      update archive units by Id with Json query

    • Method Detail

      • streamUnits

        javax.ws.rs.core.Response streamUnits​(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​(java.lang.String id)
        Parameters:
        id - of operation (X-Request-Id)
        Returns:

      • findTransferSIPByID

        javax.ws.rs.core.Response findTransferSIPByID​(java.lang.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,
                                      java.lang.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,
                                                   java.lang.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,
                                                     java.lang.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,
                                                         java.lang.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,
                                         java.lang.String unitId,
                                         java.lang.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​(java.lang.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,
                                               java.lang.String idObjectGroup,
                                               java.lang.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,
                                                              java.lang.String idObjectGroup)

      • checkAccessRequestStatuses

        javax.ws.rs.core.Response checkAccessRequestStatuses​(javax.ws.rs.core.HttpHeaders headers,
                                                     java.util.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

      • transferReply

        javax.ws.rs.core.Response transferReply​(java.io.InputStream transferReply)