fr.gouv.vitam.common.client

Class DefaultAdminClient

java.lang.Object

fr.gouv.vitam.common.client.DefaultAdminClient

All Implemented Interfaces:

AdminClient, BasicClient, MockOrRestClient, VitamAutoCloseable, AutoCloseable

public class DefaultAdminClient
extends Object
implements AdminClient

Abstract Partial client class for all vitam clients

Field Summary

Fields

Modifier and Type	Field and 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
DefaultAdminClient(VitamClientFactoryInterface<DefaultAdminClient> factory) Constructor with standard configuration

Method Summary

Modifier and Type	Method and Description
VitamError	adminAutotest() Check the dependencies and return a VitamError status where getHttpCode contains either 200 for OK or 503 for error and a sub list of VitamErrors for each tested subservices
AdminStatusMessage	adminStatus() Get the administration status from the service
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.
String	getAdminUrl()
protected javax.ws.rs.client.Client	getClient(boolean chunked)
String	getResourcePath() Get the resource path of the server.
String	getServiceUrl() Get the service URL
VitamClientFactory<?>	getVitamClientFactory()
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
static void	staticConsumeAnyEntityAndClose(javax.ws.rs.core.Response response) This method consume everything (in particular InpuStream) and close the response.
String	toString()

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

INTERNAL_SERVER_ERROR

protected static final String INTERNAL_SERVER_ERROR

See Also:

Constant Field Values

Constructor Detail

DefaultAdminClient

public DefaultAdminClient(VitamClientFactoryInterface<DefaultAdminClient> factory)

Constructor with standard configuration

Parameters:

factory - The client factory

Method Detail

adminStatus

public AdminStatusMessage adminStatus()
                               throws VitamClientException

Description copied from interface: AdminClient

Get the administration status from the service

Specified by:

adminStatus in interface AdminClient

Returns:

the AdminStatusMessage

Throws:

VitamClientException - if the Server is unreachable

adminAutotest

public VitamError adminAutotest()
                         throws VitamClientException

Description copied from interface: AdminClient

Check the dependencies and return a VitamError status where getHttpCode contains either 200 for OK or 503 for error and a sub list of VitamErrors for each tested subservices

Specified by:

adminAutotest in interface AdminClient

Returns:

the VitamError status, both in case of OK or ServiceUnavailable

Throws:

VitamClientException

getAdminUrl

public String getAdminUrl()

Specified by:

getAdminUrl in interface AdminClient

Returns:

the adminUrl

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