MetaDataClient (Vitam API Reference (1.10.0-1))

All Superinterfaces:

AutoCloseable, BasicClient, MockOrRestClient, VitamAutoCloseable

All Known Implementing Classes:

MetaDataClientMock, MetaDataClientRest
```
public interface MetaDataClient
extends BasicClient
```
Metadata client interface

Field Summary
- Fields inherited from interface fr.gouv.vitam.common.client.BasicClient
  STATUS_URL

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`GraphComputeResponse`	`computeGraph(GraphComputeResponse.GraphComputeAction action, Set<String> ids)` Compute graph of all document match ids.
`GraphComputeResponse`	`computeGraph(com.fasterxml.jackson.databind.JsonNode queryDsl)` Compute graph of all Units/Got that match the given query dsl The returned number of treated object group is an estimation, as object group can be computed several times
`com.fasterxml.jackson.databind.JsonNode`	`createAccessionRegisterSymbolic()` Creates the AccessionRegisterSymbolics from ElasticSearch aggregations and nested aggregation request.
`void`	`deleteObjectGroupBulk(Collection<String> listIds)` Delete Object Group Bulk
`void`	`deleteUnitsBulk(Collection<String> listIds)` delete UnitsBulk
`void`	`exportReclassificationChildNodes(Set<String> ids, String unitsToUpdateChainedFileName, String objectGroupsToUpdateChainedFileName)` Export all units and object groups that are a descendants of the provided units to workspace for graph update.
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`getObjectGroupByIdRaw(String objectGroupId)` Search object group by path unit id
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`getUnitByIdRaw(String unitId)` Search units by path unit id
`com.fasterxml.jackson.databind.JsonNode`	`insertObjectGroup(com.fasterxml.jackson.databind.JsonNode insertQuery)`
`com.fasterxml.jackson.databind.JsonNode`	`insertObjectGroups(List<com.fasterxml.jackson.databind.JsonNode> insertQuery)`
`com.fasterxml.jackson.databind.JsonNode`	`insertUnit(com.fasterxml.jackson.databind.JsonNode insertQuery)`
`com.fasterxml.jackson.databind.JsonNode`	`insertUnitBulk(List<com.fasterxml.jackson.databind.node.ObjectNode> insertQuery)`
`boolean`	`refreshObjectGroups()`
`boolean`	`refreshUnits()`
`com.fasterxml.jackson.databind.JsonNode`	`reindex(IndexParameters indexParam)` Reindex a collection with parameters
`List<ObjectGroupPerOriginatingAgency>`	`selectAccessionRegisterOnObjectByOperationId(String operationId)`
`List<UnitPerOriginatingAgency>`	`selectAccessionRegisterOnUnitByOperationId(String operationId)`
`com.fasterxml.jackson.databind.JsonNode`	`selectObjectGroups(com.fasterxml.jackson.databind.JsonNode selectQuery)` Search objectgroups by select query (DSL)
`com.fasterxml.jackson.databind.JsonNode`	`selectObjectGrouptbyId(com.fasterxml.jackson.databind.JsonNode selectQuery, String objectGroupId)` Search Object Group by query (DSL) and path objectGroup id
`com.fasterxml.jackson.databind.JsonNode`	`selectUnitbyId(com.fasterxml.jackson.databind.JsonNode selectQuery, String unitId)` Search units by query (DSL) and path unit id
`com.fasterxml.jackson.databind.JsonNode`	`selectUnits(com.fasterxml.jackson.databind.JsonNode selectQuery)` Search units by select query (DSL)
`com.fasterxml.jackson.databind.JsonNode`	`selectUnitsWithInheritedRules(com.fasterxml.jackson.databind.JsonNode selectQuery)` Select units with inherited rules by select query (DSL)
`com.fasterxml.jackson.databind.JsonNode`	`switchIndexes(SwitchIndexParameters switchIndexParam)` Switch indexes
`void`	`updateObjectGroupById(com.fasterxml.jackson.databind.JsonNode updateQuery, String objectGroupId)` Update ObjectGroup
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`updateUnitBulk(com.fasterxml.jackson.databind.JsonNode updateQuery)` Update units Bulk.
`com.fasterxml.jackson.databind.JsonNode`	`updateUnitbyId(com.fasterxml.jackson.databind.JsonNode updateQuery, String unitId)` Update units by query (DSL) and path unit id
`RequestResponse<com.fasterxml.jackson.databind.JsonNode>`	`updateUnitsRulesBulk(com.fasterxml.jackson.databind.JsonNode query, com.fasterxml.jackson.databind.JsonNode actions, Map<String,DurationData> rulesToDurationData)` Update units rules Bulk.

Methods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient
checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Method Detail

insertUnit

com.fasterxml.jackson.databind.JsonNode insertUnit(com.fasterxml.jackson.databind.JsonNode insertQuery)
                                            throws InvalidParseOperationException,
                                                   MetaDataExecutionException,
                                                   MetaDataNotFoundException,
                                                   MetaDataAlreadyExistException,
                                                   MetaDataDocumentSizeException,
                                                   MetaDataClientServerException

Parameters:: insertQuery - as JsonNode
null is not allowed
Returns:: the result as JsonNode
Throws:: InvalidParseOperationException; MetaDataExecutionException; MetaDataNotFoundException; MetaDataAlreadyExistException; MetaDataDocumentSizeException; MetaDataClientServerException

insertUnitBulk

com.fasterxml.jackson.databind.JsonNode insertUnitBulk(List<com.fasterxml.jackson.databind.node.ObjectNode> insertQuery)
                                                throws InvalidParseOperationException,
                                                       MetaDataExecutionException,
                                                       MetaDataNotFoundException,
                                                       MetaDataAlreadyExistException,
                                                       MetaDataDocumentSizeException,
                                                       MetaDataClientServerException

Throws:: InvalidParseOperationException; MetaDataExecutionException; MetaDataNotFoundException; MetaDataAlreadyExistException; MetaDataDocumentSizeException; MetaDataClientServerException

selectUnits

com.fasterxml.jackson.databind.JsonNode selectUnits(com.fasterxml.jackson.databind.JsonNode selectQuery)
                                             throws MetaDataExecutionException,
                                                    MetaDataDocumentSizeException,
                                                    InvalidParseOperationException,
                                                    MetaDataClientServerException

Search units by select query (DSL)

Parameters:: selectQuery - : select query SelectMultiQuery as String
Null is not allowed
Returns:: Json object {$hint:{},$result:[{},{}]}
Throws:: MetaDataExecutionException - thrown when internal Server Error (fatal technical exception thrown); InvalidParseOperationException; MetaDataDocumentSizeException - thrown when Query document Size is Too Large; MetaDataClientServerException

selectUnitbyId

com.fasterxml.jackson.databind.JsonNode selectUnitbyId(com.fasterxml.jackson.databind.JsonNode selectQuery,
                                                       String unitId)
                                                throws MetaDataExecutionException,
                                                       MetaDataDocumentSizeException,
                                                       InvalidParseOperationException,
                                                       MetaDataClientServerException

Search units by query (DSL) and path unit id

Parameters:: selectQuery - : select query Select as JsonNode
Null is not allowed; unitId - : unit id
null and blank is not allowed
Returns:: Json object {$hint:{},$result:[{},{}]}
Throws:: MetaDataExecutionException - thrown when internal Server Error (fatal technical exception thrown); InvalidParseOperationException; MetaDataDocumentSizeException - thrown when Query document Size is Too Large; MetaDataClientServerException

selectObjectGrouptbyId

com.fasterxml.jackson.databind.JsonNode selectObjectGrouptbyId(com.fasterxml.jackson.databind.JsonNode selectQuery,
                                                               String objectGroupId)
                                                        throws MetaDataExecutionException,
                                                               MetaDataDocumentSizeException,
                                                               InvalidParseOperationException,
                                                               MetadataInvalidSelectException,
                                                               MetaDataClientServerException

Search Object Group by query (DSL) and path objectGroup id

Parameters:: selectQuery - : select query Select as JsonNode
Null is not allowed; objectGroupId - : objectGroup id
null and blank is not allowed
Returns:: Json object {$hint:{},$result:[{},{}]}
Throws:: MetaDataExecutionException - thrown when internal Server Error (fatal technical exception thrown); InvalidParseOperationException - thrown when the Query is badly formatted or objectGroupId is empty; MetaDataDocumentSizeException - thrown when Query document Size is Too Large; MetadataInvalidSelectException - thrown when objectGroupId or selectQuery id is null or blank; MetaDataClientServerException

updateUnitbyId

com.fasterxml.jackson.databind.JsonNode updateUnitbyId(com.fasterxml.jackson.databind.JsonNode updateQuery,
                                                       String unitId)
                                                throws MetaDataNotFoundException,
                                                       MetaDataExecutionException,
                                                       MetaDataDocumentSizeException,
                                                       InvalidParseOperationException,
                                                       MetaDataClientServerException

Update units by query (DSL) and path unit id

Parameters:: updateQuery - update query Select as JsonNode
Null is not allowed; unitId - unit id
null and blank is not allowed
Returns:: Json object {$hint:{},$result:[{},{}]}
Throws:: MetaDataExecutionException - thrown when internal Server Error (fatal technical exception thrown); InvalidParseOperationException; MetaDataDocumentSizeException - thrown when Query document Size is Too Large; MetaDataNotFoundException; MetaDataClientServerException

insertObjectGroup

com.fasterxml.jackson.databind.JsonNode insertObjectGroup(com.fasterxml.jackson.databind.JsonNode insertQuery)
                                                   throws InvalidParseOperationException,
                                                          MetaDataExecutionException,
                                                          MetaDataNotFoundException,
                                                          MetaDataAlreadyExistException,
                                                          MetaDataDocumentSizeException,
                                                          MetaDataClientServerException

Parameters:: insertQuery - as String
Returns:: response as JsonNode contains the request result
Throws:: InvalidParseOperationException; MetaDataExecutionException; MetaDataNotFoundException; MetaDataAlreadyExistException; MetaDataDocumentSizeException; MetaDataClientServerException

updateObjectGroupById

void updateObjectGroupById(com.fasterxml.jackson.databind.JsonNode updateQuery,
                           String objectGroupId)
                    throws InvalidParseOperationException,
                           MetaDataClientServerException,
                           MetaDataExecutionException

Update ObjectGroup

Parameters:: updateQuery -; objectGroupId -
Throws:: InvalidParseOperationException; MetaDataNotFoundException; MetaDataAlreadyExistException; MetaDataDocumentSizeException; MetaDataClientServerException; MetaDataExecutionException

insertObjectGroups

com.fasterxml.jackson.databind.JsonNode insertObjectGroups(List<com.fasterxml.jackson.databind.JsonNode> insertQuery)
                                                    throws InvalidParseOperationException,
                                                           MetaDataExecutionException,
                                                           MetaDataNotFoundException,
                                                           MetaDataAlreadyExistException,
                                                           MetaDataDocumentSizeException,
                                                           MetaDataClientServerException

Throws:: InvalidParseOperationException; MetaDataExecutionException; MetaDataNotFoundException; MetaDataAlreadyExistException; MetaDataDocumentSizeException; MetaDataClientServerException

selectAccessionRegisterOnUnitByOperationId

List<UnitPerOriginatingAgency> selectAccessionRegisterOnUnitByOperationId(String operationId)
                                                                   throws MetaDataClientServerException

Parameters:: operationId -
Returns:: the list of UnitsPerOriginatingAgency
Throws:: MetaDataClientServerException

selectAccessionRegisterOnObjectByOperationId

List<ObjectGroupPerOriginatingAgency> selectAccessionRegisterOnObjectByOperationId(String operationId)
                                                                            throws MetaDataClientServerException

Parameters:: operationId -
Returns:: the list of ObjectGroupPerOriginatingAgency
Throws:: MetaDataClientServerException

selectObjectGroups

com.fasterxml.jackson.databind.JsonNode selectObjectGroups(com.fasterxml.jackson.databind.JsonNode selectQuery)
                                                    throws MetaDataExecutionException,
                                                           MetaDataDocumentSizeException,
                                                           InvalidParseOperationException,
                                                           MetaDataClientServerException

Search objectgroups by select query (DSL)

Parameters:: selectQuery - : select query SelectMultiQuery as String
Null is not allowed
Returns:: Json object {$hint:{},$result:[{},{}]}
Throws:: MetaDataExecutionException - thrown when internal Server Error (fatal technical exception thrown); InvalidParseOperationException; MetaDataDocumentSizeException - thrown when Query document Size is Too Large; MetaDataClientServerException

refreshUnits
```
boolean refreshUnits()
              throws MetaDataClientServerException
```
Returns:

True if the Units index is refreshed

Throws:

MetaDataClientServerException

refreshObjectGroups
```
boolean refreshObjectGroups()
                     throws MetaDataClientServerException
```
Returns:

True if the ObjectGroups index is refreshed

Throws:

MetaDataClientServerException

reindex

com.fasterxml.jackson.databind.JsonNode reindex(IndexParameters indexParam)
                                         throws InvalidParseOperationException,
                                                MetaDataClientServerException,
                                                MetaDataNotFoundException

Reindex a collection with parameters

Parameters:: indexParam - reindexation parameters
Returns:: JsonObject containing information about the newly created index
Throws:: MetaDataClientServerException; MetaDataNotFoundException - in case the index does not exist; InvalidParseOperationException

switchIndexes

com.fasterxml.jackson.databind.JsonNode switchIndexes(SwitchIndexParameters switchIndexParam)
                                               throws InvalidParseOperationException,
                                                      MetaDataClientServerException,
                                                      MetaDataNotFoundException

Switch indexes

Parameters:: switchIndexParam - switch index parameters
Returns:: JsonObject containing information about the newly created index
Throws:: MetaDataClientServerException; MetaDataNotFoundException - in case the index does not exist; InvalidParseOperationException

getUnitByIdRaw

RequestResponse<com.fasterxml.jackson.databind.JsonNode> getUnitByIdRaw(String unitId)
                                                                 throws VitamClientException

Search units by path unit id

Parameters:: unitId - : unit id
null and blank is not allowed
Returns:: Json object {$hint:{},$result:[{}]} or vitam error
Throws:: VitamClientException

getObjectGroupByIdRaw
```
RequestResponse<com.fasterxml.jackson.databind.JsonNode> getObjectGroupByIdRaw(String objectGroupId)
                                                                        throws VitamClientException
```
Search object group by path unit id

Parameters:

objectGroupId - : objectGroup id
null and blank is not allowed

Returns:

Json object {$hint:{},$result:[{}]} or vitam error

Throws:

VitamClientException

computeGraph
```
GraphComputeResponse computeGraph(com.fasterxml.jackson.databind.JsonNode queryDsl)
                           throws VitamClientException
```
Compute graph of all Units/Got that match the given query dsl The returned number of treated object group is an estimation, as object group can be computed several times

Parameters:

queryDsl -

Returns:

GraphComputeResponse

Throws:

VitamClientException

computeGraph
```
GraphComputeResponse computeGraph(GraphComputeResponse.GraphComputeAction action,
                                  Set<String> ids)
                           throws VitamClientException
```
Compute graph of all document match ids. The document can be UNIT, OBJECTGROUP, or UNIT AND OBJECTGROUP In case of UNIT AND OBJECTGROUP, the ids set is id of UNITs

Parameters:

action -

ids -

Returns:

GraphComputeResponse

Throws:

VitamClientException

updateUnitBulk

RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateUnitBulk(com.fasterxml.jackson.databind.JsonNode updateQuery)
                                                                 throws InvalidParseOperationException,
                                                                        MetaDataExecutionException,
                                                                        MetaDataNotFoundException,
                                                                        MetaDataDocumentSizeException,
                                                                        MetaDataClientServerException

Update units Bulk.

Parameters:: updateQuery -
Returns:
Throws:: InvalidParseOperationException; MetaDataExecutionException; MetaDataNotFoundException; MetaDataDocumentSizeException; MetaDataClientServerException

updateUnitsRulesBulk

RequestResponse<com.fasterxml.jackson.databind.JsonNode> updateUnitsRulesBulk(com.fasterxml.jackson.databind.JsonNode query,
                                                                              com.fasterxml.jackson.databind.JsonNode actions,
                                                                              Map<String,DurationData> rulesToDurationData)
                                                                       throws InvalidParseOperationException,
                                                                              MetaDataExecutionException,
                                                                              MetaDataNotFoundException,
                                                                              MetaDataDocumentSizeException,
                                                                              MetaDataClientServerException

Update units rules Bulk.

Parameters:: query -; actions -
Returns:
Throws:: InvalidParseOperationException; MetaDataExecutionException; MetaDataNotFoundException; MetaDataDocumentSizeException; MetaDataClientServerException

exportReclassificationChildNodes

void exportReclassificationChildNodes(Set<String> ids,
                                      String unitsToUpdateChainedFileName,
                                      String objectGroupsToUpdateChainedFileName)
                               throws VitamClientException,
                                      MetaDataExecutionException

Export all units and object groups that are a descendants of the provided units to workspace for graph update.

Parameters:: ids - the unit ids for which all descendant nodes (units and object groups) are to be updated.
Throws:: VitamClientException; MetaDataExecutionException

selectUnitsWithInheritedRules

com.fasterxml.jackson.databind.JsonNode selectUnitsWithInheritedRules(com.fasterxml.jackson.databind.JsonNode selectQuery)
                                                               throws MetaDataDocumentSizeException,
                                                                      InvalidParseOperationException,
                                                                      MetaDataClientServerException,
                                                                      MetaDataExecutionException

Select units with inherited rules by select query (DSL)

Parameters:: selectQuery - : select query
Returns:: Json object
Throws:: InvalidParseOperationException; MetaDataDocumentSizeException - thrown when Query document Size is Too Large; MetaDataClientServerException; MetaDataExecutionException

createAccessionRegisterSymbolic
```
com.fasterxml.jackson.databind.JsonNode createAccessionRegisterSymbolic()
                                                                 throws MetaDataClientServerException,
                                                                        MetaDataExecutionException
```
Creates the AccessionRegisterSymbolics from ElasticSearch aggregations and nested aggregation request. Because the AccessionRegisterSymbolic is not available from this package, it is a JsonNode which is returned.

Returns:

a list of AccessionRegisterSymbolic as JsonNode

Throws:

MetaDataClientServerException

MetaDataExecutionException

deleteUnitsBulk
```
void deleteUnitsBulk(Collection<String> listIds)
              throws MetaDataExecutionException,
                     MetaDataClientServerException
```
delete UnitsBulk

Parameters:

listIds - list of id to delete

Throws:

MetaDataExecutionException - MetaDataExecutionException

MetaDataClientServerException - MetaDataClientServerException

deleteObjectGroupBulk

void deleteObjectGroupBulk(Collection<String> listIds)
                    throws MetaDataExecutionException,
                           InvalidParseOperationException,
                           MetaDataClientServerException

Delete Object Group Bulk

Parameters:: listIds - list of id to delete
Throws:: MetaDataExecutionException - MetaDataExecutionException; MetaDataClientServerException - MetaDataClientServerException; InvalidParseOperationException

Interface MetaDataClient

Field Summary

Fields inherited from interface fr.gouv.vitam.common.client.BasicClient