Class AccessExternalResource

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response deleteComputeInheritedRules​(com.fasterxml.jackson.databind.JsonNode dslQuery)  
      javax.ws.rs.core.Response exportDIP​(com.fasterxml.jackson.databind.JsonNode queryJson)
      get units list by query
      javax.ws.rs.core.Response findExportByID​(java.lang.String id)
      get units list by query
      javax.ws.rs.core.Response findTransferByID​(java.lang.String id)  
      javax.ws.rs.core.Response getAccessLog​(com.fasterxml.jackson.databind.JsonNode params)  
      javax.ws.rs.core.Response getDataObjectByUnitId​(javax.ws.rs.core.HttpHeaders headers, java.lang.String unitId)
      The caller is responsible to close the Response after consuming the inputStream.
      javax.ws.rs.core.Response getObjectGroupMetadataByUnitId​(javax.ws.rs.core.HttpHeaders headers, java.lang.String unitId, com.fasterxml.jackson.databind.JsonNode queryJson)
      Retrieve Object group list by query based on identifier of the unit
      javax.ws.rs.core.Response getObjects​(com.fasterxml.jackson.databind.JsonNode queryJson)
      get Objects group list based on DSL query
      javax.ws.rs.core.Response getUnitById​(com.fasterxml.jackson.databind.JsonNode queryJson, java.lang.String idUnit)
      get units list by query based on identifier
      javax.ws.rs.core.Response getUnits​(com.fasterxml.jackson.databind.JsonNode queryJson)
      get a DIP by dsl query
      javax.ws.rs.core.Response listResourceEndpoints()
      List secured resource end points
      javax.ws.rs.core.Response massUpdateUnits​(com.fasterxml.jackson.databind.JsonNode queryJson)
      Mass update of archive units with json query.
      javax.ws.rs.core.Response massUpdateUnitsRules​(MassUpdateUnitRuleRequest massUpdateUnitRuleRequest)
      Mass update of archive units rules with json request.
      javax.ws.rs.core.Response reclassification​(com.fasterxml.jackson.databind.JsonNode queryJson)
      Performs a reclassification workflow.
      javax.ws.rs.core.Response selectUnitsWithInheritedRules​(com.fasterxml.jackson.databind.JsonNode queryJson)
      Select units with inherited rules
      javax.ws.rs.core.Response startComputeInheritedRules​(com.fasterxml.jackson.databind.JsonNode dslQuery)  
      javax.ws.rs.core.Response startEliminationAction​(EliminationRequestBody eliminationRequestBody)
      Performs an elimination action workflow.
      javax.ws.rs.core.Response startEliminationAnalysis​(EliminationRequestBody eliminationRequestBody)
      Performs an elimination analysis workflow.
      javax.ws.rs.core.Response startPreservation​(PreservationRequest preservationRequest)  
      javax.ws.rs.core.Response transfer​(TransferRequest transferRequest)  
      javax.ws.rs.core.Response transferReply​(java.io.InputStream transferReply)  
      javax.ws.rs.core.Response updateUnitById​(com.fasterxml.jackson.databind.JsonNode queryJson, java.lang.String idUnit)
      update archive units by Id with Json query
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • listResourceEndpoints

        @Path("/")
        @OPTIONS
        @Produces("application/json")
        public javax.ws.rs.core.Response listResourceEndpoints()
        List secured resource end points
        Returns:
        response
      • getUnits

        @GET
        @Path("/units")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response getUnits​(com.fasterxml.jackson.databind.JsonNode queryJson)
        get a DIP by dsl query
        Parameters:
        queryJson - the query to get units
        Returns:
        Response
      • exportDIP

        @POST
        @Path("/dipexport")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response exportDIP​(com.fasterxml.jackson.databind.JsonNode queryJson)
        get units list by query
        Parameters:
        queryJson - the query to get units
        Returns:
        Response
      • transfer

        @POST
        @Path("/transfers")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response transfer​(TransferRequest transferRequest)
      • transferReply

        @POST
        @Path("/transfers/reply")
        @Consumes("application/xml")
        @Produces("application/json")
        public javax.ws.rs.core.Response transferReply​(java.io.InputStream transferReply)
      • findTransferByID

        @GET
        @Path("/transfers/{id}/sip")
        @Produces("application/octet-stream")
        public javax.ws.rs.core.Response findTransferByID​(@PathParam("id")
                                                          java.lang.String id)
      • reclassification

        @POST
        @Path("/reclassification")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response reclassification​(com.fasterxml.jackson.databind.JsonNode queryJson)
        Performs a reclassification workflow.
        Parameters:
        queryJson - List of reclassification DSL queries.
        Returns:
        Response
      • startEliminationAnalysis

        @POST
        @Path("/elimination/analysis")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response startEliminationAnalysis​(EliminationRequestBody eliminationRequestBody)
        Performs an elimination analysis workflow.
        Parameters:
        eliminationRequestBody - object that contain dsl request and a given date.
        Returns:
        Response
      • startEliminationAction

        @POST
        @Path("/elimination/action")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response startEliminationAction​(EliminationRequestBody eliminationRequestBody)
        Performs an elimination action workflow.
        Parameters:
        eliminationRequestBody - object that contain dsl request and a given date.
        Returns:
        Response
      • findExportByID

        @GET
        @Path("/dipexport/{id}/dip")
        @Produces("application/octet-stream")
        public javax.ws.rs.core.Response findExportByID​(@PathParam("id")
                                                        java.lang.String id)
        get units list by query
        Parameters:
        id - operationId correponding to the current dip
        Returns:
        Response
      • getUnitById

        @GET
        @Path("/units/{idu}")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response getUnitById​(com.fasterxml.jackson.databind.JsonNode queryJson,
                                                     @PathParam("idu")
                                                     java.lang.String idUnit)
        get units list by query based on identifier
        Parameters:
        queryJson - query as String
        idUnit - the id of archive unit to get
        Returns:
        Archive Unit
      • updateUnitById

        @PUT
        @Path("/units/{idu}")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response updateUnitById​(com.fasterxml.jackson.databind.JsonNode queryJson,
                                                        @PathParam("idu")
                                                        java.lang.String idUnit)
        update archive units by Id with Json query
        Parameters:
        queryJson - the update query (null not allowed)
        idUnit - units identifier
        Returns:
        a archive unit result list
      • getObjectGroupMetadataByUnitId

        @GET
        @Path("/units/{idu}/objects")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response getObjectGroupMetadataByUnitId​(@Context
                                                                        javax.ws.rs.core.HttpHeaders headers,
                                                                        @PathParam("idu")
                                                                        java.lang.String unitId,
                                                                        com.fasterxml.jackson.databind.JsonNode queryJson)
        Retrieve Object group list by query based on identifier of the unit
        Parameters:
        headers - the http header defined parameters of request
        unitId - the id of archive unit
        queryJson - the query to get object
        Returns:
        Response
      • getDataObjectByUnitId

        @GET
        @Path("/units/{idu}/objects")
        @Consumes("application/json")
        @Produces("application/octet-stream")
        public javax.ws.rs.core.Response getDataObjectByUnitId​(@Context
                                                               javax.ws.rs.core.HttpHeaders headers,
                                                               @PathParam("idu")
                                                               java.lang.String unitId)
        The caller is responsible to close the Response after consuming the inputStream.
        Parameters:
        headers - the http header defined parameters of request
        unitId - the id of archive unit
        Returns:
        response
      • massUpdateUnits

        @POST
        @Path("/units")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response massUpdateUnits​(com.fasterxml.jackson.databind.JsonNode queryJson)
        Mass update of archive units with json query.
        Parameters:
        queryJson - the mass_update query (null not allowed)
        Returns:
      • massUpdateUnitsRules

        @POST
        @Path("/units/rules")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response massUpdateUnitsRules​(MassUpdateUnitRuleRequest massUpdateUnitRuleRequest)
        Mass update of archive units rules with json request.
        Parameters:
        massUpdateUnitRuleRequest - the mass update rules request (null not allowed)
        Returns:
      • startComputeInheritedRules

        @Path("/units/computedInheritedRules")
        @POST
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response startComputeInheritedRules​(com.fasterxml.jackson.databind.JsonNode dslQuery)
      • deleteComputeInheritedRules

        @Path("/units/computedInheritedRules")
        @DELETE
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response deleteComputeInheritedRules​(com.fasterxml.jackson.databind.JsonNode dslQuery)
      • selectUnitsWithInheritedRules

        @GET
        @Path("/unitsWithInheritedRules")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response selectUnitsWithInheritedRules​(com.fasterxml.jackson.databind.JsonNode queryJson)
        Select units with inherited rules
        Parameters:
        queryJson - the query to get units
        Returns:
        Response
      • getObjects

        @GET
        @Path("/objects")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response getObjects​(com.fasterxml.jackson.databind.JsonNode queryJson)
        get Objects group list based on DSL query
        Parameters:
        queryJson - the query to get units
        Returns:
        Response
      • getAccessLog

        @Path("/storageaccesslog")
        @GET
        @Consumes("application/json")
        @Produces("application/octet-stream")
        public javax.ws.rs.core.Response getAccessLog​(com.fasterxml.jackson.databind.JsonNode params)
      • startPreservation

        @Path("/preservation")
        @POST
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response startPreservation​(PreservationRequest preservationRequest)