fr.gouv.vitam.driver.mock

Class ConnectionMockImpl

java.lang.Object

fr.gouv.vitam.common.client.AbstractMockClient

fr.gouv.vitam.driver.mock.ConnectionMockImpl

All Implemented Interfaces:

MockOrRestClient, VitamAutoCloseable, Connection, AutoCloseable

public class ConnectionMockImpl
extends AbstractMockClient
implements Connection

Workspace Connection Implementation

Nested Class Summary

Nested classes/interfaces inherited from class fr.gouv.vitam.common.client.AbstractMockClient

AbstractMockClient.FakeInboundResponse

Field Summary

Fields inherited from class fr.gouv.vitam.common.client.AbstractMockClient

INTERNAL_SERVER_ERROR

Constructor Summary

Constructors

Constructor and Description
ConnectionMockImpl(String driverName, fr.gouv.vitam.driver.mock.MockDriverImpl.MockClientFactory 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
StorageCountResult	countObjects(StorageRequest request) Count the number of binary objects ine the container
void	deleteAll()
String	getDriverName()
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.
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
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.

Methods inherited from class fr.gouv.vitam.common.client.AbstractMockClient

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Methods inherited from class java.lang.Object

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

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

close

Constructor Detail

ConnectionMockImpl

public ConnectionMockImpl(String driverName,
                          fr.gouv.vitam.driver.mock.MockDriverImpl.MockClientFactory factory,
                          Properties parameters)

Constructor

Parameters:

driverName -

factory -

parameters -

Method Detail

getDriverName

public String getDriverName()

Returns:

the driverName associated

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

Specified by:

getStorageCapacity in interface Connection

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

Specified by:

countObjects in interface Connection

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.

Specified by:

getObject in interface Connection

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.

Specified by:

putObject in interface Connection

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.

Specified by:

removeObject in interface Connection

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

Specified by:

objectExistsInOffer in interface Connection

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

Specified by:

checkObject in interface Connection

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

Specified by:

getMetadatas in interface Connection

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

Specified by:

listObjects in interface Connection

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

Description copied from interface: Connection

Get a listing of offer logs on a container type

Specified by:

getOfferLogs in interface Connection

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

deleteAll

public void deleteAll()