fr.gouv.vitam.metadata.client

Class MetaDataClientMock

java.lang.Object

fr.gouv.vitam.common.client.AbstractMockClient

fr.gouv.vitam.metadata.client.MetaDataClientMock

All Implemented Interfaces:

BasicClient, MockOrRestClient, VitamAutoCloseable, MetaDataClient, AutoCloseable

public class MetaDataClientMock
extends AbstractMockClient
implements MetaDataClient

Mock client implementation for metadata

Nested Class Summary

Nested classes/interfaces inherited from class fr.gouv.vitam.common.client.AbstractMockClient

AbstractMockClient.FakeInboundResponse

Field Summary

Fields inherited from class fr.gouv.vitam.common.client.AbstractMockClient

INTERNAL_SERVER_ERROR

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

STATUS_URL

Constructor Summary

Constructors

Constructor and Description
MetaDataClientMock()

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 objectGroup, 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 class fr.gouv.vitam.common.client.AbstractMockClient

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Constructor Detail

MetaDataClientMock

public MetaDataClientMock()

Method Detail

insertUnit

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

Specified by:

insertUnit in interface MetaDataClient

Parameters:

insertQuery - as JsonNode
null is not allowed

Returns:

the result as JsonNode

Throws:

InvalidParseOperationException

MetaDataExecutionException

MetaDataNotFoundException

MetaDataAlreadyExistException

MetaDataDocumentSizeException

MetaDataClientServerException

selectUnits

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

Description copied from interface: MetaDataClient

Search units by select query (DSL)

Specified by:

selectUnits in interface MetaDataClient

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)

MetaDataDocumentSizeException - thrown when Query document Size is Too Large

InvalidParseOperationException

MetaDataClientServerException

selectUnitbyId

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

Description copied from interface: MetaDataClient

Search units by query (DSL) and path unit id

Specified by:

selectUnitbyId in interface MetaDataClient

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)

MetaDataDocumentSizeException - thrown when Query document Size is Too Large

InvalidParseOperationException

MetaDataClientServerException

selectObjectGrouptbyId

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

Description copied from interface: MetaDataClient

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

Specified by:

selectObjectGrouptbyId in interface MetaDataClient

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)

MetaDataDocumentSizeException - thrown when Query document Size is Too Large

InvalidParseOperationException - thrown when the Query is badly formatted or objectGroupId is empty

MetadataInvalidSelectException - thrown when objectGroupId or selectQuery id is null or blank

MetaDataClientServerException

updateUnitbyId

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

Description copied from interface: MetaDataClient

Update units by query (DSL) and path unit id

Specified by:

updateUnitbyId in interface MetaDataClient

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)

MetaDataDocumentSizeException - thrown when Query document Size is Too Large

InvalidParseOperationException

MetaDataClientServerException

insertObjectGroup

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

Specified by:

insertObjectGroup in interface MetaDataClient

Parameters:

insertQuery - as String

Returns:

response as JsonNode contains the request result

Throws:

InvalidParseOperationException

MetaDataExecutionException

MetaDataNotFoundException

MetaDataAlreadyExistException

MetaDataDocumentSizeException

MetaDataClientServerException

selectAccessionRegisterOnUnitByOperationId

public List<UnitPerOriginatingAgency> selectAccessionRegisterOnUnitByOperationId(String operationId)
                                                                          throws MetaDataClientServerException

Specified by:

selectAccessionRegisterOnUnitByOperationId in interface MetaDataClient

Returns:

the list of UnitsPerOriginatingAgency

Throws:

MetaDataClientServerException

selectAccessionRegisterOnObjectByOperationId

public List<ObjectGroupPerOriginatingAgency> selectAccessionRegisterOnObjectByOperationId(String operationId)
                                                                                   throws MetaDataClientServerException

Specified by:

selectAccessionRegisterOnObjectByOperationId in interface MetaDataClient

Returns:

the list of ObjectGroupPerOriginatingAgency

Throws:

MetaDataClientServerException

selectObjectGroups

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

Description copied from interface: MetaDataClient

Search objectgroups by select query (DSL)

Specified by:

selectObjectGroups in interface MetaDataClient

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)

MetaDataDocumentSizeException - thrown when Query document Size is Too Large

InvalidParseOperationException

MetaDataClientServerException

updateObjectGroupById

public void updateObjectGroupById(com.fasterxml.jackson.databind.JsonNode objectGroup,
                                  String objectGroupId)

Description copied from interface: MetaDataClient

Update ObjectGroup

Specified by:

updateObjectGroupById in interface MetaDataClient

flushUnits

public boolean flushUnits()

Specified by:

flushUnits in interface MetaDataClient

Returns:

True if the Units index is flushed

flushObjectGroups

public boolean flushObjectGroups()

Specified by:

flushObjectGroups in interface MetaDataClient

Returns:

True if the ObjectGroups index is flushed

reindex

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

Description copied from interface: MetaDataClient

Reindex a collection with parameters

Specified by:

reindex in interface MetaDataClient

Parameters:

indexParam - reindexation parameters

Returns:

JsonObject containing information about the newly created index

Throws:

InvalidParseOperationException

MetaDataClientServerException

MetaDataNotFoundException - in case the index does not exist

switchIndexes

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

Description copied from interface: MetaDataClient

Switch indexes

Specified by:

switchIndexes in interface MetaDataClient

Parameters:

switchIndexParam - switch index parameters

Returns:

JsonObject containing information about the newly created index

Throws:

InvalidParseOperationException

MetaDataClientServerException

MetaDataNotFoundException - in case the index does not exist

getUnitByIdRaw

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

Description copied from interface: MetaDataClient

Search units by path unit id

Specified by:

getUnitByIdRaw in interface MetaDataClient

Parameters:

unitId - : unit id
null and blank is not allowed

Returns:

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

Throws:

VitamClientException

getObjectGroupByIdRaw

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> getObjectGroupByIdRaw(String objectGroupId)
                                                                               throws VitamClientException

Description copied from interface: MetaDataClient

Search object group by path unit id

Specified by:

getObjectGroupByIdRaw in interface MetaDataClient

Parameters:

objectGroupId - : objectGroup id
null and blank is not allowed

Returns:

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

Throws:

VitamClientException