Package fr.gouv.vitam.collect.external.external.rest

Class TransactionExternalResource

java.lang.Object

fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

fr.gouv.vitam.collect.external.external.rest.TransactionExternalResource

@Path("/collect-external/v1/transactions")
public class TransactionExternalResource
extends ApplicationStatusResource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_WHEN_UPDATE_TRANSACTION__

Fields inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

STATUS_URL, TENANTS_URL

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	abortTransaction(String transactionId)
javax.ws.rs.core.Response	bulkAtomicUpdateUnits(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(String transactionId)
javax.ws.rs.core.Response	deleteTransactionById(String transactionId)
javax.ws.rs.core.Response	generateAndSendSip(String transactionId)
javax.ws.rs.core.Response	getTransactionById(String transactionId)
javax.ws.rs.core.Response	reopenTransaction(String transactionId)
javax.ws.rs.core.Response	selectUnits(String transactionId, com.fasterxml.jackson.databind.JsonNode jsonQuery)	select Unit
javax.ws.rs.core.Response	selectUnitsWithInheritedRules(String transactionId, com.fasterxml.jackson.databind.JsonNode queryJson)
javax.ws.rs.core.Response	updateTransaction(TransactionDto transactionDto)
javax.ws.rs.core.Response	updateUnits(String transactionId, InputStream inputStream)	Deprecated, for removal: This API element is subject to removal in a future version.
javax.ws.rs.core.Response	updateUnitsWithMetadataCsv(String transactionId, InputStream metadataCsvInputStream)
javax.ws.rs.core.Response	updateUnitsWithMetadataJsonl(String transactionId, InputStream metadataJsonlInputStream)
javax.ws.rs.core.Response	uploadArchiveUnit(String transactionId, com.fasterxml.jackson.databind.JsonNode unitJsonNode)
javax.ws.rs.core.Response	uploadTransactionZip(String transactionId, InputStream inputStreamObject, String encoding)

Methods inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

getServerTenants, status

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ERROR_WHEN_UPDATE_TRANSACTION__

public static final String ERROR_WHEN_UPDATE_TRANSACTION__

See Also:

• Constant Field Values

Method Details

getTransactionById

@Path("/{transactionId}")
@GET
@Produces("application/json")
public javax.ws.rs.core.Response getTransactionById(@PathParam("transactionId")
 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")
 String transactionId)

uploadArchiveUnit

@Path("/{transactionId}/units")
@POST
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response uploadArchiveUnit(@PathParam("transactionId")
 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")
 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")
 String transactionId)

abortTransaction

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

reopenTransaction

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

generateAndSendSip

@Path("/{transactionId}/send")
@POST
@Consumes("application/json")
public javax.ws.rs.core.Response generateAndSendSip(@PathParam("transactionId")
 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")
 String transactionId,
 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")
 String transactionId,
 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")
 String transactionId,
 InputStream metadataJsonlInputStream)

bulkAtomicUpdateUnits

@POST
@Path("/{transactionId}/units/bulk")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response bulkAtomicUpdateUnits(@PathParam("transactionId")
 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")
 String transactionId,
 InputStream inputStreamObject,
 @HeaderParam("X-Encoding") @Nullable
 String encoding)

selectUnitsWithInheritedRules

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