Package fr.gouv.vitam.common.client

Class DefaultAdminClient

java.lang.Object

fr.gouv.vitam.common.client.DefaultAdminClient

All Implemented Interfaces:

AdminClient, BasicClient, MockOrRestClient, VitamAutoCloseable, java.lang.AutoCloseable

public class DefaultAdminClient
extends java.lang.Object
implements AdminClient

Field Summary

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

STATUS_URL

Constructor Summary

Constructors

Constructor	Description
DefaultAdminClient(VitamClientFactoryInterface<DefaultAdminClient> factory)

Method Summary

Modifier and Type	Method	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<java.lang.String,java.lang.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
java.lang.String	getAdminUrl()
javax.ws.rs.client.Client	getChunkedClient()
javax.ws.rs.client.Client	getClient()
VitamClientFactory<?>	getClientFactory()
java.lang.String	getResourcePath()	Get the resource path of the server.
java.lang.String	getServiceUrl()	Get the service URL
javax.ws.rs.core.Response	make(VitamRequestBuilder request)
javax.ws.rs.core.Response	makeSpecifyingUrl(VitamRequestBuilder request)
static void	staticConsumeAnyEntityAndClose(javax.ws.rs.core.Response response)	This method consume everything (in particular InputStream) and close the response.
java.lang.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

Constructor Detail

DefaultAdminClient

public DefaultAdminClient(VitamClientFactoryInterface<DefaultAdminClient> 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 java.lang.String getAdminUrl()

Specified by:

getAdminUrl in interface AdminClient

Returns:

the adminUrl

staticConsumeAnyEntityAndClose

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

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

Parameters:

response -

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

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<java.lang.String,java.lang.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

getResourcePath

public java.lang.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 java.lang.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 java.lang.AutoCloseable

Specified by:

close in interface MockOrRestClient

Specified by:

close in interface VitamAutoCloseable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

makeSpecifyingUrl

public javax.ws.rs.core.Response makeSpecifyingUrl(VitamRequestBuilder request)
                                            throws VitamClientInternalException

Throws:

VitamClientInternalException

make

public javax.ws.rs.core.Response make(VitamRequestBuilder request)
                               throws VitamClientInternalException

Throws:

VitamClientInternalException

getClientFactory

public VitamClientFactory<?> getClientFactory()

getClient

public javax.ws.rs.client.Client getClient()

getChunkedClient

public javax.ws.rs.client.Client getChunkedClient()