fr.gouv.vitam.storage.offers.workspace.driver

Class ConnectionImpl

java.lang.Object

fr.gouv.vitam.common.client.DefaultClient

fr.gouv.vitam.storage.driver.AbstractConnection

fr.gouv.vitam.storage.offers.workspace.driver.ConnectionImpl

All Implemented Interfaces:

BasicClient, MockOrRestClient, VitamAutoCloseable, Connection, AutoCloseable

public class ConnectionImpl
extends AbstractConnection

Workspace Connection Implementation

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
ConnectionImpl(String driverName, VitamClientFactoryInterface<? extends AbstractConnection> factory, Properties parameters) Constructor

Method Summary

Modifier and Type	Method and Description
StorageCheckResult	checkObject(StorageCheckRequest request) Check an object in order to validate its transfer
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
StorageCountResult	countObjects(StorageRequest request) Count the number of binary objects ine the container
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.
protected javax.ws.rs.client.Client	getClient(boolean chunked)
StorageMetadatasResult	getMetadatas(StorageObjectRequest request) Get metadata of object
StorageGetResult	getObject(StorageObjectRequest request) Retrieve an object from the storage offer based on criterias defined in request argument.
RequestResponse<OfferLog>	getOfferLogs(StorageOfferLogRequest storageGetOfferLogRequest) Get a listing of offer logs on a container type
String	getResourcePath() Get the resource path of the server.
String	getServiceUrl() Get the service URL
StorageCapacityResult	getStorageCapacity(Integer tenantId) Retrieve the remaining storage capacity available on the distant offer.
VitamClientFactory<?>	getVitamClientFactory()
protected <R> R	handleResponseStatus(javax.ws.rs.core.Response response, Class<R> responseType) Common method to handle response status
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	listObjects(StorageListRequest request) List object on a container type
boolean	objectExistsInOffer(StorageObjectRequest request) Check if an object is present in the offer
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
StoragePutResult	putObject(StoragePutRequest request) Put the object file into the storage offer based on criterias defined in request argument and underlaying connection parameters.
StorageRemoveResult	removeObject(StorageRemoveRequest request) Delete an object on the distant storage offer.
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 fr.gouv.vitam.storage.driver.AbstractConnection

getDriverName

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.gouv.vitam.storage.driver.Connection

close

Field Detail

INTERNAL_SERVER_ERROR

protected static final String INTERNAL_SERVER_ERROR

See Also:

Constant Field Values

Constructor Detail

ConnectionImpl

public ConnectionImpl(String driverName,
                      VitamClientFactoryInterface<? extends AbstractConnection> factory,
                      Properties parameters)

Constructor

Parameters:

driverName -

factory -

parameters -

Method Detail

getStorageCapacity

public StorageCapacityResult getStorageCapacity(Integer tenantId)
                                         throws StorageDriverPreconditionFailedException,
                                                StorageDriverNotFoundException,
                                                StorageDriverException

Description copied from interface: Connection

Retrieve the remaining storage capacity available on the distant offer. Return values MUST in bytes

Parameters:

tenantId - the tenant id needed to get storage capacity

Returns:

the usable and used space in bytes and a remind of the given tenantId

Throws:

StorageDriverPreconditionFailedException - if a bad request is encountered

StorageDriverNotFoundException - if container is not found

StorageDriverException - if any problem occurs during request

countObjects

public StorageCountResult countObjects(StorageRequest request)
                                throws StorageDriverException

Description copied from interface: Connection

Count the number of binary objects ine the container

Parameters:

request - the request to send. It contains informations of the container.

Returns:

the number of binary objects and a remind of the given tenantId and type

Throws:

StorageDriverException - if any problem occurs during request

getObject

public StorageGetResult getObject(StorageObjectRequest request)
                           throws StorageDriverException

Description copied from interface: Connection

Retrieve an object from the storage offer based on criterias defined in request argument.

Parameters:

request - the request to send. It contains informations needed to retrieve a given object.

Returns:

a result that may contains metadatas as well as the binary file

Throws:

StorageDriverException - if any problem occurs during request

putObject

public StoragePutResult putObject(StoragePutRequest request)
                           throws StorageDriverException

Description copied from interface: Connection

Put the object file into the storage offer based on criterias defined in request argument and underlaying connection parameters.

Parameters:

request - the request to send. It may contains informations needed to store the file.

Returns:

a result that may contains metadatas or statistics about the object put operation.

Throws:

StorageDriverException - if any problem occurs during request

removeObject

public StorageRemoveResult removeObject(StorageRemoveRequest request)
                                 throws StorageDriverException

Description copied from interface: Connection

Delete an object on the distant storage offer.

Parameters:

request - the request to send, it contains information needed to delete an object on the distant store

Returns:

a result that may contains metadatas or statistics about the object removal operation.

Throws:

StorageDriverException - if any problem occurs during request

objectExistsInOffer

public boolean objectExistsInOffer(StorageObjectRequest request)
                            throws StorageDriverException

Description copied from interface: Connection

Check if an object is present in the offer

Parameters:

request - the request to send. It contains informations needed to retrieve a given object.

Returns:

true if exists, else false

Throws:

StorageDriverException - if any problem occurs during request

handleResponseStatus

protected <R> R handleResponseStatus(javax.ws.rs.core.Response response,
                                     Class<R> responseType)
                              throws StorageDriverException

Common method to handle response status

Type Parameters:

R - the class type to be returned

Parameters:

response - the response to be handled

responseType - the type to map the response into

Returns:

the response mapped as a POJO

Throws:

StorageDriverException - if any from the server

checkObject

public StorageCheckResult checkObject(StorageCheckRequest request)
                               throws StorageDriverException

Description copied from interface: Connection

Check an object in order to validate its transfer

Parameters:

request - the request to send. It contains informations needed to check the object.

Returns:

a result that may contains information about the object check operation.

Throws:

StorageDriverException - if any problem occurs during request

getMetadatas

public StorageMetadatasResult getMetadatas(StorageObjectRequest request)
                                    throws StorageDriverException

Description copied from interface: Connection

Get metadata of object

Returns:

a result that may contain information about the storage metadata

Throws:

StorageDriverException

listObjects

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> listObjects(StorageListRequest request)
                                                                     throws StorageDriverException

Description copied from interface: Connection

List object on a container type

Parameters:

request - the request contains data needed to list container type

Returns:

an iterator with each object metadata

Throws:

StorageDriverException

getOfferLogs

public RequestResponse<OfferLog> getOfferLogs(StorageOfferLogRequest storageGetOfferLogRequest)
                                       throws StorageDriverException

Description copied from interface: Connection

Get a listing of offer logs on a container type

Parameters:

storageGetOfferLogRequest - the request contains data needed to retrieve the listing of the container

Returns:

the listing of last objects save according to the request

Throws:

StorageDriverException - to be thrown in case of any driver exception

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