Interface CollectInternalClient
- All Superinterfaces:
AutoCloseable
,MockOrRestClient
,VitamAutoCloseable
- All Known Implementing Classes:
CollectInternalClientRest
Collect Client Interface
-
Method Summary
Modifier and TypeMethodDescriptionjavax.ws.rs.core.Response
abortTransaction
(String transactionId) Abort Transaction Consume and produce MediaType.APPLICATION_JSONRequestResponse<com.fasterxml.jackson.databind.JsonNode>
addBinary
(String unitId, Integer version, InputStream inputStreamUploaded, String usage) ADD Binary Consume and produce MediaType.OCTET_STREAMRequestResponseOK<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_JSONjavax.ws.rs.core.Response
attachVitamOperationId
(String transactionId, String operationId) Attach Vitam Operation Id To Transaction Consume and produce MediaType.APPLICATION_JSONbulkAtomicUpdateUnits
(String transactionId, com.fasterxml.jackson.databind.JsonNode updateQueriesJson) javax.ws.rs.core.Response
changeTransactionStatus
(String transactionId, TransactionStatus transactionStatus) Change Transaction Status Consume and produce MediaType.APPLICATION_JSONjavax.ws.rs.core.Response
closeTransaction
(String transactionId) Close Transaction Consume and produce MediaType.APPLICATION_JSONRequestResponse<com.fasterxml.jackson.databind.JsonNode>
deleteProjectById
(String projectId) delete a collect project produce MediaType.APPLICATION_JSONRequestResponse<com.fasterxml.jackson.databind.JsonNode>
deleteTransactionById
(String transactionId) delete a collect transaction produce MediaType.APPLICATION_JSONgenerateSip
(String transactionId) Generate SIP + Send to Vitam produce and InputStreamRequestResponseOK<com.fasterxml.jackson.databind.JsonNode>
getObjectById
(String gotId) get an object group by Id Consume and produce MediaType.APPLICATION_JSONjavax.ws.rs.core.Response
getObjectStreamByUnitId
(String unitId, String usage, int version) Get all AU attached to transactions related to project Id paramRequestResponse<com.fasterxml.jackson.databind.JsonNode>
getProjectById
(String projectId) get a collect project Consume and produce MediaType.APPLICATION_JSONRequestResponse<com.fasterxml.jackson.databind.JsonNode>
get all collect project by tenant Consume and produce MediaType.APPLICATION_JSONRequestResponse<com.fasterxml.jackson.databind.JsonNode>
getTransactionById
(String transactionId) get a collect transaction by ID Consume and produce MediaType.APPLICATION_JSONRequestResponse<com.fasterxml.jackson.databind.JsonNode>
getTransactionByProjectId
(String projectId) get a collect transaction Consume and produce MediaType.APPLICATION_JSONRequestResponse<com.fasterxml.jackson.databind.JsonNode>
RequestResponseOK<com.fasterxml.jackson.databind.JsonNode>
getUnitById
(String unitId) get an archive unit by Id Consume and produce MediaType.APPLICATION_JSONRequestResponseOK<com.fasterxml.jackson.databind.JsonNode>
getUnitsByProjectId
(String projectId, com.fasterxml.jackson.databind.JsonNode dslQuery) Get all AU attached to transactions related to project Id paramRequestResponseOK<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_JSONRequestResponse<com.fasterxml.jackson.databind.JsonNode>
initProject
(ProjectDto projectDto) Initialize a collect project Consume and produce MediaType.APPLICATION_JSONRequestResponse<com.fasterxml.jackson.databind.JsonNode>
initTransaction
(TransactionDto transactionDto, String projectId) Initialize a collect transaction Consume and produce MediaType.APPLICATION_JSONjavax.ws.rs.core.Response
reopenTransaction
(String transactionId) Reopen Transaction Consume and produce MediaType.APPLICATION_JSONRequestResponseOK<com.fasterxml.jackson.databind.JsonNode>
searchProject
(CriteriaProjectDto criteria) get all projects by criteria Consume and produce MediaType.APPLICATION_JSONRequestResponse<com.fasterxml.jackson.databind.JsonNode>
selectUnitsWithInheritedRules
(String transactionId, com.fasterxml.jackson.databind.JsonNode selectQuery) select Units With Inherited RulesRequestResponse<com.fasterxml.jackson.databind.JsonNode>
updateProject
(ProjectDto projectDto) Update a collect project Consume and produce MediaType.APPLICATION_JSONRequestResponse<com.fasterxml.jackson.databind.JsonNode>
updateTransaction
(TransactionDto transactionDto) Update a collect transaction Consume and produce MediaType.APPLICATION_JSONRequestResponseOK<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_JSONuploadZipToProject
(String projectId, InputStream inputStreamUploaded, String encoding) Upload zip to a project with automatic transaction management Consume and produce CommonMediaType.ZIPvoid
uploadZipToTransaction
(String transactionId, InputStream inputStreamUploaded, String encoding) Upload zip and consume Consume and produce CommonMediaType.ZIPMethods 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
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
Close Transaction Consume and produce MediaType.APPLICATION_JSON- Returns:
- Response
- Throws:
VitamClientException
- exception occurs when parse operation failed
-
generateSip
Generate SIP + Send to Vitam produce and InputStream- Returns:
- InputStream
- Throws:
VitamClientException
- exception occurs when parse operation failed
-
abortTransaction
Abort Transaction Consume and produce MediaType.APPLICATION_JSON- Returns:
- Response
- Throws:
VitamClientException
- exception occurs when parse operation failed
-
reopenTransaction
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) 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
javax.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 idusage
- usageversion
- 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
javax.ws.rs.core.Response changeTransactionStatus(String transactionId, TransactionStatus transactionStatus) throws VitamClientException Change Transaction Status Consume and produce MediaType.APPLICATION_JSON- Returns:
- Response
- Throws:
VitamClientException
- exception occurs when parse operation failed
-
attachVitamOperationId
javax.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 IdselectQuery
- 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
-