fr.gouv.vitam.access.internal.api

Interface AccessInternalModule

All Known Implementing Classes:

AccessInternalModuleImpl

public interface AccessInternalModule

AccessModule interface for database operations in select

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	findDIPByOperationId(String id) retrieve a DIP file according to an operationId
javax.ws.rs.core.Response	getOneObjectFromObjectGroup(String idObjectGroup, String qualifier, int version) Retrieve an object as InputStream based on the associated ObjectGroupId and qualifier + version requested
com.fasterxml.jackson.databind.JsonNode	selectObjectGroupById(com.fasterxml.jackson.databind.JsonNode queryJson, String idObjectGroup) Retrieve an ObjectGroup by its id with results fields filtered based on given query
com.fasterxml.jackson.databind.JsonNode	selectUnit(com.fasterxml.jackson.databind.JsonNode queryJson) select Unit
com.fasterxml.jackson.databind.JsonNode	selectUnitbyId(com.fasterxml.jackson.databind.JsonNode queryJson, String idUnit) select Unit by id
com.fasterxml.jackson.databind.JsonNode	updateUnitbyId(com.fasterxml.jackson.databind.JsonNode queryJson, String idUnit, String requestId) update Unit by id

Method Detail

selectUnit

com.fasterxml.jackson.databind.JsonNode selectUnit(com.fasterxml.jackson.databind.JsonNode queryJson)
                                            throws InvalidParseOperationException,
                                                   AccessInternalExecutionException,
                                                   VitamDBException,
                                                   MetaDataDocumentSizeException,
                                                   MetaDataExecutionException,
                                                   MetaDataClientServerException

select Unit

Parameters:

queryJson - as String { $query : query}

Returns:

the result of the select on Unit

Throws:

IllegalArgumentException - if json query is null

InvalidParseOperationException - Throw if json format is not correct

AccessInternalExecutionException - Throw if error occurs when send Unit to database

VitamDBException

MetaDataDocumentSizeException

MetaDataExecutionException

MetaDataClientServerException

selectUnitbyId

com.fasterxml.jackson.databind.JsonNode selectUnitbyId(com.fasterxml.jackson.databind.JsonNode queryJson,
                                                       String idUnit)
                                                throws InvalidParseOperationException,
                                                       AccessInternalExecutionException

select Unit by id

Parameters:

queryJson - as String { $query : query}

idUnit - as String

Returns:

the corresponding JsonNode

Throws:

InvalidParseOperationException - Throw if json format is not correct

AccessInternalExecutionException - Throw if error occurs when send Unit to database

IllegalArgumentException - Throw if error occurs when checking argument

updateUnitbyId

com.fasterxml.jackson.databind.JsonNode updateUnitbyId(com.fasterxml.jackson.databind.JsonNode queryJson,
                                                       String idUnit,
                                                       String requestId)
                                                throws MetaDataNotFoundException,
                                                       InvalidParseOperationException,
                                                       AccessInternalExecutionException,
                                                       IllegalArgumentException,
                                                       AccessInternalRuleExecutionException

update Unit by id

Parameters:

queryJson - json update query

idUnit - as String

requestId - the request id

Returns:

the result of the update on Unit

Throws:

InvalidParseOperationException - Throw if json format is not correct

AccessInternalExecutionException - Throw if error occurs when send Unit to database

AccessInternalRuleExecutionException - Throw When error occures on rules update check

IllegalArgumentException - Throw if error occurs when checking argument

MetaDataNotFoundException - Throw if unit is not found

selectObjectGroupById

com.fasterxml.jackson.databind.JsonNode selectObjectGroupById(com.fasterxml.jackson.databind.JsonNode queryJson,
                                                              String idObjectGroup)
                                                       throws InvalidParseOperationException,
                                                              AccessInternalExecutionException

Retrieve an ObjectGroup by its id with results fields filtered based on given query

Parameters:

queryJson - the query DSL as a Json node

idObjectGroup - the id of the ObjectGroup as

Returns:

the ObjectGroup metadata as a JsonNode

Throws:

IllegalArgumentException - in case of null/incorrect parameters

InvalidParseOperationException - thrown if json query is not syntactically correct

AccessInternalExecutionException - in case of access failure

getOneObjectFromObjectGroup

javax.ws.rs.core.Response getOneObjectFromObjectGroup(String idObjectGroup,
                                                      String qualifier,
                                                      int version)
                                               throws MetaDataNotFoundException,
                                                      StorageNotFoundException,
                                                      InvalidParseOperationException,
                                                      AccessInternalExecutionException

Retrieve an object as InputStream based on the associated ObjectGroupId and qualifier + version requested

Parameters:

idObjectGroup - The Object Group Id

qualifier - the qualifier to be retrieve (ie: Dissemination etc.)

version - the version number to get

Returns:

response

Throws:

MetaDataNotFoundException - If the ObjectGroup could not be find

StorageNotFoundException - If the object is not found in storage

InvalidParseOperationException - when a query is badly structured

AccessInternalExecutionException - For other technical errors

findDIPByOperationId

javax.ws.rs.core.Response findDIPByOperationId(String id)
                                        throws AccessInternalExecutionException

retrieve a DIP file according to an operationId

Parameters:

id - operation id

Returns:

zip file containing a DIP

Throws:

AccessInternalExecutionException