fr.gouv.vitam.metadata.client

Interface MetaDataClient

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

Modifier and Type	Method and Description
boolean	flushObjectGroups()
boolean	flushUnits()
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	insertUnit(com.fasterxml.jackson.databind.JsonNode insertQuery)
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	switchIndexes(SwitchIndexParameters switchIndexParam) Switch indexes
void	updateObjectGroupById(com.fasterxml.jackson.databind.JsonNode updateQuery, String objectGroupId) Update ObjectGroup
com.fasterxml.jackson.databind.JsonNode	updateUnitbyId(com.fasterxml.jackson.databind.JsonNode updateQuery, String unitId) Update units by query (DSL) and path unit id

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

selectUnits

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

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

VitamDBException

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

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

flushUnits

boolean flushUnits()
            throws MetaDataClientServerException

Returns:

True if the Units index is flushed

Throws:

MetaDataClientServerException

flushObjectGroups

boolean flushObjectGroups()
                   throws MetaDataClientServerException

Returns:

True if the ObjectGroups index is flushed

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