fr.gouv.vitam.storage.offers.core

Interface DefaultOfferService

All Known Implementing Classes:

DefaultOfferServiceImpl

public interface DefaultOfferService

Default offer service interface define offer methods

Field Summary

Fields

Modifier and Type	Field and Description
static String	STORAGE_CONF_FILE_NAME

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)

Field Detail

STORAGE_CONF_FILE_NAME

static final String STORAGE_CONF_FILE_NAME

See Also:

Constant Field Values

Method Detail

getObjectDigest

String getObjectDigest(String containerName,
                       String objectId,
                       DigestType digestAlgorithm)
                throws ContentAddressableStorageException

Get offer storage digest of object

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

ObjectContent getObject(String containerName,
                        String objectId)
                 throws ContentAddressableStorageNotFoundException,
                        ContentAddressableStorageException

Get object on offer as an inputStream

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

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

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

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

Optional<TapeReadRequestReferentialEntity> getReadOrderRequest(String readRequestID)
                                                        throws ContentAddressableStorageException

Throws:

ContentAddressableStorageException

removeReadOrderRequest

void removeReadOrderRequest(String readRequestID)
                     throws ContentAddressableStorageException

Throws:

ContentAddressableStorageException

createObject

String createObject(String containerName,
                    String objectId,
                    InputStream objectPart,
                    DataCategory type,
                    Long size,
                    DigestType digestType)
             throws ContentAddressableStorageException

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

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

StorageBulkPutResult bulkPutObjects(String containerName,
                                    List<String> objectIds,
                                    MultiplexedStreamReader multiplexedStreamReader,
                                    DataCategory type,
                                    DigestType digestType)
                             throws ContentAddressableStorageException,
                                    IOException

Throws:

ContentAddressableStorageException

IOException

isObjectExist

boolean isObjectExist(String containerName,
                      String objectId)
               throws ContentAddressableStorageServerException

Check if object exists

Parameters:

containerName - the container suppose to contain the object

objectId - the objectId to check

Returns:

true if object exists, false otherwise

Throws:

ContentAddressableStorageServerException

getCapacity

ContainerInformation getCapacity(String containerName)
                          throws ContentAddressableStorageNotFoundException,
                                 ContentAddressableStorageServerException

Get container capacity

Parameters:

containerName - the container name

Returns:

Json with usableSpace information

Throws:

ContentAddressableStorageNotFoundException - thrown if the container does not exist

ContentAddressableStorageServerException

deleteObject

void deleteObject(String containerName,
                  String objectId,
                  DataCategory type)
           throws ContentAddressableStorageNotFoundException,
                  ContentAddressableStorageException

Deletes a object representing the data at location containerName/objectName

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

StorageMetadataResult getMetadata(String containerName,
                                  String objectId,
                                  boolean noCache)
                           throws ContentAddressableStorageException,
                                  IOException

Get Metadata

Parameters:

containerName -

objectId -

noCache -

Returns:

StorageMetadataResult

Throws:

ContentAddressableStorageException

IOException

createCursor

String createCursor(String containerName)
             throws ContentAddressableStorageNotFoundException,
                    ContentAddressableStorageServerException

Create a new cursor for listing container operation

Parameters:

containerName - the container name

Returns:

the cursor ID value

Throws:

ContentAddressableStorageNotFoundException - thrown when the container cannot be located

ContentAddressableStorageServerException - thrown when delete action failed due some other failure

hasNext

boolean hasNext(String containerName,
                String cursorId)

Check if iterator have a next value

Parameters:

containerName - the container name

cursorId - the cursor ID

Returns:

true if there is yet one or more value

next

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

Get next values

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

void finalizeCursor(String containerName,
                    String cursorId)

Close the cursor

Parameters:

containerName - the container name

cursorId - the cursor ID

getOfferLogs

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

Get the offer log of objects created in offer container

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