fr.gouv.vitam.storage.offers.core

Class DefaultOfferServiceImpl

java.lang.Object

fr.gouv.vitam.storage.offers.core.DefaultOfferServiceImpl

All Implemented Interfaces:

DefaultOfferService

public class DefaultOfferServiceImpl
extends Object
implements DefaultOfferService

Default offer service implementation

Field Summary

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

STORAGE_CONF_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultOfferServiceImpl(OfferLogDatabaseService offerDatabaseService, MongoDbAccess mongoDBAccess)

Method Summary

Modifier and Type	Method and Description
StorageBulkPutResult	bulkPutObjects(String containerName, List<String> objectIds, MultiplexedStreamReader multiplexedStreamReader, DataCategory type, DigestType digestType)
String	createCursor(String containerName) Create a new cursor for listing container operation
String	createObject(String containerName, String objectId, InputStream objectPart, DataCategory type, Long size, DigestType digestType) Create object on container with objectId Receive object part of object.
Optional<TapeReadRequestReferentialEntity>	createReadOrderRequest(String containerName, List<String> objectsIds) create read order (asynchronous read from tape to local FS) for the given @containerName and objects list.
void	deleteObject(String containerName, String objectId, DataCategory type) Deletes a object representing the data at location containerName/objectName
void	finalizeCursor(String containerName, String cursorId) Close the cursor
ContainerInformation	getCapacity(String containerName) Get container capacity
StorageMetadataResult	getMetadata(String containerName, String objectId, boolean noCache) Get Metadata
ObjectContent	getObject(String containerName, String objectId) Get object on offer as an inputStream
String	getObjectDigest(String containerName, String objectId, DigestType digestAlgorithm) Get offer storage digest of object
List<OfferLog>	getOfferLogs(String containerName, Long offset, int limit, Order order) Get the offer log of objects created in offer container
Optional<TapeReadRequestReferentialEntity>	getReadOrderRequest(String readRequestID)
boolean	hasNext(String containerName, String cursorId) Check if iterator have a next value
boolean	isObjectExist(String containerName, String objectId) Check if object exists
List<com.fasterxml.jackson.databind.JsonNode>	next(String containerName, String cursorId) Get next values
void	removeReadOrderRequest(String readRequestID)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOfferServiceImpl

public DefaultOfferServiceImpl(OfferLogDatabaseService offerDatabaseService,
                               MongoDbAccess mongoDBAccess)
                        throws CertificateException,
                               NoSuchAlgorithmException,
                               KeyStoreException,
                               IOException,
                               KeyManagementException

Throws:

CertificateException

NoSuchAlgorithmException

KeyStoreException

IOException

KeyManagementException

Method Detail

getObjectDigest

public String getObjectDigest(String containerName,
                              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(String containerName,
                               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

createReadOrderRequest

public Optional<TapeReadRequestReferentialEntity> createReadOrderRequest(String containerName,
                                                                         List<String> objectsIds)
                                                                  throws ContentAddressableStorageException

Description copied from interface: DefaultOfferService

create read order (asynchronous read from tape to local FS) for the given @containerName and objects list. Return read order ID

Specified by:

createReadOrderRequest in interface DefaultOfferService

Parameters:

containerName - the container containing the object

objectsIds - the objects ids

Returns:

readOrder entity

Throws:

ContentAddressableStorageNotFoundException - thrown when object does not exists

ContentAddressableStorageException - thrown when a server error occurs

getReadOrderRequest

public Optional<TapeReadRequestReferentialEntity> getReadOrderRequest(String readRequestID)
                                                               throws ContentAddressableStorageException

Specified by:

getReadOrderRequest in interface DefaultOfferService

Throws:

ContentAddressableStorageException

removeReadOrderRequest

public void removeReadOrderRequest(String readRequestID)
                            throws ContentAddressableStorageException

Specified by:

removeReadOrderRequest in interface DefaultOfferService

Throws:

ContentAddressableStorageException

createObject

public String createObject(String containerName,
                           String objectId,
                           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(String containerName,
                                           List<String> objectIds,
                                           MultiplexedStreamReader multiplexedStreamReader,
                                           DataCategory type,
                                           DigestType digestType)
                                    throws ContentAddressableStorageException,
                                           IOException

Specified by:

bulkPutObjects in interface DefaultOfferService

Throws:

ContentAddressableStorageException

IOException

isObjectExist

public boolean isObjectExist(String containerName,
                             String objectId)
                      throws ContentAddressableStorageServerException

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

getCapacity

public ContainerInformation getCapacity(String containerName)
                                 throws ContentAddressableStorageNotFoundException,
                                        ContentAddressableStorageServerException

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

deleteObject

public void deleteObject(String containerName,
                         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(String containerName,
                                         String objectId,
                                         boolean noCache)
                                  throws ContentAddressableStorageException,
                                         IOException

Description copied from interface: DefaultOfferService

Get Metadata

Specified by:

getMetadata in interface DefaultOfferService

Returns:

StorageMetadataResult

Throws:

ContentAddressableStorageException

IOException

createCursor

public String createCursor(String containerName)
                    throws ContentAddressableStorageServerException

Description copied from interface: DefaultOfferService

Create a new cursor for listing container operation

Specified by:

createCursor in interface DefaultOfferService

Parameters:

containerName - the container name

Returns:

the cursor ID value

Throws:

ContentAddressableStorageServerException - thrown when delete action failed due some other failure

hasNext

public boolean hasNext(String containerName,
                       String cursorId)

Description copied from interface: DefaultOfferService

Check if iterator have a next value

Specified by:

hasNext in interface DefaultOfferService

Parameters:

containerName - the container name

cursorId - the cursor ID

Returns:

true if there is yet one or more value

next

public List<com.fasterxml.jackson.databind.JsonNode> next(String containerName,
                                                          String cursorId)
                                                   throws ContentAddressableStorageNotFoundException,
                                                          ContentAddressableStorageServerException

Description copied from interface: DefaultOfferService

Get next values

Specified by:

next in interface DefaultOfferService

Parameters:

containerName - the container name

cursorId - the cursor ID

Returns:

a list of next values

Throws:

ContentAddressableStorageNotFoundException - thrown when the container cannot be located

ContentAddressableStorageServerException

finalizeCursor

public void finalizeCursor(String containerName,
                           String cursorId)

Description copied from interface: DefaultOfferService

Close the cursor

Specified by:

finalizeCursor in interface DefaultOfferService

Parameters:

containerName - the container name

cursorId - the cursor ID

getOfferLogs

public List<OfferLog> getOfferLogs(String containerName,
                                   Long offset,
                                   int limit,
                                   Order order)
                            throws ContentAddressableStorageDatabaseException,
                                   ContentAddressableStorageServerException

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