fr.gouv.vitam.storage.driver

Interface Connection

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractConnection, ConnectionImpl, ConnectionMockImpl

public interface Connection
extends AutoCloseable

Represents a connection to the distant storage offer service that is provided by the driver when calling the connect method:

myDriver.connect(serviceUrl, parameters);

The connection implementation is driver dependent but MUST hold enough informations/parameters/configurations to be able to contact the distant offer service without the need to give additional connection related parameters on further request done with this connection. In some cases it may be considered as a "session". Note: Connection extends AutoCloseable so the connection implementation MUST provide a close() method which responsibility is to cleanly close and remove.

Method Summary

Modifier and Type	Method and Description
StorageCheckResult	checkObject(StorageCheckRequest request) Check an object in order to validate its transfer
void	close() Override AutoCloseable implementation to specify the exception
StorageCountResult	countObjects(StorageRequest request) Count the number of binary objects ine the container
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 request) Get a listing of offer logs on a container type
StorageCapacityResult	getStorageCapacity(Integer tenantId) Retrieve the remaining storage capacity available on the distant offer.
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
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.

Method Detail

getStorageCapacity

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

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

StorageCountResult countObjects(StorageRequest request)
                         throws StorageDriverException

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

StorageGetResult getObject(StorageObjectRequest request)
                    throws StorageDriverException

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

IllegalArgumentException - if request is wrong

putObject

StoragePutResult putObject(StoragePutRequest request)
                    throws StorageDriverException

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

StorageRemoveResult removeObject(StorageRemoveRequest request)
                          throws StorageDriverException

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

boolean objectExistsInOffer(StorageObjectRequest request)
                     throws StorageDriverException

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

checkObject

StorageCheckResult checkObject(StorageCheckRequest request)
                        throws StorageDriverException

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

StorageMetadatasResult getMetadatas(StorageObjectRequest request)
                             throws StorageDriverException

Get metadata of object

Parameters:

request -

Returns:

a result that may contain information about the storage metadata

Throws:

StorageDriverException

listObjects

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

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

RequestResponse<OfferLog> getOfferLogs(StorageOfferLogRequest request)
                                throws StorageDriverException

Get a listing of offer logs on a container type

Parameters:

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

close

void close()
    throws StorageDriverException

Override AutoCloseable implementation to specify the exception

Specified by:

close in interface AutoCloseable

Throws:

StorageDriverException - to be thrown in case of any driver exception