Package fr.gouv.vitam.storage.engine.client

Class StorageClientMock

java.lang.Object

fr.gouv.vitam.common.client.AbstractMockClient

fr.gouv.vitam.storage.engine.client.StorageClientMock

All Implemented Interfaces:

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

public class StorageClientMock
extends AbstractMockClient
implements StorageClient

Mock client implementation for storage

Nested Class Summary

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

AbstractMockClient.FakeInboundResponse

Field Summary

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

STATUS_URL

Constructor Summary

Constructors

Constructor	Description
StorageClientMock()

Method Summary

Modifier and Type	Method	Description
BulkObjectStoreResponse	bulkStoreFilesFromWorkspace(java.lang.String strategyId, BulkObjectStoreRequest bulkObjectStoreRequest)	Store objects available in workspace into offers
java.util.Map<java.lang.String,AccessRequestStatus>	checkAccessRequestStatuses(java.lang.String strategyId, java.lang.String offerId, java.util.List<java.lang.String> accessRequestIds, boolean adminCrossTenantAccessRequestAllowed)	Check access request statuses of asynchronous offer.
BulkObjectAvailabilityResponse	checkBulkObjectAvailability(java.lang.String strategyId, java.lang.String offerId, BulkObjectAvailabilityRequest bulkObjectAvailabilityRequest)	Checks immediate object availability in storage offer.
RequestResponseOK	copyObjectFromOfferToOffer(java.lang.String objectId, DataCategory category, java.lang.String source, java.lang.String destination, java.lang.String strategyId)
RequestResponseOK	create(java.lang.String strategyId, java.lang.String objectId, DataCategory category, java.io.InputStream inputStream, java.lang.Long inputStreamSize, java.util.List<java.lang.String> offerIds)
java.util.Optional<java.lang.String>	createAccessRequestIfRequired(java.lang.String strategyId, java.lang.String offerId, DataCategory dataCategory, java.util.List<java.lang.String> objectNames)	Create access request if target offer does not support synchronous read (tape library storage).
boolean	delete(java.lang.String strategyId, DataCategory type, java.lang.String guid)	Delete an object of given type in the storage offer strategy
boolean	delete(java.lang.String strategyId, DataCategory type, java.lang.String guid, java.util.List<java.lang.String> offerIds)	Delete an object of given type in the storage offer strategy
java.util.Map<java.lang.String,java.lang.Boolean>	exists(java.lang.String strategyId, DataCategory type, java.lang.String guid, java.util.List<java.lang.String> offerIds)	Check the existence of an object in storage by its id and type DataCategory.
boolean	existsContainer(java.lang.String strategyId)	Check the existance of a tenant container in storage by its id
RequestResponse<BatchObjectInformationResponse>	getBatchObjectInformation(java.lang.String strategyId, DataCategory type, java.util.Collection<java.lang.String> offerIds, java.util.Collection<java.lang.String> objectIds)	Get object information from objects in storage
javax.ws.rs.core.Response	getContainerAsync(java.lang.String strategyId, java.lang.String guid, DataCategory type, AccessLogInfoModel logInfo)	Retrieves a binary object knowing its guid as an inputStream for a specific tenant/strategy
javax.ws.rs.core.Response	getContainerAsync(java.lang.String strategyId, java.lang.String offerId, java.lang.String objectName, DataCategory type, AccessLogInfoModel logInfo)	Retrieves a binary object knowing its guid as an inputStream for a specific tenant/strategy/offerId
com.fasterxml.jackson.databind.JsonNode	getInformation(java.lang.String strategyId, DataCategory type, java.lang.String guid, java.util.List<java.lang.String> offerIds, boolean noCache)	Get object information from objects in storage
RequestResponse<OfferLog>	getOfferLogs(java.lang.String strategyId, java.lang.String offerId, DataCategory type, java.lang.Long offset, int limit, Order order)	Get offer log .
java.util.List<java.lang.String>	getOffers(java.lang.String strategyId)	get List of offers for a strategy
java.lang.String	getReferentOffer(java.lang.String strategy)	Get referent offer of strategy
com.fasterxml.jackson.databind.JsonNode	getStorageInformation(java.lang.String strategyId)	Check if the storage of objects could be done, knowing a required size
RequestResponse<StorageStrategy>	getStorageStrategies()	Get strategies.
CloseableIterator<ObjectEntry>	listContainer(java.lang.String strategyId, java.lang.String offerId, DataCategory type)	List object type in container
void	removeAccessRequest(java.lang.String strategyId, java.lang.String offerId, java.lang.String accessRequestId, boolean adminCrossTenantAccessRequestAllowed)	Removes (cancel / delete) and access request for an asynchronous offer.
RequestResponseOK<StorageLogBackupResult>	storageAccessLogBackup(java.util.List<java.lang.Integer> tenants)	Call storage accesslog backup operation.
RequestResponseOK<StorageLogBackupResult>	storageLogBackup(java.util.List<java.lang.Integer> tenants)	Call storage log backup operation.
RequestResponseOK<StorageLogTraceabilityResult>	storageLogTraceability(java.util.List<java.lang.Integer> tenants)	Call storage log traceability operation.
StoredInfoResult	storeFileFromWorkspace(java.lang.String strategyId, DataCategory type, java.lang.String guid, ObjectDescription description)	Store an object available in workspace by its vitam guid

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.common.client.MockOrRestClient

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Constructor Detail

StorageClientMock

public StorageClientMock()

Method Detail

getStorageInformation

public com.fasterxml.jackson.databind.JsonNode getStorageInformation(java.lang.String strategyId)
                                                              throws StorageServerClientException

Description copied from interface: StorageClient

Check if the storage of objects could be done, knowing a required size

Specified by:

getStorageInformation in interface StorageClient

Parameters:

strategyId - the storage strategy id

Returns:

the capacity of the storage

Throws:

StorageServerClientException - if the Server got an internal error

getOffers

public java.util.List<java.lang.String> getOffers(java.lang.String strategyId)
                                           throws StorageNotFoundClientException,
                                                  StorageServerClientException

Description copied from interface: StorageClient

get List of offers for a strategy

Specified by:

getOffers in interface StorageClient

Parameters:

strategyId - strategyId

Returns:

list id of offers

Throws:

StorageNotFoundClientException

StorageServerClientException

storeFileFromWorkspace

public StoredInfoResult storeFileFromWorkspace(java.lang.String strategyId,
                                               DataCategory type,
                                               java.lang.String guid,
                                               ObjectDescription description)
                                        throws StorageAlreadyExistsClientException,
                                               StorageNotFoundClientException,
                                               StorageServerClientException

Description copied from interface: StorageClient

Store an object available in workspace by its vitam guid

Specified by:

storeFileFromWorkspace in interface StorageClient

Parameters:

strategyId - the storage strategy id

type - the type of object collection

guid - vitam guid

description - object description

Returns:

the result status of object creation

Throws:

StorageAlreadyExistsClientException - if the Server got a CONFLICT status result

StorageNotFoundClientException - if the Server got a NotFound result

StorageServerClientException - if the Server got an internal error

delete

public boolean delete(java.lang.String strategyId,
                      DataCategory type,
                      java.lang.String guid)
               throws StorageServerClientException

Description copied from interface: StorageClient

Delete an object of given type in the storage offer strategy

Specified by:

delete in interface StorageClient

Parameters:

strategyId - the storage strategy id

type - the type of object collection

guid - vitam guid

Returns:

true if deleted

Throws:

StorageServerClientException - if the Server got an internal error

delete

public boolean delete(java.lang.String strategyId,
                      DataCategory type,
                      java.lang.String guid,
                      java.util.List<java.lang.String> offerIds)
               throws StorageServerClientException

Description copied from interface: StorageClient

Delete an object of given type in the storage offer strategy

Specified by:

delete in interface StorageClient

Parameters:

strategyId - the storage strategy id

type - the type of object collection

guid - vitam guid

offerIds - offers ids to delete

Returns:

true if deleted

Throws:

StorageServerClientException

existsContainer

public boolean existsContainer(java.lang.String strategyId)
                        throws StorageServerClientException

Description copied from interface: StorageClient

Check the existance of a tenant container in storage by its id

Specified by:

existsContainer in interface StorageClient

Parameters:

strategyId - the storage strategy id

Returns:

true if exist

Throws:

StorageServerClientException - if the Server got an internal error

exists

public java.util.Map<java.lang.String,java.lang.Boolean> exists(java.lang.String strategyId,
                                                                      DataCategory type,
                                                                      java.lang.String guid,
                                                                      java.util.List<java.lang.String> offerIds)
                                                               throws StorageServerClientException

Description copied from interface: StorageClient

Check the existence of an object in storage by its id and type DataCategory.

Specified by:

exists in interface StorageClient

Parameters:

strategyId - the storage strategy id

type - the type of object collection

guid - vitam guid

Returns:

true/false for each offer

Throws:

StorageServerClientException - if the Server got an internal error

bulkStoreFilesFromWorkspace

public BulkObjectStoreResponse bulkStoreFilesFromWorkspace(java.lang.String strategyId,
                                                           BulkObjectStoreRequest bulkObjectStoreRequest)

Description copied from interface: StorageClient

Store objects available in workspace into offers

Specified by:

bulkStoreFilesFromWorkspace in interface StorageClient

Parameters:

strategyId - the storage strategy id

bulkObjectStoreRequest - request

Returns:

the result status of object creation

getContainerAsync

public javax.ws.rs.core.Response getContainerAsync(java.lang.String strategyId,
                                                   java.lang.String guid,
                                                   DataCategory type,
                                                   AccessLogInfoModel logInfo)
                                            throws StorageServerClientException,
                                                   StorageNotFoundException

Description copied from interface: StorageClient

Retrieves a binary object knowing its guid as an inputStream for a specific tenant/strategy

Specified by:

getContainerAsync in interface StorageClient

Parameters:

strategyId - the storage strategy id

guid - vitam guid of the object to be returned

type - the object type to list

logInfo - additional information for accessLog

Returns:

the object requested

Throws:

StorageServerClientException - if the Server got an internal error

StorageNotFoundException - if the Server got a NotFound result, if the container or the object does not exist

getContainerAsync

public javax.ws.rs.core.Response getContainerAsync(java.lang.String strategyId,
                                                   java.lang.String offerId,
                                                   java.lang.String objectName,
                                                   DataCategory type,
                                                   AccessLogInfoModel logInfo)
                                            throws StorageServerClientException,
                                                   StorageNotFoundException

Description copied from interface: StorageClient

Retrieves a binary object knowing its guid as an inputStream for a specific tenant/strategy/offerId

Specified by:

getContainerAsync in interface StorageClient

Returns:

Throws:

StorageServerClientException

StorageNotFoundException

listContainer

public CloseableIterator<ObjectEntry> listContainer(java.lang.String strategyId,
                                                    java.lang.String offerId,
                                                    DataCategory type)

Description copied from interface: StorageClient

List object type in container

Specified by:

listContainer in interface StorageClient

Parameters:

strategyId - the strategy ID

offerId - the Offer ID

type - the object type to list

Returns:

an iterator with object list

storageAccessLogBackup

public RequestResponseOK<StorageLogBackupResult> storageAccessLogBackup(java.util.List<java.lang.Integer> tenants)

Description copied from interface: StorageClient

Call storage accesslog backup operation.

Specified by:

storageAccessLogBackup in interface StorageClient

Parameters:

tenants - tenants list to backup

Returns:

Storage logbook backup response

storageLogBackup

public RequestResponseOK<StorageLogBackupResult> storageLogBackup(java.util.List<java.lang.Integer> tenants)

Description copied from interface: StorageClient

Call storage log backup operation.

Specified by:

storageLogBackup in interface StorageClient

Parameters:

tenants - tenants list to backup

Returns:

Storage logbook backup response

storageLogTraceability

public RequestResponseOK<StorageLogTraceabilityResult> storageLogTraceability(java.util.List<java.lang.Integer> tenants)

Description copied from interface: StorageClient

Call storage log traceability operation.

Specified by:

storageLogTraceability in interface StorageClient

Returns:

storage log traceability response

getInformation

public com.fasterxml.jackson.databind.JsonNode getInformation(java.lang.String strategyId,
                                                              DataCategory type,
                                                              java.lang.String guid,
                                                              java.util.List<java.lang.String> offerIds,
                                                              boolean noCache)
                                                       throws StorageServerClientException,
                                                              StorageNotFoundClientException

Description copied from interface: StorageClient

Get object information from objects in storage

Specified by:

getInformation in interface StorageClient

Parameters:

strategyId - the storage strategy id

type - the object type to list

guid - vitam guid

offerIds - offers ids to delete

noCache - noCache forces digest computation.

Returns:

informations

Throws:

StorageServerClientException - StorageServerClientException

StorageNotFoundClientException - StorageNotFoundClientException

getBatchObjectInformation

public RequestResponse<BatchObjectInformationResponse> getBatchObjectInformation(java.lang.String strategyId,
                                                                                 DataCategory type,
                                                                                 java.util.Collection<java.lang.String> offerIds,
                                                                                 java.util.Collection<java.lang.String> objectIds)

Description copied from interface: StorageClient

Get object information from objects in storage

Specified by:

getBatchObjectInformation in interface StorageClient

Parameters:

strategyId - the storage strategy id

type - the object type to list

offerIds - offers ids

objectIds - list of object ids

Returns:

informations

copyObjectFromOfferToOffer

public RequestResponseOK copyObjectFromOfferToOffer(java.lang.String objectId,
                                                    DataCategory category,
                                                    java.lang.String source,
                                                    java.lang.String destination,
                                                    java.lang.String strategyId)
                                             throws StorageServerClientException,
                                                    InvalidParseOperationException

Specified by:

copyObjectFromOfferToOffer in interface StorageClient

Parameters:

objectId - objectId

category - category

source - source

destination - destination

strategyId - strategyId

Returns:

RequestResponseOK

Throws:

StorageServerClientException - StorageServerClientException

InvalidParseOperationException - StorageServerClientException

create

public RequestResponseOK create(java.lang.String strategyId,
                                java.lang.String objectId,
                                DataCategory category,
                                java.io.InputStream inputStream,
                                java.lang.Long inputStreamSize,
                                java.util.List<java.lang.String> offerIds)
                         throws StorageServerClientException,
                                InvalidParseOperationException

Specified by:

create in interface StorageClient

Parameters:

strategyId - strategyId

objectId - objectId

category - category

inputStream - inputStream

inputStreamSize - inputStreamSize

offerIds - offers ids

Returns:

RequestResponseOK

Throws:

StorageServerClientException - StorageServerClientException

InvalidParseOperationException - InvalidParseOperationException

getOfferLogs

public RequestResponse<OfferLog> getOfferLogs(java.lang.String strategyId,
                                              java.lang.String offerId,
                                              DataCategory type,
                                              java.lang.Long offset,
                                              int limit,
                                              Order order)
                                       throws StorageServerClientException

Description copied from interface: StorageClient

Get offer log .

Specified by:

getOfferLogs in interface StorageClient

Parameters:

strategyId - the strategy to get offers

offerId - the offer Id to read object from

type - the object type to list

offset - offset of the last object before

limit - the number of result wanted

order - the order order

Returns:

list of offer log

Throws:

StorageServerClientException

getStorageStrategies

public RequestResponse<StorageStrategy> getStorageStrategies()
                                                      throws StorageServerClientException

Description copied from interface: StorageClient

Get strategies.

Specified by:

getStorageStrategies in interface StorageClient

Returns:

strategies available for storage

Throws:

StorageServerClientException

createAccessRequestIfRequired

public java.util.Optional<java.lang.String> createAccessRequestIfRequired(java.lang.String strategyId,
                                                                          java.lang.String offerId,
                                                                          DataCategory dataCategory,
                                                                          java.util.List<java.lang.String> objectNames)

Description copied from interface: StorageClient

Create access request if target offer does not support synchronous read (tape library storage). If target offer supports synchronous read requests, then no access request is created.

Specified by:

createAccessRequestIfRequired in interface StorageClient

Parameters:

strategyId - the target storage strategy identifier

offerId - the target offer identifier (Optional). If provided, the offerId must be a valid active offer of the specified strategy. Otherwise, the referent offer of strategy is used.

dataCategory - the data category of objects to which access is requested

objectNames - the object names/ids/guids to which access is requested

Returns:

an AccessRequestId if access request is required (async offer), otherwiser Optional.empty()

checkAccessRequestStatuses

public java.util.Map<java.lang.String,AccessRequestStatus> checkAccessRequestStatuses(java.lang.String strategyId,
                                                                                            java.lang.String offerId,
                                                                                            java.util.List<java.lang.String> accessRequestIds,
                                                                                            boolean adminCrossTenantAccessRequestAllowed)

Description copied from interface: StorageClient

Check access request statuses of asynchronous offer.

Specified by:

checkAccessRequestStatuses in interface StorageClient

Parameters:

strategyId - the target storage strategy identifier

offerId - the target offer identifier (Optional). If provided, the offerId must be a valid active offer of the specified strategy. Otherwise, the referent offer of strategy is used.

accessRequestIds - the accessRequestIds whose status is to be checked

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

Returns:

the statuses of provided access request ids

removeAccessRequest

public void removeAccessRequest(java.lang.String strategyId,
                                java.lang.String offerId,
                                java.lang.String accessRequestId,
                                boolean adminCrossTenantAccessRequestAllowed)

Description copied from interface: StorageClient

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

Specified by:

removeAccessRequest in interface StorageClient

Parameters:

strategyId - the target storage strategy identifier

offerId - the target offer identifier (Optional). If provided, the offerId must be a valid active offer of the specified strategy. Otherwise, the referent offer of strategy is used.

accessRequestId - the accessRequestId to remove

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

checkBulkObjectAvailability

public BulkObjectAvailabilityResponse checkBulkObjectAvailability(java.lang.String strategyId,
                                                                  java.lang.String offerId,
                                                                  BulkObjectAvailabilityRequest bulkObjectAvailabilityRequest)

Description copied from interface: StorageClient

Checks immediate object availability in storage offer. Synchronous offers have guaranteed immediate availability of objects. Async offers (tape storage) may not be able to serve object immediately.

Specified by:

checkBulkObjectAvailability in interface StorageClient

Parameters:

strategyId - the target storage strategy identifier

offerId - the target offer identifier (Optional). If provided, the offerId must be a valid active offer of the specified strategy. Otherwise, the referent offer of strategy is used.

bulkObjectAvailabilityRequest - object availability check request

Returns:

true if ALL objects are available, otherwise false.

getReferentOffer

public java.lang.String getReferentOffer(java.lang.String strategy)
                                  throws StorageNotFoundClientException,
                                         StorageServerClientException

Description copied from interface: StorageClient

Get referent offer of strategy

Specified by:

getReferentOffer in interface StorageClient

Returns:

Throws:

StorageNotFoundClientException

StorageServerClientException