Package 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 inherited from interface fr.gouv.vitam.common.client.BasicClient

STATUS_URL

Method Summary

Modifier and Type	Method	Description
StorageBulkPutResult	bulkPutObjects(StorageBulkPutRequest request)	Bulk put object files into the storage offer.
Map<String,AccessRequestStatus>	checkAccessRequestStatuses(List<String> accessRequestIds, int tenant, boolean adminCrossTenantAccessRequestAllowed)	Check access request statuses of asynchronous offer.
boolean	checkObjectAvailability(StorageCheckObjectAvailabilityRequest request)	Check immediate availability of objects from asynchronous storage offer.
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
final void	consumeAnyEntityAndClose(javax.ws.rs.core.Response response)	Helper when an error occurs on client usage side to consume response however
String	createAccessRequest(StorageAccessRequestCreationRequest request)	Create an access request for retrieving objects from asynchronous storage offer.
StorageBulkMetadataResult	getBulkMetadata(StorageGetBulkMetadataRequest request)	Bulk get metadata of objects
javax.ws.rs.client.Client	getChunkedClient()
javax.ws.rs.client.Client	getClient()
VitamClientFactory<?>	getClientFactory()
StorageMetadataResult	getMetadatas(StorageGetMetadataRequest 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.
javax.ws.rs.core.Response	launchOfferLogCompaction(VitamContext vitamContext)	launch Offer Log Compaction
CloseableIterator<ObjectEntry>	listObjects(StorageListRequest request)	List object on a container type
javax.ws.rs.core.Response	make(VitamRequestBuilder request)
javax.ws.rs.core.Response	makeSpecifyingUrl(VitamRequestBuilder request)
boolean	objectExistsInOffer(StorageObjectRequest request)	Check if an object is present in the offer
StoragePutResult	putObject(StoragePutRequest request)	Put the object file into the storage offer based on criteria defined in request argument and underlying connection parameters.
void	removeAccessRequest(String accessRequestId, int tenant, boolean adminCrossTenantAccessRequestAllowed)	Removes (cancel / delete) and access request for an asynchronous offer.
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 InputStream) 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

Method Details

getStorageCapacity

public StorageCapacityResult getStorageCapacity(Integer tenantId)
                                         throws 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

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

createAccessRequest

public String createAccessRequest(StorageAccessRequestCreationRequest request)
                           throws StorageDriverException

Description copied from interface: Connection

Create an access request for retrieving objects from asynchronous storage offer.

Parameters:

request - the request to send. It contains information needed to prepare a given object.

Returns:

an AccessRequestId that can be used to check the status of the AccessRequest, and to remove it

Throws:

StorageDriverException - if any problem occurs during request

checkAccessRequestStatuses

public Map<String,AccessRequestStatus> checkAccessRequestStatuses(List<String> accessRequestIds,
 int tenant,
 boolean adminCrossTenantAccessRequestAllowed)
                                                           throws StorageDriverException

Description copied from interface: Connection

Check access request statuses of asynchronous offer.

Parameters:

accessRequestIds - the accessRequestIds whose status is to be checked

tenant - the tenant Id

adminCrossTenantAccessRequestAllowed - when true, access to access requests of other tenants is allowed from Admin tenant

Returns:

a Map of AccessRequestStatus by access request Id

Throws:

StorageDriverException - if any problem occurs during request

removeAccessRequest

public void removeAccessRequest(String accessRequestId,
 int tenant,
 boolean adminCrossTenantAccessRequestAllowed)
                         throws StorageDriverException

Description copied from interface: Connection

Removes (cancel / delete) and access request for an asynchronous offer. Does nothing is access request id does not exist (idempotency)

Parameters:

accessRequestId - the accessRequestId to remove

tenant - the tenant Id

adminCrossTenantAccessRequestAllowed - when true, removing access requests of other tenants is allowed from Admin tenant

Throws:

StorageDriverException - if any problem occurs during request

checkObjectAvailability

public boolean checkObjectAvailability(StorageCheckObjectAvailabilityRequest request)
                                throws StorageDriverException

Description copied from interface: Connection

Check immediate availability of objects from asynchronous storage offer.

Parameters:

request - the request to send. It contains information needed to check object availability.

Returns:

true if ALL objects are available, otherwise false.

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 criteria defined in request argument and underlying connection parameters.

Parameters:

request - the request to send. It may contain information needed to store the file.

Returns:

a result that may contain metadata or statistics about the object put operation.

Throws:

StorageDriverException - if any problem occurs during request

bulkPutObjects

public StorageBulkPutResult bulkPutObjects(StorageBulkPutRequest request)
                                    throws StorageDriverException

Description copied from interface: Connection

Bulk put object files into the storage offer.

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

getMetadatas

public StorageMetadataResult getMetadatas(StorageGetMetadataRequest 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

getBulkMetadata

public StorageBulkMetadataResult getBulkMetadata(StorageGetBulkMetadataRequest request)
                                          throws StorageDriverException,
InvalidParseOperationException

Description copied from interface: Connection

Bulk get metadata of objects

Returns:

a result that may contain information about the storage metadata

Throws:

StorageDriverException

InvalidParseOperationException

listObjects

public CloseableIterator<ObjectEntry> 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

launchOfferLogCompaction

public javax.ws.rs.core.Response launchOfferLogCompaction(VitamContext vitamContext)
                                                   throws StorageDriverException

Description copied from interface: Connection

launch Offer Log Compaction

Returns:

RequestResponse

Throws:

StorageDriverException - to be thrown in case of any driver exception

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

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 AutoCloseable

Specified by:

close in interface MockOrRestClient

Specified by:

close in interface VitamAutoCloseable

toString

public String toString()

Overrides:

toString in class 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()