Class TransactionExternalResource

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response abortTransaction​(java.lang.String transactionId)  
      javax.ws.rs.core.Response bulkAtomicUpdateUnits​(java.lang.String transactionId, com.fasterxml.jackson.databind.JsonNode updateQueriesJson)
      Bulk atomic update of archive units with json queries of the provided collect transaction.
      javax.ws.rs.core.Response closeTransaction​(java.lang.String transactionId)  
      javax.ws.rs.core.Response deleteTransactionById​(java.lang.String transactionId)  
      javax.ws.rs.core.Response generateAndSendSip​(java.lang.String transactionId)  
      javax.ws.rs.core.Response getTransactionById​(java.lang.String transactionId)  
      javax.ws.rs.core.Response reopenTransaction​(java.lang.String transactionId)  
      javax.ws.rs.core.Response selectUnits​(java.lang.String transactionId, com.fasterxml.jackson.databind.JsonNode jsonQuery)
      select Unit
      javax.ws.rs.core.Response selectUnitsWithInheritedRules​(java.lang.String transactionId, com.fasterxml.jackson.databind.JsonNode queryJson)  
      javax.ws.rs.core.Response updateTransaction​(TransactionDto transactionDto)  
      javax.ws.rs.core.Response updateUnits​(java.lang.String transactionId, java.io.InputStream inputStream)
      Deprecated, for removal: This API element is subject to removal in a future version.
      javax.ws.rs.core.Response updateUnitsWithMetadataCsv​(java.lang.String transactionId, java.io.InputStream metadataCsvInputStream)  
      javax.ws.rs.core.Response updateUnitsWithMetadataJsonl​(java.lang.String transactionId, java.io.InputStream metadataJsonlInputStream)  
      javax.ws.rs.core.Response uploadArchiveUnit​(java.lang.String transactionId, com.fasterxml.jackson.databind.JsonNode unitJsonNode)  
      javax.ws.rs.core.Response uploadTransactionZip​(java.lang.String transactionId, java.io.InputStream inputStreamObject, java.lang.String encoding)  
      • Methods inherited from class java.lang.Object

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

      • ERROR_WHEN_UPDATE_TRANSACTION__

        public static final java.lang.String ERROR_WHEN_UPDATE_TRANSACTION__
        See Also:
        Constant Field Values
    • Method Detail

      • getTransactionById

        @Path("/{transactionId}")
        @GET
        @Produces("application/json")
        public javax.ws.rs.core.Response getTransactionById​(@PathParam("transactionId")
                                                            java.lang.String transactionId)
      • updateTransaction

        @PUT
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response updateTransaction​(TransactionDto transactionDto)
      • deleteTransactionById

        @Path("/{transactionId}")
        @DELETE
        @Produces("application/json")
        public javax.ws.rs.core.Response deleteTransactionById​(@PathParam("transactionId")
                                                               java.lang.String transactionId)
      • uploadArchiveUnit

        @Path("/{transactionId}/units")
        @POST
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response uploadArchiveUnit​(@PathParam("transactionId")
                                                           java.lang.String transactionId,
                                                           com.fasterxml.jackson.databind.JsonNode unitJsonNode)
      • selectUnits

        @Path("/{transactionId}/units")
        @GET
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response selectUnits​(@PathParam("transactionId")
                                                     java.lang.String transactionId,
                                                     com.fasterxml.jackson.databind.JsonNode jsonQuery)
        select Unit
        Parameters:
        jsonQuery - as String { $query : query}
      • closeTransaction

        @Path("/{transactionId}/close")
        @POST
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response closeTransaction​(@PathParam("transactionId")
                                                          java.lang.String transactionId)
      • abortTransaction

        @Path("/{transactionId}/abort")
        @PUT
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response abortTransaction​(@PathParam("transactionId")
                                                          java.lang.String transactionId)
      • reopenTransaction

        @Path("/{transactionId}/reopen")
        @PUT
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response reopenTransaction​(@PathParam("transactionId")
                                                           java.lang.String transactionId)
      • generateAndSendSip

        @Path("/{transactionId}/send")
        @POST
        @Consumes("application/json")
        public javax.ws.rs.core.Response generateAndSendSip​(@PathParam("transactionId")
                                                            java.lang.String transactionId)
      • updateUnits

        @Path("/{transactionId}/units")
        @PUT
        @Consumes("application/octet-stream")
        @Produces("application/json")
        @Deprecated(forRemoval=true,
                    since="Vitam 7.1")
        public javax.ws.rs.core.Response updateUnits​(@PathParam("transactionId")
                                                     java.lang.String transactionId,
                                                     java.io.InputStream inputStream)
        Deprecated, for removal: This API element is subject to removal in a future version.
      • updateUnitsWithMetadataCsv

        @Path("/{transactionId}/units/metadata/csv")
        @PUT
        @Consumes("text/csv")
        @Produces("application/json")
        public javax.ws.rs.core.Response updateUnitsWithMetadataCsv​(@PathParam("transactionId")
                                                                    java.lang.String transactionId,
                                                                    java.io.InputStream metadataCsvInputStream)
      • updateUnitsWithMetadataJsonl

        @Path("/{transactionId}/units/metadata/jsonl")
        @PUT
        @Consumes("application/octet-stream")
        @Produces("application/json")
        public javax.ws.rs.core.Response updateUnitsWithMetadataJsonl​(@PathParam("transactionId")
                                                                      java.lang.String transactionId,
                                                                      java.io.InputStream metadataJsonlInputStream)
      • bulkAtomicUpdateUnits

        @POST
        @Path("/{transactionId}/units/bulk")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response bulkAtomicUpdateUnits​(@PathParam("transactionId")
                                                               java.lang.String transactionId,
                                                               com.fasterxml.jackson.databind.JsonNode updateQueriesJson)
        Bulk atomic update of archive units with json queries of the provided collect transaction.
        Units are update in blocking mode (might take a few moments to proceed before returning). Please ensure proper request size / timeout is configured.
        Parameters:
        updateQueriesJson - the bulk update queries (null not allowed)
        Returns:
        HTTP 202 when request is accepted, 400 on BAD REQUEST, 500 on internal server error
      • uploadTransactionZip

        @Path("/{transactionId}/upload")
        @POST
        @Consumes("application/zip")
        @Produces("application/json")
        public javax.ws.rs.core.Response uploadTransactionZip​(@PathParam("transactionId")
                                                              java.lang.String transactionId,
                                                              java.io.InputStream inputStreamObject,
                                                              @HeaderParam("X-Encoding") @Nullable
                                                              java.lang.String encoding)
      • selectUnitsWithInheritedRules

        @Path("/{transactionId}/unitsWithInheritedRules")
        @GET
        @Produces("application/json")
        public javax.ws.rs.core.Response selectUnitsWithInheritedRules​(@PathParam("transactionId")
                                                                       java.lang.String transactionId,
                                                                       com.fasterxml.jackson.databind.JsonNode queryJson)