Package fr.gouv.vitam.storage.offers.core

Class SanityCheckOfferServiceDecorator

java.lang.Object

fr.gouv.vitam.storage.offers.core.SanityCheckOfferServiceDecorator

All Implemented Interfaces:

DefaultOfferService

public class SanityCheckOfferServiceDecorator
extends java.lang.Object
implements DefaultOfferService

Path Sanity check wrapper around DefaultOfferService. Ensures that all DefaultOfferService methods (current and future) properly implement file path sanity checks.

Field Summary

Fields inherited from interface fr.gouv.vitam.storage.offers.core.DefaultOfferService

STORAGE_CONF_FILE_NAME

Constructor Summary

Constructors

Constructor	Description
SanityCheckOfferServiceDecorator(DefaultOfferService innerService, StorageConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
StorageBulkPutResult	bulkPutObjects(java.lang.String containerName, java.util.List<java.lang.String> objectIds, MultiplexedStreamReader multiplexedStreamReader, DataCategory type, DigestType digestType)
java.util.Map<java.lang.String,AccessRequestStatus>	checkAccessRequestStatuses(java.util.List<java.lang.String> accessRequestIds, boolean adminCrossTenantAccessRequestAllowed)
boolean	checkObjectAvailability(java.lang.String containerName, java.util.List<java.lang.String> objectIds)
void	compactOfferLogs()
java.lang.String	createAccessRequest(java.lang.String containerName, java.util.List<java.lang.String> objectIds)	Create access request (asynchronous read from tape to local FS) for the given @containerName and objects list.
java.lang.String	createObject(java.lang.String containerName, java.lang.String objectId, java.io.InputStream objectPart, DataCategory type, long size, DigestType digestType)	Create object on container with objectId Receive object part of object.
void	deleteObject(java.lang.String containerName, java.lang.String objectId, DataCategory type)	Deletes a object representing the data at location containerName/objectName
StorageBulkMetadataResult	getBulkMetadata(java.lang.String containerName, java.util.List<java.lang.String> objectIds, java.lang.Boolean noCache)
ContainerInformation	getCapacity(java.lang.String containerName)	Get container capacity
StorageMetadataResult	getMetadata(java.lang.String containerName, java.lang.String objectId, boolean noCache)	Get Metadata
ObjectContent	getObject(java.lang.String containerName, java.lang.String objectId)	Get object on offer as an inputStream
java.lang.String	getObjectDigest(java.lang.String containerName, java.lang.String objectId, DigestType digestAlgorithm)	Get offer storage digest of object
java.util.List<OfferLog>	getOfferLogs(java.lang.String containerName, java.lang.Long offset, int limit, Order order)	Get the offer log of objects created in offer container
boolean	isObjectExist(java.lang.String containerName, java.lang.String objectId)	Check if object exists
void	listObjects(java.lang.String containerName, ObjectListingListener objectListingListener)	List container objects
void	removeAccessRequest(java.lang.String accessRequestId, boolean adminCrossTenantAccessRequestAllowed)

Methods inherited from class java.lang.Object

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

Constructor Detail

SanityCheckOfferServiceDecorator

public SanityCheckOfferServiceDecorator(DefaultOfferService innerService,
                                        StorageConfiguration configuration)

Method Detail

getObjectDigest

public java.lang.String getObjectDigest(java.lang.String containerName,
                                        java.lang.String objectId,
                                        DigestType digestAlgorithm)
                                 throws ContentAddressableStorageException

Description copied from interface: DefaultOfferService

Get offer storage digest of object

Specified by:

getObjectDigest in interface DefaultOfferService

Parameters:

containerName - the container with the object

objectId - the object name / id

digestAlgorithm - the digest algorithm

Returns:

the offer computed digest

Throws:

ContentAddressableStorageException - thrown on storage error

getObject

public ObjectContent getObject(java.lang.String containerName,
                               java.lang.String objectId)
                        throws ContentAddressableStorageException

Description copied from interface: DefaultOfferService

Get object on offer as an inputStream

Specified by:

getObject in interface DefaultOfferService

Parameters:

containerName - the container containing the object

objectId - the object id

Returns:

the object included in a response

Throws:

ContentAddressableStorageNotFoundException - thrown when object does not exists

ContentAddressableStorageException - thrown when a server error occurs

createAccessRequest

public java.lang.String createAccessRequest(java.lang.String containerName,
                                            java.util.List<java.lang.String> objectIds)
                                     throws ContentAddressableStorageException

Description copied from interface: DefaultOfferService

Create access request (asynchronous read from tape to local FS) for the given @containerName and objects list. Return access request id

Specified by:

createAccessRequest in interface DefaultOfferService

Parameters:

containerName - the container containing the object

objectIds - the objects ids

Returns:

acess request id

Throws:

ContentAddressableStorageNotFoundException - thrown when object does not exists

ContentAddressableStorageException - thrown when a server error occurs

checkAccessRequestStatuses

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

Specified by:

checkAccessRequestStatuses in interface DefaultOfferService

Throws:

ContentAddressableStorageException

removeAccessRequest

public void removeAccessRequest(java.lang.String accessRequestId,
                                boolean adminCrossTenantAccessRequestAllowed)
                         throws ContentAddressableStorageException

Specified by:

removeAccessRequest in interface DefaultOfferService

Throws:

ContentAddressableStorageException

checkObjectAvailability

public boolean checkObjectAvailability(java.lang.String containerName,
                                       java.util.List<java.lang.String> objectIds)
                                throws ContentAddressableStorageException

Specified by:

checkObjectAvailability in interface DefaultOfferService

Throws:

ContentAddressableStorageException

createObject

public java.lang.String createObject(java.lang.String containerName,
                                     java.lang.String objectId,
                                     java.io.InputStream objectPart,
                                     DataCategory type,
                                     long size,
                                     DigestType digestType)
                              throws ContentAddressableStorageException

Description copied from interface: DefaultOfferService

Create object on container with objectId Receive object part of object. Actually these parts HAVE TO be send in the great order.

Specified by:

createObject in interface DefaultOfferService

Parameters:

containerName - the container name

objectId - the offer objectId to create

objectPart - the part of the object to create (chunk style)

type - the object type to create

size - inputstream size

digestType - digest of object

Returns:

the digest of the complete file or the digest of the chunk

Throws:

ContentAddressableStorageException - if the container does not exist

bulkPutObjects

public StorageBulkPutResult bulkPutObjects(java.lang.String containerName,
                                           java.util.List<java.lang.String> objectIds,
                                           MultiplexedStreamReader multiplexedStreamReader,
                                           DataCategory type,
                                           DigestType digestType)
                                    throws ContentAddressableStorageException,
                                           java.io.IOException

Specified by:

bulkPutObjects in interface DefaultOfferService

Throws:

ContentAddressableStorageException

java.io.IOException

isObjectExist

public boolean isObjectExist(java.lang.String containerName,
                             java.lang.String objectId)
                      throws ContentAddressableStorageException

Description copied from interface: DefaultOfferService

Check if object exists

Specified by:

isObjectExist in interface DefaultOfferService

Parameters:

containerName - the container suppose to contain the object

objectId - the objectId to check

Returns:

true if object exists, false otherwise

Throws:

ContentAddressableStorageServerException

ContentAddressableStorageException

getCapacity

public ContainerInformation getCapacity(java.lang.String containerName)
                                 throws ContentAddressableStorageException

Description copied from interface: DefaultOfferService

Get container capacity

Specified by:

getCapacity in interface DefaultOfferService

Parameters:

containerName - the container name

Returns:

Json with usableSpace information

Throws:

ContentAddressableStorageNotFoundException - thrown if the container does not exist

ContentAddressableStorageServerException

ContentAddressableStorageException

deleteObject

public void deleteObject(java.lang.String containerName,
                         java.lang.String objectId,
                         DataCategory type)
                  throws ContentAddressableStorageException

Description copied from interface: DefaultOfferService

Deletes a object representing the data at location containerName/objectName

Specified by:

deleteObject in interface DefaultOfferService

Parameters:

containerName - container where this exists.

objectId - the objectId to delete

type - the object type to delete

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located or the blob cannot be located in the container.

ContentAddressableStorageException - Thrown when delete action failed due some other failure

getMetadata

public StorageMetadataResult getMetadata(java.lang.String containerName,
                                         java.lang.String objectId,
                                         boolean noCache)
                                  throws ContentAddressableStorageException

Description copied from interface: DefaultOfferService

Get Metadata

Specified by:

getMetadata in interface DefaultOfferService

Returns:

StorageMetadataResult

Throws:

ContentAddressableStorageException

getOfferLogs

public java.util.List<OfferLog> getOfferLogs(java.lang.String containerName,
                                             java.lang.Long offset,
                                             int limit,
                                             Order order)
                                      throws ContentAddressableStorageException

Description copied from interface: DefaultOfferService

Get the offer log of objects created in offer container

Specified by:

getOfferLogs in interface DefaultOfferService

Parameters:

containerName - container the container name

offset - the offset of the object before the wanted list

limit - number of objects wanted

order - order of search

Returns:

list of object informations

Throws:

ContentAddressableStorageDatabaseException - Database error

ContentAddressableStorageServerException - Parsing error

ContentAddressableStorageException

listObjects

public void listObjects(java.lang.String containerName,
                        ObjectListingListener objectListingListener)
                 throws java.io.IOException,
                        ContentAddressableStorageException

Description copied from interface: DefaultOfferService

List container objects

Specified by:

listObjects in interface DefaultOfferService

Parameters:

containerName - the container name

objectListingListener - a listener to which are reported found object entries

Throws:

java.io.IOException

ContentAddressableStorageException

compactOfferLogs

public void compactOfferLogs()
                      throws java.lang.Exception

Specified by:

compactOfferLogs in interface DefaultOfferService

Throws:

java.lang.Exception

getBulkMetadata

public StorageBulkMetadataResult getBulkMetadata(java.lang.String containerName,
                                                 java.util.List<java.lang.String> objectIds,
                                                 java.lang.Boolean noCache)
                                          throws ContentAddressableStorageException

Specified by:

getBulkMetadata in interface DefaultOfferService

Throws:

ContentAddressableStorageException