fr.gouv.vitam.metadata.core.database.collections

Class DbRequest

java.lang.Object

fr.gouv.vitam.metadata.core.database.collections.DbRequest

public class DbRequest
extends Object

DB Request using MongoDB only

Constructor Summary

Constructors

Constructor and Description
DbRequest() Constructor
DbRequest(String fileNameTriggersConfig) Constructor

Method Summary

Modifier and Type	Method and Description
protected Set<String>	aggregateUnitDepths(Collection<String> ids, int relativeDepth) Aggregate Unit Depths according to parent relative Depth
protected Result<MetadataDocument<?>>	checkObjectGroupStartupRoots(RequestParserMultiple request) Check ObjectGroup at startup against Roots
protected Set<String>	checkUnitAgainstRoots(Set<String> current, Result<MetadataDocument<?>> defaultStartSet) Check Unit parents against Roots
protected Result<MetadataDocument<?>>	checkUnitStartupRoots(RequestParserMultiple request) Check Unit at startup against Roots
void	deleteObjectGroups(List<String> documentsToDelete) Delete object groups
void	deleteUnits(List<String> documentsToDelete) Delete units
protected Result<MetadataDocument<?>>	exactDepthUnitQuery(Query realQuery, Result<MetadataDocument<?>> previous, int exactDepth, Integer tenantId, List<org.elasticsearch.search.sort.SortBuilder> sorts, int offset, int limit, List<org.elasticsearch.search.aggregations.AggregationBuilder> facets, String scrollId, Integer scrollTimeout) Execute one Unit Query using exact Depth
void	execInsertObjectGroupRequests(List<InsertParserMultiple> requestParsers) Inserts an object group
void	execInsertUnitRequest(InsertParserMultiple requestParser) Inserts a unit
void	execInsertUnitRequests(Collection<InsertParserMultiple> requestParsers) Inserts a unit
Result	execRequest(RequestParserMultiple requestParser) The request should be already analyzed.
Result	execRuleRequest(String unitId, RuleActions ruleActions, Map<String,DurationData> bindRuleToDuration) Execute rule action on unit
protected Result<MetadataDocument<?>>	executeQuery(RequestParserMultiple requestParser, RequestToAbstract requestToMongodb, int rank, Result<MetadataDocument<?>> previous) Execute one request
protected Result<MetadataDocument<?>>	lastDeleteFilterProjection(DeleteToMongodb requestToMongodb, Result<MetadataDocument<?>> last) Finalize the queries with last True Delete
protected Result<MetadataDocument<?>>	lastSelectFilterProjection(SelectToMongodb requestToMongodb, Result<MetadataDocument<?>> last, boolean checkConsistency) Finalize the queries with last True Select
protected Result<MetadataDocument<?>>	lastUpdateFilterProjection(UpdateToMongodb requestToMongodb, Result<MetadataDocument<?>> last, RequestParserMultiple requestParser) Finalize the queries with last True Update
protected Result<MetadataDocument<?>>	objectGroupQuery(Query realQuery, Result<MetadataDocument<?>> previous, Integer tenantId, List<org.elasticsearch.search.sort.SortBuilder> sorts, int offset, int limit, String scrollId, Integer scrollTimeout, List<org.elasticsearch.search.aggregations.AggregationBuilder> facets) Execute one relative Depth ObjectGroup Query
protected Result<MetadataDocument<?>>	relativeDepthUnitQuery(Query realQuery, Result<MetadataDocument<?>> previous, int relativeDepth, Integer tenantId, List<org.elasticsearch.search.sort.SortBuilder> sorts, int offset, int limit, List<org.elasticsearch.search.aggregations.AggregationBuilder> facets, String scrollId, Integer scrollTimeout) Execute one relative Depth Unit Query
protected Result<MetadataDocument<?>>	sameDepthUnitQuery(Query realQuery, Result<MetadataDocument<?>> previous, Integer tenantId, List<org.elasticsearch.search.sort.SortBuilder> sorts, int offset, int limit, List<org.elasticsearch.search.aggregations.AggregationBuilder> facets, String scrollId, Integer scrollTimeout) Execute one relative Depth Unit Query

Methods inherited from class java.lang.Object

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

Constructor Detail

DbRequest

public DbRequest()

Constructor

DbRequest

public DbRequest(String fileNameTriggersConfig)
          throws ChangesTriggerConfigFileException

Constructor

Throws:

ChangesTriggerConfigFileException

Method Detail

execRuleRequest

public Result execRuleRequest(String unitId,
                              RuleActions ruleActions,
                              Map<String,DurationData> bindRuleToDuration)
                       throws InvalidParseOperationException,
                              MetaDataExecutionException,
                              SchemaValidationException

Execute rule action on unit

Parameters:

unitId - the unitId

ruleActions - the list of ruleAction (by category)

Returns:

the result

Throws:

InvalidParseOperationException

MetaDataExecutionException

SchemaValidationException

execRequest

public Result execRequest(RequestParserMultiple requestParser)
                   throws MetaDataExecutionException,
                          InvalidParseOperationException,
                          BadRequestException,
                          VitamDBException

The request should be already analyzed.

Parameters:

requestParser - the RequestParserMultiple to execute

Returns:

the Result

Throws:

MetaDataExecutionException - when select/update/delete on metadata collection exception occurred

InvalidParseOperationException - when json data exception occurred

BadRequestException

VitamDBException

checkUnitStartupRoots

protected Result<MetadataDocument<?>> checkUnitStartupRoots(RequestParserMultiple request)

Check Unit at startup against Roots

Parameters:

request -

Returns:

the valid root ids

checkObjectGroupStartupRoots

protected Result<MetadataDocument<?>> checkObjectGroupStartupRoots(RequestParserMultiple request)

Check ObjectGroup at startup against Roots

Parameters:

request -

Returns:

the valid root ids

checkUnitAgainstRoots

protected Set<String> checkUnitAgainstRoots(Set<String> current,
                                            Result<MetadataDocument<?>> defaultStartSet)

Check Unit parents against Roots

Parameters:

current - set of result id

defaultStartSet -

Returns:

the valid root ids set

executeQuery

protected Result<MetadataDocument<?>> executeQuery(RequestParserMultiple requestParser,
                                                   RequestToAbstract requestToMongodb,
                                                   int rank,
                                                   Result<MetadataDocument<?>> previous)
                                            throws MetaDataExecutionException,
                                                   InvalidParseOperationException,
                                                   BadRequestException

Execute one request

Parameters:

requestToMongodb -

rank - current rank query

previous - previous Result from previous level (except in level == 0 where it is the subset of valid roots)

Returns:

the new Result from this request

Throws:

MetaDataExecutionException

InvalidParseOperationException

BadRequestException

exactDepthUnitQuery

protected Result<MetadataDocument<?>> exactDepthUnitQuery(Query realQuery,
                                                          Result<MetadataDocument<?>> previous,
                                                          int exactDepth,
                                                          Integer tenantId,
                                                          List<org.elasticsearch.search.sort.SortBuilder> sorts,
                                                          int offset,
                                                          int limit,
                                                          List<org.elasticsearch.search.aggregations.AggregationBuilder> facets,
                                                          String scrollId,
                                                          Integer scrollTimeout)
                                                   throws InvalidParseOperationException,
                                                          MetaDataExecutionException,
                                                          BadRequestException

Execute one Unit Query using exact Depth

Parameters:

realQuery -

previous -

exactDepth -

tenantId -

sorts -

offset -

limit -

facets -

Returns:

the associated Result

Throws:

InvalidParseOperationException

MetaDataExecutionException

BadRequestException

relativeDepthUnitQuery

protected Result<MetadataDocument<?>> relativeDepthUnitQuery(Query realQuery,
                                                             Result<MetadataDocument<?>> previous,
                                                             int relativeDepth,
                                                             Integer tenantId,
                                                             List<org.elasticsearch.search.sort.SortBuilder> sorts,
                                                             int offset,
                                                             int limit,
                                                             List<org.elasticsearch.search.aggregations.AggregationBuilder> facets,
                                                             String scrollId,
                                                             Integer scrollTimeout)
                                                      throws InvalidParseOperationException,
                                                             MetaDataExecutionException,
                                                             BadRequestException

Execute one relative Depth Unit Query

Parameters:

realQuery -

previous -

relativeDepth -

tenantId -

sorts -

offset -

limit -

facets -

Returns:

the associated Result

Throws:

InvalidParseOperationException

MetaDataExecutionException

BadRequestException

aggregateUnitDepths

protected Set<String> aggregateUnitDepths(Collection<String> ids,
                                          int relativeDepth)

Aggregate Unit Depths according to parent relative Depth

Parameters:

ids -

relativeDepth -

Returns:

the aggregate set of multi level parents for this relativeDepth

sameDepthUnitQuery

protected Result<MetadataDocument<?>> sameDepthUnitQuery(Query realQuery,
                                                         Result<MetadataDocument<?>> previous,
                                                         Integer tenantId,
                                                         List<org.elasticsearch.search.sort.SortBuilder> sorts,
                                                         int offset,
                                                         int limit,
                                                         List<org.elasticsearch.search.aggregations.AggregationBuilder> facets,
                                                         String scrollId,
                                                         Integer scrollTimeout)
                                                  throws InvalidParseOperationException,
                                                         MetaDataExecutionException,
                                                         BadRequestException

Execute one relative Depth Unit Query

Parameters:

realQuery -

previous -

tenantId -

sorts -

offset -

limit -

facets -

Returns:

the associated Result

Throws:

InvalidParseOperationException

MetaDataExecutionException

BadRequestException

objectGroupQuery

protected Result<MetadataDocument<?>> objectGroupQuery(Query realQuery,
                                                       Result<MetadataDocument<?>> previous,
                                                       Integer tenantId,
                                                       List<org.elasticsearch.search.sort.SortBuilder> sorts,
                                                       int offset,
                                                       int limit,
                                                       String scrollId,
                                                       Integer scrollTimeout,
                                                       List<org.elasticsearch.search.aggregations.AggregationBuilder> facets)
                                                throws InvalidParseOperationException,
                                                       MetaDataExecutionException,
                                                       BadRequestException

Execute one relative Depth ObjectGroup Query

Parameters:

realQuery -

previous - units, Note: only immediate Unit parents are allowed

tenantId -

sorts -

offset -

limit -

Returns:

the associated Result

Throws:

InvalidParseOperationException

MetaDataExecutionException

BadRequestException

lastSelectFilterProjection

protected Result<MetadataDocument<?>> lastSelectFilterProjection(SelectToMongodb requestToMongodb,
                                                                 Result<MetadataDocument<?>> last,
                                                                 boolean checkConsistency)
                                                          throws InvalidParseOperationException,
                                                                 VitamDBException

Finalize the queries with last True Select

Parameters:

requestToMongodb -

last -

Returns:

the final Result

Throws:

InvalidParseOperationException

VitamDBException

lastUpdateFilterProjection

protected Result<MetadataDocument<?>> lastUpdateFilterProjection(UpdateToMongodb requestToMongodb,
                                                                 Result<MetadataDocument<?>> last,
                                                                 RequestParserMultiple requestParser)
                                                          throws InvalidParseOperationException,
                                                                 MetaDataExecutionException

Finalize the queries with last True Update

Parameters:

requestToMongodb -

last -

requestParser -

Returns:

the final Result

Throws:

InvalidParseOperationException

MetaDataExecutionException

MetadataInvalidUpdateException

execInsertUnitRequest

public void execInsertUnitRequest(InsertParserMultiple requestParser)
                           throws MetaDataExecutionException,
                                  MetaDataNotFoundException,
                                  InvalidParseOperationException,
                                  MetaDataAlreadyExistException

Inserts a unit

Parameters:

requestParser - the InsertParserMultiple to execute

Throws:

MetaDataExecutionException - when insert on metadata collection exception occurred

InvalidParseOperationException - when json data exception occurred

MetaDataAlreadyExistException - when insert metadata exception

MetaDataNotFoundException - when metadata not found exception

execInsertObjectGroupRequests

public void execInsertObjectGroupRequests(List<InsertParserMultiple> requestParsers)
                                   throws MetaDataExecutionException,
                                          InvalidParseOperationException,
                                          MetaDataAlreadyExistException

Inserts an object group

Parameters:

requestParsers - the list of InsertParserMultiple to execute

Throws:

MetaDataExecutionException - when insert on metadata collection exception occurred

InvalidParseOperationException - when json data exception occurred

MetaDataAlreadyExistException - when insert metadata exception

lastDeleteFilterProjection

protected Result<MetadataDocument<?>> lastDeleteFilterProjection(DeleteToMongodb requestToMongodb,
                                                                 Result<MetadataDocument<?>> last)
                                                          throws InvalidParseOperationException,
                                                                 MetaDataExecutionException

Finalize the queries with last True Delete

Parameters:

requestToMongodb -

last -

Returns:

the final Result

Throws:

InvalidParseOperationException

MetaDataExecutionException

execInsertUnitRequests

public void execInsertUnitRequests(Collection<InsertParserMultiple> requestParsers)
                            throws MetaDataExecutionException,
                                   MetaDataNotFoundException,
                                   InvalidParseOperationException,
                                   MetaDataAlreadyExistException

Inserts a unit

Parameters:

requestParsers - list of InsertParserMultiple to execute

Throws:

MetaDataExecutionException - when insert on metadata collection exception occurred

InvalidParseOperationException - when json data exception occurred

MetaDataAlreadyExistException - when insert metadata exception

MetaDataNotFoundException - when metadata not found exception

deleteUnits

public void deleteUnits(List<String> documentsToDelete)
                 throws MetaDataExecutionException

Delete units

Throws:

MetaDataExecutionException

deleteObjectGroups

public void deleteObjectGroups(List<String> documentsToDelete)
                        throws MetaDataExecutionException

Delete object groups

Throws:

MetaDataExecutionException