fr.gouv.vitam.storage.engine.server.distribution

Interface StorageDistribution

All Superinterfaces:

AutoCloseable, VitamAutoCloseable

All Known Implementing Classes:

StorageDistributionImpl

public interface StorageDistribution
extends VitamAutoCloseable

Interface Storage Distribution for Storage Operations

Method Summary

Modifier and Type	Method and Description
boolean	checkObjectExisting(String strategyId, String objectId, List<String> offerIds) Verify if object exists
com.fasterxml.jackson.databind.JsonNode	createContainer(String strategyId) Create a container Architects are aware of this.
void	deleteContainer(String strategyId) Delete a container
void	deleteLogbook(String strategyId, String logbookId) Delete a logbook
void	deleteObject(String strategyId, String objectId, String digest, DigestType digestAlgorithm) Delete an object
void	deleteObjectGroup(String strategyId, String objectGroupId) Delete an ObjectGroup
void	deleteUnit(String strategyId, String unitId) Delete an unit
javax.ws.rs.core.Response	getContainerByCategory(String strategyId, String objectId, DataCategory category) Get a specific Object binary data as an input stream
com.fasterxml.jackson.databind.JsonNode	getContainerInformations(String strategyId) Get Storage Information (availability and capacity) for the requested tenant + strategy
com.fasterxml.jackson.databind.JsonNode	getContainerInformations(String strategyId, DataCategory type, String objectId, List<String> offerIds) Get a specific Object information
com.fasterxml.jackson.databind.JsonNode	getContainerLogbook(String strategyId, String logbookId) Get a specific Logbook as a JsonNode
com.fasterxml.jackson.databind.JsonNode	getContainerLogbooks(String strategyId) Retrieve a list of logbook ids associated to a given tenant
com.fasterxml.jackson.databind.JsonNode	getContainerObjectGroup(String strategyId, String objectGroupId) Get a specific ObjectGroup as a JsonNode
com.fasterxml.jackson.databind.JsonNode	getContainerObjectGroups(String strategyId) Get Container ObjectGroups Information
com.fasterxml.jackson.databind.JsonNode	getContainerUnit(String strategyId, String unitId) Get a specific Unit as a JsonNode
com.fasterxml.jackson.databind.JsonNode	getContainerUnits(String strategyId) Get Container Units Information
RequestResponse<OfferLog>	getOfferLogs(String strategyId, DataCategory category, Long offset, int limit, Order order) Get offer log from referent
InputStream	getStorageContainer(String strategyId) Get Storage Container full content as an InputStream
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	listContainerObjects(String strategyId, DataCategory category, String cursorId) List container objects
com.fasterxml.jackson.databind.JsonNode	status() Get the status from the service
StoredInfoResult	storeData(String strategyId, String objectId, ObjectDescription createObjectDescription, DataCategory category, String requester) Store data of any type for given tenant on storage offers associated to given strategy

Methods inherited from interface fr.gouv.vitam.common.model.VitamAutoCloseable

close

Method Detail

storeData

StoredInfoResult storeData(String strategyId,
                           String objectId,
                           ObjectDescription createObjectDescription,
                           DataCategory category,
                           String requester)
                    throws StorageAlreadyExistsException,
                           StorageException

Store data of any type for given tenant on storage offers associated to given strategy

Parameters:

strategyId - id of the strategy

objectId - the workspace URI of the data to be retrieve (and stored in offer)

createObjectDescription - object additional informations

category - the category of the data to store (unit, object...)

requester - the requester information

Returns:

a StoredInfoResult containing informations about the created Data

Throws:

StorageNotFoundException - Thrown if the Container does not exist

StorageTechnicalException - Thrown in case of any technical problem

StorageObjectAlreadyExistsException

StorageAlreadyExistsException

StorageException

getContainerInformations

com.fasterxml.jackson.databind.JsonNode getContainerInformations(String strategyId)
                                                          throws StorageException

Get Storage Information (availability and capacity) for the requested tenant + strategy

Parameters:

strategyId - id of the strategy

Returns:

a JsonNode containing informations about the storage

Throws:

StorageNotFoundException - Thrown if the Container does not exist

StorageTechnicalException - Thrown in case of any technical problem

StorageException

getStorageContainer

InputStream getStorageContainer(String strategyId)
                         throws StorageNotFoundException,
                                StorageTechnicalException

Get Storage Container full content as an InputStream

Parameters:

strategyId - id of the strategy

Returns:

the content of the container as an InputStream

Throws:

StorageNotFoundException - Thrown if the Storage Container does not exist

StorageTechnicalException - Thrown if a technical exception is encountered

createContainer

com.fasterxml.jackson.databind.JsonNode createContainer(String strategyId)
                                                 throws StorageException

Create a container Architects are aware of this.

Parameters:

strategyId - id of the strategy

Returns:

a JsonNode containing informations about the created Container

Throws:

StorageException - Thrown in case the Container already exists

deleteContainer

void deleteContainer(String strategyId)
              throws StorageTechnicalException,
                     StorageNotFoundException

Delete a container

aware of this.

Parameters:

strategyId - id of the strategy

Throws:

StorageTechnicalException - Thrown in case of any technical problem

StorageNotFoundException - Thrown in case the Container does not exist

listContainerObjects

RequestResponse<com.fasterxml.jackson.databind.JsonNode> listContainerObjects(String strategyId,
                                                                              DataCategory category,
                                                                              String cursorId)
                                                                       throws StorageException

List container objects

Parameters:

strategyId - the strategy id to get offers

category - the object type to list

cursorId - the cursorId if exists

Returns:

a response with object listing

Throws:

StorageException - thrown in case of any technical problem

getOfferLogs

RequestResponse<OfferLog> getOfferLogs(String strategyId,
                                       DataCategory category,
                                       Long offset,
                                       int limit,
                                       Order order)
                                throws StorageException

Get offer log from referent

Parameters:

strategyId - the strategy id to get offers

category - the object type to list

offset - offset of the excluded object

limit - the number of result wanted

order - order

Returns:

list of offer log

Throws:

StorageException - thrown in case of any technical problem

getContainerByCategory

javax.ws.rs.core.Response getContainerByCategory(String strategyId,
                                                 String objectId,
                                                 DataCategory category)
                                          throws StorageException

Get a specific Object binary data as an input stream

Parameters:

strategyId - id of the strategy

objectId - id of the object

category -

Returns:

an object as a Response with an InputStream

Throws:

StorageNotFoundException - Thrown if the Container or the object does not exist

StorageTechnicalException - thrown if a technical error happened

StorageException

getContainerInformations

com.fasterxml.jackson.databind.JsonNode getContainerInformations(String strategyId,
                                                                 DataCategory type,
                                                                 String objectId,
                                                                 List<String> offerIds)
                                                          throws StorageException

Get a specific Object information

Parameters:

strategyId - id of the strategy

type - data category

objectId - id of the object

offerIds - list id of offers

Returns:

JsonNode containing informations about the requested object

Throws:

StorageException

checkObjectExisting

boolean checkObjectExisting(String strategyId,
                            String objectId,
                            List<String> offerIds)
                     throws StorageException

Verify if object exists

Parameters:

strategyId - id of the strategy

objectId - id of the object

offerIds - list id of offers

Returns:

Throws:

StorageException

deleteObject

void deleteObject(String strategyId,
                  String objectId,
                  String digest,
                  DigestType digestAlgorithm)
           throws StorageException

Delete an object

Parameters:

strategyId - id of the strategy

objectId - id of the object to be deleted

digest - the digest to be compared with

digestAlgorithm - the digest Algorithm

Throws:

StorageNotFoundException - Thrown if the Container or the object does not exist

StorageTechnicalException - thrown if a technical error happened

StorageException

getContainerLogbooks

com.fasterxml.jackson.databind.JsonNode getContainerLogbooks(String strategyId)
                                                      throws StorageNotFoundException

Retrieve a list of logbook ids associated to a given tenant

Parameters:

strategyId - id of the strategy

Returns:

a JsonNode containing informations about logbooks of the requested container

Throws:

StorageNotFoundException - Thrown if the Container does not exist

getContainerLogbook

com.fasterxml.jackson.databind.JsonNode getContainerLogbook(String strategyId,
                                                            String logbookId)
                                                     throws StorageNotFoundException

Get a specific Logbook as a JsonNode

Parameters:

strategyId - id of the strategy

logbookId - id of the logbook

Returns:

a logbook as a JsonNode

Throws:

StorageNotFoundException - Thrown if the Container or the object does not exist

deleteLogbook

void deleteLogbook(String strategyId,
                   String logbookId)
            throws UnsupportedOperationException

Delete a logbook

Parameters:

strategyId - id of the strategy

logbookId - id of the logbook to be deleted

Throws:

UnsupportedOperationException - method not implemented yet

getContainerUnits

com.fasterxml.jackson.databind.JsonNode getContainerUnits(String strategyId)
                                                   throws UnsupportedOperationException

Get Container Units Information

Parameters:

strategyId - id of the strategy

Returns:

a JsonNode containing informations about units of the requested container

Throws:

UnsupportedOperationException - method not implemented yet

getContainerUnit

com.fasterxml.jackson.databind.JsonNode getContainerUnit(String strategyId,
                                                         String unitId)
                                                  throws UnsupportedOperationException

Get a specific Unit as a JsonNode

Parameters:

strategyId - id of the strategy

unitId - id of the unit

Returns:

a unit as a JsonNode

Throws:

UnsupportedOperationException - method not implemented yet

deleteUnit

void deleteUnit(String strategyId,
                String unitId)
         throws UnsupportedOperationException

Delete an unit

Parameters:

strategyId - id of the strategy

unitId - id of the Unit to be deleted

Throws:

UnsupportedOperationException - method not implemented yet

getContainerObjectGroups

com.fasterxml.jackson.databind.JsonNode getContainerObjectGroups(String strategyId)
                                                          throws UnsupportedOperationException

Get Container ObjectGroups Information

Parameters:

strategyId - id of the strategy

Returns:

a JsonNode containing informations about objectGroups of the requested container

Throws:

UnsupportedOperationException - method not implemented yet

getContainerObjectGroup

com.fasterxml.jackson.databind.JsonNode getContainerObjectGroup(String strategyId,
                                                                String objectGroupId)
                                                         throws UnsupportedOperationException

Get a specific ObjectGroup as a JsonNode

Parameters:

strategyId - id of the strategy

objectGroupId - id of the ObjectGroup

Returns:

an objectGroup as a JsonNode

Throws:

UnsupportedOperationException - method not implemented yet

deleteObjectGroup

void deleteObjectGroup(String strategyId,
                       String objectGroupId)
                throws UnsupportedOperationException

Delete an ObjectGroup

Parameters:

strategyId - id of the strategy

objectGroupId - id of the ObjectGroup to be deleted

Throws:

UnsupportedOperationException - method not implemented yet

status

com.fasterxml.jackson.databind.JsonNode status()
                                        throws UnsupportedOperationException

Get the status from the service

Returns:

the status as a JsonNode

Throws:

UnsupportedOperationException - method not implemented yet