fr.gouv.vitam.metadata.client

Class MetaDataClientRest

java.lang.Object

fr.gouv.vitam.common.client.DefaultClient

fr.gouv.vitam.metadata.client.MetaDataClientRest

All Implemented Interfaces:

BasicClient, MockOrRestClient, VitamAutoCloseable, MetaDataClient, AutoCloseable

public class MetaDataClientRest
extends DefaultClient
implements MetaDataClient

Rest client for metadata

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSISTENCY_ERROR_AN_INTERNAL_DATA_CONSISTENCY_ERROR_HAS_BEEN_DETECTED
static String	DESCRIPTION
protected static String	INTERNAL_SERVER_ERROR

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

STATUS_URL

Constructor Summary

Constructors

Constructor and Description
MetaDataClientRest(VitamClientFactoryInterface factory) Constructor using given scheme (http)

Method Summary

Modifier and Type	Method and Description
void	checkStatus() Check the status from the service
void	checkStatus(javax.ws.rs.core.MultivaluedHashMap<String,Object> headers) Check the status from the service used to passe "X-SSL-CLIENT-CERT" header that contain a pem certificate
void	close() Close the underneath http client
void	consumeAnyEntityAndClose(javax.ws.rs.core.Response response) Helper when an error occurs on client usage side to consume response however
protected VitamClientException	createExceptionFromResponse(javax.ws.rs.core.Response response) Handle all errors and throw a VitamClientException in case the response does not contains a vitamError type result.
boolean	flushObjectGroups()
boolean	flushUnits()
protected javax.ws.rs.client.Client	getClient(boolean chunked)
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	getObjectGroupByIdRaw(String objectGroupId) Search object group by path unit id
String	getResourcePath() Get the resource path of the server.
String	getServiceUrl() Get the service URL
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	getUnitByIdRaw(String unitId) Search units by path unit id
VitamClientFactory<?>	getVitamClientFactory()
com.fasterxml.jackson.databind.JsonNode	insertObjectGroup(com.fasterxml.jackson.databind.JsonNode insertQuery)
com.fasterxml.jackson.databind.JsonNode	insertUnit(com.fasterxml.jackson.databind.JsonNode insertQuery)
protected Future<javax.ws.rs.core.Response>	performAsyncRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept) Perform an Async HTTP request to the server with full control of action on caller
protected <T> Future<T>	performAsyncRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept, javax.ws.rs.client.InvocationCallback<T> callback) Perform an Async HTTP request to the server with callback
protected javax.ws.rs.core.Response	performRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers, javax.ws.rs.core.MediaType accept) Perform a HTTP request to the server for synchronous call
protected javax.ws.rs.core.Response	performRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept) Perform a HTTP request to the server for synchronous call
protected javax.ws.rs.core.Response	performRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept, boolean chunkedMode) Perform a HTTP request to the server for synchronous call
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)
static void	staticConsumeAnyEntityAndClose(javax.ws.rs.core.Response response) This method consume everything (in particular InpuStream) and close the response.
com.fasterxml.jackson.databind.JsonNode	switchIndexes(SwitchIndexParameters switchIndexParam) Switch indexes
String	toString()
void	updateObjectGroupById(com.fasterxml.jackson.databind.JsonNode queryUpdate, 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 java.lang.Object

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

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

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Field Detail

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

CONSISTENCY_ERROR_AN_INTERNAL_DATA_CONSISTENCY_ERROR_HAS_BEEN_DETECTED

public static final String CONSISTENCY_ERROR_AN_INTERNAL_DATA_CONSISTENCY_ERROR_HAS_BEEN_DETECTED

See Also:

Constant Field Values

INTERNAL_SERVER_ERROR

protected static final String INTERNAL_SERVER_ERROR

See Also:

Constant Field Values

Constructor Detail

MetaDataClientRest

public MetaDataClientRest(VitamClientFactoryInterface factory)

Constructor using given scheme (http)

Parameters:

factory - The client factory

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,
                                                           VitamDBException

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

VitamDBException

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

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,
                                                              MetaDataNotFoundException

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

MetaDataNotFoundException

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

updateObjectGroupById

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

Description copied from interface: MetaDataClient

Update ObjectGroup

Specified by:

updateObjectGroupById in interface MetaDataClient

Throws:

InvalidParseOperationException

MetaDataClientServerException

MetaDataExecutionException

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

flushUnits

public boolean flushUnits()
                   throws MetaDataClientServerException

Specified by:

flushUnits in interface MetaDataClient

Returns:

True if the Units index is flushed

Throws:

MetaDataClientServerException

flushObjectGroups

public boolean flushObjectGroups()
                          throws MetaDataClientServerException

Specified by:

flushObjectGroups in interface MetaDataClient

Returns:

True if the ObjectGroups index is flushed

Throws:

MetaDataClientServerException

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

getClient

protected javax.ws.rs.client.Client getClient(boolean chunked)
                                       throws IllegalStateException

Throws:

IllegalStateException

consumeAnyEntityAndClose

public final void consumeAnyEntityAndClose(javax.ws.rs.core.Response response)

Description copied from interface: MockOrRestClient

Helper when an error occurs on client usage side to consume response however

Specified by:

consumeAnyEntityAndClose in interface MockOrRestClient

staticConsumeAnyEntityAndClose

public static final void staticConsumeAnyEntityAndClose(javax.ws.rs.core.Response response)

This method consume everything (in particular InpuStream) and close the response.

Parameters:

response -

checkStatus

public void checkStatus()
                 throws VitamApplicationServerException

Description copied from interface: MockOrRestClient

Check the status from the service

Specified by:

checkStatus in interface MockOrRestClient

Throws:

VitamApplicationServerException - if the Server is unavailable

checkStatus

public void checkStatus(javax.ws.rs.core.MultivaluedHashMap<String,Object> headers)
                 throws VitamApplicationServerException

Description copied from interface: MockOrRestClient

Check the status from the service used to passe "X-SSL-CLIENT-CERT" header that contain a pem certificate

Specified by:

checkStatus in interface MockOrRestClient

Throws:

VitamApplicationServerException - if the Server is unavailable

performRequest

protected javax.ws.rs.core.Response performRequest(String httpMethod,
                                                   String path,
                                                   javax.ws.rs.core.MultivaluedHashMap<String,Object> headers,
                                                   javax.ws.rs.core.MediaType accept)
                                            throws VitamClientInternalException

Perform a HTTP request to the server for synchronous call

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

accept - asked type of response

Returns:

the response from the server

Throws:

VitamClientInternalException

performRequest

protected javax.ws.rs.core.Response performRequest(String httpMethod,
                                                   String path,
                                                   javax.ws.rs.core.MultivaluedHashMap<String,Object> headers,
                                                   Object body,
                                                   javax.ws.rs.core.MediaType contentType,
                                                   javax.ws.rs.core.MediaType accept)
                                            throws VitamClientInternalException

Perform a HTTP request to the server for synchronous call

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

Returns:

the response from the server

Throws:

VitamClientInternalException

performRequest

protected javax.ws.rs.core.Response performRequest(String httpMethod,
                                                   String path,
                                                   javax.ws.rs.core.MultivaluedHashMap<String,Object> headers,
                                                   Object body,
                                                   javax.ws.rs.core.MediaType contentType,
                                                   javax.ws.rs.core.MediaType accept,
                                                   boolean chunkedMode)
                                            throws VitamClientInternalException

Perform a HTTP request to the server for synchronous call

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

chunkedMode - True use default client, else False use non Chunked mode client

Returns:

the response from the server

Throws:

VitamClientInternalException

performAsyncRequest

protected <T> Future<T> performAsyncRequest(String httpMethod,
                                            String path,
                                            javax.ws.rs.core.MultivaluedHashMap<String,Object> headers,
                                            Object body,
                                            javax.ws.rs.core.MediaType contentType,
                                            javax.ws.rs.core.MediaType accept,
                                            javax.ws.rs.client.InvocationCallback<T> callback)
                                     throws VitamClientInternalException

Perform an Async HTTP request to the server with callback

Type Parameters:

T - the type of the Future result (generally Response)

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

callback -

Returns:

the response from the server as Future

Throws:

VitamClientInternalException

performAsyncRequest

protected Future<javax.ws.rs.core.Response> performAsyncRequest(String httpMethod,
                                                                String path,
                                                                javax.ws.rs.core.MultivaluedHashMap<String,Object> headers,
                                                                Object body,
                                                                javax.ws.rs.core.MediaType contentType,
                                                                javax.ws.rs.core.MediaType accept)
                                                         throws VitamClientInternalException

Perform an Async HTTP request to the server with full control of action on caller

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

Returns:

the response from the server as a Future

Throws:

VitamClientInternalException

createExceptionFromResponse

protected VitamClientException createExceptionFromResponse(javax.ws.rs.core.Response response)

Handle all errors and throw a VitamClientException in case the response does not contains a vitamError type result.

Parameters:

response - response

Returns:

VitamClientException exception thrown for the response

getResourcePath

public String getResourcePath()

Description copied from interface: MockOrRestClient

Get the resource path of the server.

Specified by:

getResourcePath in interface MockOrRestClient

Returns:

the resource path as string

getServiceUrl

public String getServiceUrl()

Description copied from interface: MockOrRestClient

Get the service URL

Specified by:

getServiceUrl in interface MockOrRestClient

Returns:

the service URL

close

public void close()

Description copied from interface: MockOrRestClient

Close the underneath http client

Specified by:

close in interface MockOrRestClient

Specified by:

close in interface VitamAutoCloseable

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object

getVitamClientFactory

public VitamClientFactory<?> getVitamClientFactory()

Returns:

the VitamClientFactory