Package fr.gouv.vitam.collect.internal.client

Interface CollectInternalClient

All Superinterfaces:

AutoCloseable, MockOrRestClient, VitamAutoCloseable

All Known Implementing Classes:

CollectInternalClientRest

public interface CollectInternalClient
extends MockOrRestClient

Collect Client Interface

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	abortTransaction(String transactionId)	Abort Transaction Consume and produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	addBinary(String unitId, Integer version, InputStream inputStreamUploaded, String usage)	ADD Binary Consume and produce MediaType.OCTET_STREAM
RequestResponseOK<com.fasterxml.jackson.databind.JsonNode>	addObjectGroup(String unitId, Integer version, com.fasterxml.jackson.databind.JsonNode objectJsonNode, String usage)	ADD Object Group Consume and produce MediaType.APPLICATION_JSON
jakarta.ws.rs.core.Response	attachVitamOperationId(String transactionId, String operationId)	Attach Vitam Operation Id To Transaction Consume and produce MediaType.APPLICATION_JSON
void	awaitTransactionValidation(String transactionId)	Wait for transaction to become valid (SIP generated successfully), so it can be ingested in Vitam.
RequestResponseOK<BulkAtomicUpdateResult>	bulkAtomicUpdateUnits(String transactionId, com.fasterxml.jackson.databind.JsonNode updateQueriesJson)
void	changeTransactionStatus(String transactionId, TransactionStatus transactionStatus)	Change Transaction Status Consume and produce MediaType.APPLICATION_JSON
jakarta.ws.rs.core.Response	closeTransaction(String transactionId)	Close Transaction Consume and produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	deleteProjectById(String projectId)	delete a collect project produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	deleteTransactionById(String transactionId)	delete a collect transaction produce MediaType.APPLICATION_JSON
InputStream	downloadSIP(String transactionId)	Download the generated SIP of the transaction
RequestResponseOK<com.fasterxml.jackson.databind.JsonNode>	getObjectById(String gotId)	get an object group by Id Consume and produce MediaType.APPLICATION_JSON
jakarta.ws.rs.core.Response	getObjectStreamByUnitId(String unitId, String usage, int version)	Get all AU attached to transactions related to project Id param
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	getProjectById(String projectId)	get a collect project Consume and produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	getProjects()	get all collect project by tenant Consume and produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	getTransactionById(String transactionId)	get a collect transaction by ID Consume and produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	getTransactionByProjectId(String projectId)	get a collect transaction Consume and produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	getTransactionsToAutomaticallyIngest()
RequestResponseOK<com.fasterxml.jackson.databind.JsonNode>	getUnitById(String unitId)	get an archive unit by Id Consume and produce MediaType.APPLICATION_JSON
RequestResponseOK<com.fasterxml.jackson.databind.JsonNode>	getUnitsByProjectId(String projectId, com.fasterxml.jackson.databind.JsonNode dslQuery)	Get all AU attached to transactions related to project Id param
RequestResponseOK<com.fasterxml.jackson.databind.JsonNode>	getUnitsByTransaction(String transactionId, com.fasterxml.jackson.databind.JsonNode query)	get an archive unit by transaction Id Consume and produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	initProject(ProjectDto projectDto)	Initialize a collect project Consume and produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	initTransaction(TransactionDto transactionDto, String projectId)	Initialize a collect transaction Consume and produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	reclassification(String transactionId, com.fasterxml.jackson.databind.JsonNode reclassificationRequest)	Start a reclassification workflow on collect
jakarta.ws.rs.core.Response	reopenTransaction(String transactionId)	Reopen Transaction Consume and produce MediaType.APPLICATION_JSON
RequestResponseOK<com.fasterxml.jackson.databind.JsonNode>	searchProject(CriteriaProjectDto criteria)	get all projects by criteria Consume and produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	selectUnitsWithInheritedRules(String transactionId, com.fasterxml.jackson.databind.JsonNode selectQuery)	select Units With Inherited Rules
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	startDeletion(String transactionId, DeletionRequestBody deletionRequestBody)	Performs a deletion action workflow on collect.
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	startEliminationAction(String transactionId, EliminationRequestBody eliminationRequestBody)	Performs an elimination action workflow on collect.
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	updateProject(ProjectDto projectDto)	Update a collect project Consume and produce MediaType.APPLICATION_JSON
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	updateTransaction(TransactionDto transactionDto)	Update a collect transaction Consume and produce MediaType.APPLICATION_JSON
RequestResponseOK<com.fasterxml.jackson.databind.JsonNode>	updateUnitsWithCsvMetadata(String transactionId, InputStream metadataCsvInputStream)
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	updateUnitsWithJsonlMetadata(String transactionId, InputStream metadataJsonlInputStream)
RequestResponseOK<com.fasterxml.jackson.databind.JsonNode>	uploadArchiveUnit(com.fasterxml.jackson.databind.JsonNode unitJsonNode, String transactionId)	ADD Archive Unit Consume and produce MediaType.APPLICATION_JSON
RequestResponse<UploadSipResult>	uploadSipToTransaction(String transactionId, InputStream inputStream)	Performs an ingest of a SIP into a collect transaction.
String	uploadZipToProject(String projectId, InputStream inputStreamUploaded, String encoding)	Upload zip to a project with automatic transaction management Consume and produce CommonMediaType.ZIP
void	uploadZipToTransaction(String transactionId, InputStream inputStreamUploaded, String encoding, String attachementId)	Upload zip and consume Consume and produce CommonMediaType.ZIP

Methods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Method Details

initProject

RequestResponse<com.fasterxml.jackson.databind.JsonNode> initProject(ProjectDto projectDto)
                                                              throws VitamClientException

Initialize a collect project Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponse

Throws:

VitamClientException - exception occurs when parse operation failed

updateProject

RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateProject(ProjectDto projectDto)
                                                                throws VitamClientException

Update a collect project Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponse

Throws:

VitamClientException - exception occurs when parse operation failed

getProjectById

RequestResponse<com.fasterxml.jackson.databind.JsonNode> getProjectById(String projectId)
                                                                 throws VitamClientException

get a collect project Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponse

Throws:

VitamClientException - exception occurs when parse operation failed

getTransactionByProjectId

RequestResponse<com.fasterxml.jackson.databind.JsonNode> getTransactionByProjectId(String projectId)
                                                                            throws VitamClientException

get a collect transaction Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponse

Throws:

VitamClientException - exception occurs when parse operation failed

getTransactionById

RequestResponse<com.fasterxml.jackson.databind.JsonNode> getTransactionById(String transactionId)
                                                                     throws VitamClientException

get a collect transaction by ID Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponse

Throws:

VitamClientException - exception occurs when parse operation failed

getProjects

RequestResponse<com.fasterxml.jackson.databind.JsonNode> getProjects()
                                                              throws VitamClientException

get all collect project by tenant Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponse

Throws:

VitamClientException - exception occurs when parse operation failed

deleteTransactionById

RequestResponse<com.fasterxml.jackson.databind.JsonNode> deleteTransactionById(String transactionId)
                                                                        throws VitamClientException

delete a collect transaction produce MediaType.APPLICATION_JSON

Returns:

RequestResponse

Throws:

VitamClientException - exception occurs when parse operation failed

deleteProjectById

RequestResponse<com.fasterxml.jackson.databind.JsonNode> deleteProjectById(String projectId)
                                                                    throws VitamClientException

delete a collect project produce MediaType.APPLICATION_JSON

Returns:

RequestResponse

Throws:

VitamClientException - exception occurs when parse operation failed

getUnitById

RequestResponseOK<com.fasterxml.jackson.databind.JsonNode> getUnitById(String unitId)
                                                                throws VitamClientException

get an archive unit by Id Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponseOK

Throws:

VitamClientException - exception occurs when parse operation failed

getUnitsByTransaction

RequestResponseOK<com.fasterxml.jackson.databind.JsonNode> getUnitsByTransaction(String transactionId,
 com.fasterxml.jackson.databind.JsonNode query)
                                                                          throws VitamClientException

get an archive unit by transaction Id Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponse

Throws:

VitamClientException - exception occurs when parse operation failed

getObjectById

RequestResponseOK<com.fasterxml.jackson.databind.JsonNode> getObjectById(String gotId)
                                                                  throws VitamClientException

get an object group by Id Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponseOK

Throws:

VitamClientException - exception occurs when parse operation failed

initTransaction

RequestResponse<com.fasterxml.jackson.databind.JsonNode> initTransaction(TransactionDto transactionDto,
 String projectId)
                                                                  throws VitamClientException

Initialize a collect transaction Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponse guid created for the transaction

Throws:

VitamClientException - exception occurs when parse operation failed

uploadArchiveUnit

RequestResponseOK<com.fasterxml.jackson.databind.JsonNode> uploadArchiveUnit(com.fasterxml.jackson.databind.JsonNode unitJsonNode,
 String transactionId)
                                                                      throws VitamClientException

ADD Archive Unit Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponse Archive Unit saved

Throws:

VitamClientException - exception occurs when parse operation failed

addObjectGroup

RequestResponseOK<com.fasterxml.jackson.databind.JsonNode> addObjectGroup(String unitId,
 Integer version,
 com.fasterxml.jackson.databind.JsonNode objectJsonNode,
 String usage)
                                                                   throws VitamClientException

ADD Object Group Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponse objectgroup saved

Throws:

VitamClientException - exception occurs when parse operation failed

addBinary

RequestResponse<com.fasterxml.jackson.databind.JsonNode> addBinary(String unitId,
 Integer version,
 InputStream inputStreamUploaded,
 String usage)
                                                            throws VitamClientException

ADD Binary Consume and produce MediaType.OCTET_STREAM

Returns:

Response

Throws:

VitamClientException - exception occurs when parse operation failed

closeTransaction

jakarta.ws.rs.core.Response closeTransaction(String transactionId)
                                      throws VitamClientException

Close Transaction Consume and produce MediaType.APPLICATION_JSON

Returns:

Response

Throws:

VitamClientException - exception occurs when parse operation failed

awaitTransactionValidation

void awaitTransactionValidation(String transactionId)
                         throws VitamClientException

Wait for transaction to become valid (SIP generated successfully), so it can be ingested in Vitam.

Throws:

VitamClientException - exception occurs when parse operation failed

downloadSIP

InputStream downloadSIP(String transactionId)
                 throws VitamClientException

Download the generated SIP of the transaction

Returns:

InputStream

Throws:

VitamClientException - exception occurs when parse operation failed

abortTransaction

jakarta.ws.rs.core.Response abortTransaction(String transactionId)
                                      throws VitamClientException

Abort Transaction Consume and produce MediaType.APPLICATION_JSON

Returns:

Response

Throws:

VitamClientException - exception occurs when parse operation failed

reopenTransaction

jakarta.ws.rs.core.Response reopenTransaction(String transactionId)
                                       throws VitamClientException

Reopen Transaction Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponseOK

Throws:

VitamClientException - exception occurs when parse operation failed

uploadZipToTransaction

void uploadZipToTransaction(String transactionId,
 InputStream inputStreamUploaded,
 @Nullable
 String encoding,
 @Nullable
 String attachementId)
                     throws VitamClientException

Upload zip and consume Consume and produce CommonMediaType.ZIP

Throws:

VitamClientException - exception occurs when parse operation failed

uploadZipToProject

String uploadZipToProject(String projectId,
 InputStream inputStreamUploaded,
 @Nullable
 String encoding)
                   throws VitamClientException

Upload zip to a project with automatic transaction management Consume and produce CommonMediaType.ZIP

Returns:

Response

Throws:

VitamClientException - exception occurs when parse operation failed

getUnitsByProjectId

RequestResponseOK<com.fasterxml.jackson.databind.JsonNode> getUnitsByProjectId(String projectId,
 com.fasterxml.jackson.databind.JsonNode dslQuery)
                                                                        throws VitamClientException

Get all AU attached to transactions related to project Id param

Parameters:

projectId -

dslQuery -

Returns:

Throws:

VitamClientException

getObjectStreamByUnitId

jakarta.ws.rs.core.Response getObjectStreamByUnitId(String unitId,
 String usage,
 int version)
                                             throws VitamClientException

Get all AU attached to transactions related to project Id param

Parameters:

unitId - unit id

usage - usage

version - version

Returns:

Response

Throws:

VitamClientException - Thrown exception

searchProject

RequestResponseOK<com.fasterxml.jackson.databind.JsonNode> searchProject(CriteriaProjectDto criteria)
                                                                  throws VitamClientException

get all projects by criteria Consume and produce MediaType.APPLICATION_JSON

Parameters:

criteria -

Returns:

RequestResponse

Throws:

VitamClientException - exception occurs when parse operation failed

updateTransaction

RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateTransaction(TransactionDto transactionDto)
                                                                    throws VitamClientException

Update a collect transaction Consume and produce MediaType.APPLICATION_JSON

Returns:

RequestResponse

Throws:

VitamClientException - exception occurs when parse operation failed

updateUnitsWithCsvMetadata

RequestResponseOK<com.fasterxml.jackson.databind.JsonNode> updateUnitsWithCsvMetadata(String transactionId,
 InputStream metadataCsvInputStream)
                                                                               throws VitamClientException

Throws:

VitamClientException

updateUnitsWithJsonlMetadata

RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateUnitsWithJsonlMetadata(String transactionId,
 InputStream metadataJsonlInputStream)
                                                                               throws VitamClientException

Throws:

VitamClientException

changeTransactionStatus

void changeTransactionStatus(String transactionId,
 TransactionStatus transactionStatus)
                      throws VitamClientException

Change Transaction Status Consume and produce MediaType.APPLICATION_JSON

Throws:

VitamClientException - exception occurs when parse operation failed

attachVitamOperationId

jakarta.ws.rs.core.Response attachVitamOperationId(String transactionId,
 String operationId)
                                            throws VitamClientException

Attach Vitam Operation Id To Transaction Consume and produce MediaType.APPLICATION_JSON

Returns:

Response

Throws:

VitamClientException - exception occurs when parse operation failed

selectUnitsWithInheritedRules

RequestResponse<com.fasterxml.jackson.databind.JsonNode> selectUnitsWithInheritedRules(String transactionId,
 com.fasterxml.jackson.databind.JsonNode selectQuery)
                                                                                throws VitamClientException

select Units With Inherited Rules

Parameters:

transactionId - transaction Id

selectQuery - dsl query

Returns:

Response

Throws:

VitamClientException - exception

getTransactionsToAutomaticallyIngest

RequestResponse<com.fasterxml.jackson.databind.JsonNode> getTransactionsToAutomaticallyIngest()
                                                                                       throws VitamClientException

Throws:

VitamClientException

bulkAtomicUpdateUnits

RequestResponseOK<BulkAtomicUpdateResult> bulkAtomicUpdateUnits(String transactionId,
 com.fasterxml.jackson.databind.JsonNode updateQueriesJson)
                                                         throws VitamClientException

Throws:

VitamClientException

reclassification

RequestResponse<com.fasterxml.jackson.databind.JsonNode> reclassification(String transactionId,
 com.fasterxml.jackson.databind.JsonNode reclassificationRequest)
                                                                   throws VitamClientException

Start a reclassification workflow on collect

Parameters:

transactionId - transaction Id

reclassificationRequest - List of attachment and detachment operations in unit graph.

Returns:

Response

Throws:

VitamClientException

startEliminationAction

RequestResponse<com.fasterxml.jackson.databind.JsonNode> startEliminationAction(String transactionId,
 EliminationRequestBody eliminationRequestBody)
                                                                         throws VitamClientException

Performs an elimination action workflow on collect.

Parameters:

transactionId - transaction Id

eliminationRequestBody - Dsl request for elimination.

Returns:

Response given response

Throws:

VitamClientException

startDeletion

RequestResponse<com.fasterxml.jackson.databind.JsonNode> startDeletion(String transactionId,
 DeletionRequestBody deletionRequestBody)
                                                                throws VitamClientException

Performs a deletion action workflow on collect.

Parameters:

transactionId - transaction Id

deletionRequestBody - Dsl request for deletion.

Returns:

Response given response

Throws:

VitamClientException

uploadSipToTransaction

RequestResponse<UploadSipResult> uploadSipToTransaction(String transactionId,
 InputStream inputStream)
                                                 throws VitamClientException

Performs an ingest of a SIP into a collect transaction.

Parameters:

transactionId - transaction Id

inputStream - SIP payload.

Returns:

OperationIdDto containing the operation ID

Throws:

VitamClientException