Package fr.gouv.vitam.access.internal.core

Class AccessInternalModuleImpl

java.lang.Object

fr.gouv.vitam.access.internal.core.AccessInternalModuleImpl

All Implemented Interfaces:

AccessInternalModule

public class AccessInternalModuleImpl
extends java.lang.Object
implements AccessInternalModule

AccessModuleImpl implements AccessModule

Constructor Summary

Constructors

Constructor	Description
AccessInternalModuleImpl()	AccessModuleImpl constructor
AccessInternalModuleImpl(LogbookLifeCyclesClientFactory logbookLifeCyclesClientFactory, LogbookOperationsClientFactory logbookOperationsClientFactory, StorageClientFactory storageClientFactory, WorkspaceClientFactory workspaceClientFactory, AdminManagementClientFactory adminManagementClientFactory, MetaDataClientFactory metaDataClientFactory)

Method Summary

Modifier and Type	Method	Description
java.util.List<StatusByAccessRequest>	checkAccessRequestStatuses(java.util.List<AccessRequestReference> accessRequestReferences)
void	checkClassificationLevel(com.fasterxml.jackson.databind.JsonNode query)	check ClassificationLevel in update Unit
java.util.Optional<AccessRequestReference>	createObjectAccessRequestIfRequired(java.lang.String idObjectGroup, java.lang.String qualifier, int version)
javax.ws.rs.core.Response	findDIPByOperationId(java.lang.String id)	retrieve a DIP file according to an operationId
javax.ws.rs.core.Response	findTransferSIPByOperationId(java.lang.String id)	retrieve a SIP file according to an operationId
javax.ws.rs.core.Response	getAccessLog(com.fasterxml.jackson.databind.JsonNode params)	Retrieve all accessLog by the concatenation of all accesslog files as InputStream
javax.ws.rs.core.Response	getOneObjectFromObjectGroup(java.lang.String idObjectGroup, java.lang.String qualifier, int version, java.lang.String idUnit)	Retrieve an object as InputStream based on the associated ObjectGroupId and qualifier + version requested
void	removeAccessRequest(java.lang.String strategyId, java.lang.String accessRequestId)
com.fasterxml.jackson.databind.JsonNode	selectObjectGroupById(com.fasterxml.jackson.databind.JsonNode jsonQuery, java.lang.String idObjectGroup)	Retrieve an ObjectGroup by its id with results fields filtered based on given query
com.fasterxml.jackson.databind.JsonNode	selectObjects(com.fasterxml.jackson.databind.JsonNode jsonQuery)	select Object
com.fasterxml.jackson.databind.JsonNode	selectUnit(com.fasterxml.jackson.databind.JsonNode jsonQuery)	select Unit
com.fasterxml.jackson.databind.JsonNode	selectUnitbyId(com.fasterxml.jackson.databind.JsonNode jsonQuery, java.lang.String idUnit)	select Unit by id
com.fasterxml.jackson.databind.JsonNode	selectUnitsWithInheritedRules(com.fasterxml.jackson.databind.JsonNode jsonQuery)	Select units by DSL and computes inherited rules for matching units
javax.ws.rs.core.Response	streamObjects(com.fasterxml.jackson.databind.JsonNode query)
javax.ws.rs.core.Response	streamUnits(com.fasterxml.jackson.databind.JsonNode query)
com.fasterxml.jackson.databind.JsonNode	updateUnitById(com.fasterxml.jackson.databind.JsonNode queryJson, java.lang.String idUnit, java.lang.String requestId)	update Unit by id

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessInternalModuleImpl

public AccessInternalModuleImpl()

AccessModuleImpl constructor

AccessInternalModuleImpl

public AccessInternalModuleImpl(LogbookLifeCyclesClientFactory logbookLifeCyclesClientFactory,
                                LogbookOperationsClientFactory logbookOperationsClientFactory,
                                StorageClientFactory storageClientFactory,
                                WorkspaceClientFactory workspaceClientFactory,
                                AdminManagementClientFactory adminManagementClientFactory,
                                MetaDataClientFactory metaDataClientFactory)

Method Detail

selectUnit

public com.fasterxml.jackson.databind.JsonNode selectUnit(com.fasterxml.jackson.databind.JsonNode jsonQuery)
                                                   throws java.lang.IllegalArgumentException,
                                                          InvalidParseOperationException,
                                                          AccessInternalExecutionException

select Unit

Specified by:

selectUnit in interface AccessInternalModule

Parameters:

jsonQuery - as String { $query : query}

Returns:

the result of the select on Unit

Throws:

InvalidParseOperationException - Throw if json format is not correct

AccessInternalExecutionException - Throw if error occurs when send Unit to database

java.lang.IllegalArgumentException - if json query is null

selectUnitbyId

public com.fasterxml.jackson.databind.JsonNode selectUnitbyId(com.fasterxml.jackson.databind.JsonNode jsonQuery,
                                                              java.lang.String idUnit)
                                                       throws InvalidParseOperationException,
                                                              AccessInternalExecutionException,
                                                              MetaDataNotFoundException

Description copied from interface: AccessInternalModule

select Unit by id

Specified by:

selectUnitbyId in interface AccessInternalModule

Parameters:

jsonQuery - 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

MetaDataNotFoundException

selectObjectGroupById

public com.fasterxml.jackson.databind.JsonNode selectObjectGroupById(com.fasterxml.jackson.databind.JsonNode jsonQuery,
                                                                     java.lang.String idObjectGroup)
                                                              throws InvalidParseOperationException,
                                                                     AccessInternalExecutionException,
                                                                     MetaDataNotFoundException

Description copied from interface: AccessInternalModule

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

Specified by:

selectObjectGroupById in interface AccessInternalModule

Parameters:

jsonQuery - the query DSL as a Json node

idObjectGroup - the id of the ObjectGroup as

Returns:

the ObjectGroup metadata as a JsonNode

Throws:

InvalidParseOperationException - thrown if json query is not syntactically correct

AccessInternalExecutionException - in case of access failure

MetaDataNotFoundException

getOneObjectFromObjectGroup

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

Description copied from interface: AccessInternalModule

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

Specified by:

getOneObjectFromObjectGroup in interface AccessInternalModule

Parameters:

idObjectGroup - The Object Group Id

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

version - the version number to get

idUnit - identifier of the parent archiveunit used to have access to the object

Returns:

response

Throws:

StorageNotFoundException - If the object is not found in storage

AccessInternalExecutionException - For other technical errors

MetaDataNotFoundException

InvalidParseOperationException - when a query is badly structured

AccessInternalUnavailableDataFromAsyncOfferException

getAccessLog

public javax.ws.rs.core.Response getAccessLog(com.fasterxml.jackson.databind.JsonNode params)
                                       throws AccessInternalExecutionException,
                                              StorageNotFoundException,
                                              java.text.ParseException

Description copied from interface: AccessInternalModule

Retrieve all accessLog by the concatenation of all accesslog files as InputStream

Specified by:

getAccessLog in interface AccessInternalModule

Parameters:

params - a json containing query on StartDate or EndDate

Returns:

the Storage response for the asked file

Throws:

AccessInternalExecutionException

StorageNotFoundException

java.text.ParseException

checkClassificationLevel

public void checkClassificationLevel(com.fasterxml.jackson.databind.JsonNode query)
                              throws InvalidParseOperationException

Description copied from interface: AccessInternalModule

check ClassificationLevel in update Unit

Specified by:

checkClassificationLevel in interface AccessInternalModule

Parameters:

query - query

Throws:

InvalidParseOperationException - InvalidParseOperationException

createObjectAccessRequestIfRequired

public java.util.Optional<AccessRequestReference> createObjectAccessRequestIfRequired(java.lang.String idObjectGroup,
                                                                                      java.lang.String qualifier,
                                                                                      int version)
                                                                               throws MetaDataNotFoundException,
                                                                                      InvalidParseOperationException,
                                                                                      AccessInternalExecutionException

Specified by:

createObjectAccessRequestIfRequired in interface AccessInternalModule

Throws:

MetaDataNotFoundException

InvalidParseOperationException

AccessInternalExecutionException

checkAccessRequestStatuses

public java.util.List<StatusByAccessRequest> checkAccessRequestStatuses(java.util.List<AccessRequestReference> accessRequestReferences)
                                                                 throws AccessInternalExecutionException,
                                                                        AccessInternalIllegalOperationException

Specified by:

checkAccessRequestStatuses in interface AccessInternalModule

Throws:

AccessInternalExecutionException

AccessInternalIllegalOperationException

removeAccessRequest

public void removeAccessRequest(java.lang.String strategyId,
                                java.lang.String accessRequestId)
                         throws AccessInternalExecutionException,
                                AccessInternalIllegalOperationException

Specified by:

removeAccessRequest in interface AccessInternalModule

Throws:

AccessInternalExecutionException

AccessInternalIllegalOperationException

streamUnits

public javax.ws.rs.core.Response streamUnits(com.fasterxml.jackson.databind.JsonNode query)
                                      throws AccessInternalExecutionException,
                                             MetadataScrollLimitExceededException,
                                             MetadataScrollThresholdExceededException

Specified by:

streamUnits in interface AccessInternalModule

Throws:

AccessInternalExecutionException

MetadataScrollLimitExceededException

MetadataScrollThresholdExceededException

streamObjects

public javax.ws.rs.core.Response streamObjects(com.fasterxml.jackson.databind.JsonNode query)
                                        throws AccessInternalExecutionException,
                                               MetadataScrollLimitExceededException,
                                               MetadataScrollThresholdExceededException

Specified by:

streamObjects in interface AccessInternalModule

Throws:

AccessInternalExecutionException

MetadataScrollLimitExceededException

MetadataScrollThresholdExceededException

updateUnitById

public com.fasterxml.jackson.databind.JsonNode updateUnitById(com.fasterxml.jackson.databind.JsonNode queryJson,
                                                              java.lang.String idUnit,
                                                              java.lang.String requestId)
                                                       throws MetaDataNotFoundException,
                                                              java.lang.IllegalArgumentException,
                                                              InvalidParseOperationException,
                                                              AccessInternalExecutionException,
                                                              UpdatePermissionException,
                                                              AccessInternalRuleExecutionException

Description copied from interface: AccessInternalModule

update Unit by id

Specified by:

updateUnitById in interface AccessInternalModule

Parameters:

queryJson - json update query

idUnit - as String

requestId - the request id

Returns:

the result of the update on Unit

Throws:

MetaDataNotFoundException - Throw if unit is not found

java.lang.IllegalArgumentException - Throw if error occurs when checking argument

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

UpdatePermissionException

findDIPByOperationId

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

Description copied from interface: AccessInternalModule

retrieve a DIP file according to an operationId

Specified by:

findDIPByOperationId in interface AccessInternalModule

Parameters:

id - operation id

Returns:

zip file containing a DIP

Throws:

AccessInternalExecutionException

findTransferSIPByOperationId

public javax.ws.rs.core.Response findTransferSIPByOperationId(java.lang.String id)
                                                       throws AccessInternalExecutionException

Description copied from interface: AccessInternalModule

retrieve a SIP file according to an operationId

Specified by:

findTransferSIPByOperationId in interface AccessInternalModule

Parameters:

id - operation id

Returns:

zip file containing a SIP

Throws:

AccessInternalExecutionException

selectObjects

public com.fasterxml.jackson.databind.JsonNode selectObjects(com.fasterxml.jackson.databind.JsonNode jsonQuery)
                                                      throws java.lang.IllegalArgumentException,
                                                             InvalidParseOperationException,
                                                             AccessInternalExecutionException

select Object

Specified by:

selectObjects in interface AccessInternalModule

Parameters:

jsonQuery - as String { $query : query}

Returns:

the result of the select on object

Throws:

InvalidParseOperationException - Throw if json format is not correct

AccessInternalExecutionException - Throw if error occurs when send Object to database

java.lang.IllegalArgumentException - if json query is null

selectUnitsWithInheritedRules

public com.fasterxml.jackson.databind.JsonNode selectUnitsWithInheritedRules(com.fasterxml.jackson.databind.JsonNode jsonQuery)
                                                                      throws java.lang.IllegalArgumentException,
                                                                             InvalidParseOperationException,
                                                                             AccessInternalExecutionException

Description copied from interface: AccessInternalModule

Select units by DSL and computes inherited rules for matching units

Specified by:

selectUnitsWithInheritedRules in interface AccessInternalModule

Parameters:

jsonQuery - the query DSL

Returns:

the selected units with there inherited rules

Throws:

java.lang.IllegalArgumentException - Throw if json format is not correct

InvalidParseOperationException

AccessInternalExecutionException - Throw if error occurs when send Unit to database