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

Class StorageDistributionImpl

java.lang.Object

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

All Implemented Interfaces:

VitamAutoCloseable, StorageDistribution, AutoCloseable

public class StorageDistributionImpl
extends Object
implements StorageDistribution

StorageDistribution service Implementation process continue if needed)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY_IS_MANDATORY

Constructor Summary

Constructors

Constructor and Description
StorageDistributionImpl(StorageConfiguration configuration, StorageLogService storageLogService) Constructs the service with a given configuration

Method Summary

Modifier and Type	Method and Description
boolean	checkObjectExisting(String strategyId, String objectId, List<String> offerIds) Verify if object exists
void	close()
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 class java.lang.Object

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

Field Detail

CATEGORY_IS_MANDATORY

public static final String CATEGORY_IS_MANDATORY

See Also:

Constant Field Values

Constructor Detail

StorageDistributionImpl

public StorageDistributionImpl(StorageConfiguration configuration,
                               StorageLogService storageLogService)

Constructs the service with a given configuration

Parameters:

configuration - the configuration of the storage

storageLogService -

Method Detail

storeData

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

Description copied from interface: StorageDistribution

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

Specified by:

storeData in interface StorageDistribution

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

StorageException

getContainerInformations

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

Description copied from interface: StorageDistribution

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

Specified by:

getContainerInformations in interface StorageDistribution

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

public InputStream getStorageContainer(String strategyId)
                                throws StorageNotFoundException,
                                       StorageTechnicalException

Description copied from interface: StorageDistribution

Get Storage Container full content as an InputStream

Specified by:

getStorageContainer in interface StorageDistribution

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

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

Description copied from interface: StorageDistribution

Create a container Architects are aware of this.

Specified by:

createContainer in interface StorageDistribution

Parameters:

strategyId - id of the strategy

Returns:

a JsonNode containing informations about the created Container

Throws:

UnsupportedOperationException

deleteContainer

public void deleteContainer(String strategyId)
                     throws UnsupportedOperationException

Description copied from interface: StorageDistribution

Delete a container

aware of this.

Specified by:

deleteContainer in interface StorageDistribution

Parameters:

strategyId - id of the strategy

Throws:

UnsupportedOperationException

listContainerObjects

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

Description copied from interface: StorageDistribution

List container objects

Specified by:

listContainerObjects in interface StorageDistribution

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

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

Description copied from interface: StorageDistribution

Get offer log from referent

Specified by:

getOfferLogs in interface StorageDistribution

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

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

Description copied from interface: StorageDistribution

Get a specific Object binary data as an input stream

Specified by:

getContainerByCategory in interface StorageDistribution

Parameters:

strategyId - id of the strategy

objectId - id of the object

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

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

Description copied from interface: StorageDistribution

Get a specific Object information

Specified by:

getContainerInformations in interface StorageDistribution

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

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

Description copied from interface: StorageDistribution

Verify if object exists

Specified by:

checkObjectExisting in interface StorageDistribution

Parameters:

strategyId - id of the strategy

objectId - id of the object

offerIds - list id of offers

Returns:

Throws:

StorageException

deleteObject

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

Description copied from interface: StorageDistribution

Delete an object

Specified by:

deleteObject in interface StorageDistribution

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

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

Description copied from interface: StorageDistribution

Retrieve a list of logbook ids associated to a given tenant

Specified by:

getContainerLogbooks in interface StorageDistribution

Parameters:

strategyId - id of the strategy

Returns:

a JsonNode containing informations about logbooks of the requested container

Throws:

UnsupportedOperationException

getContainerLogbook

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

Description copied from interface: StorageDistribution

Get a specific Logbook as a JsonNode

Specified by:

getContainerLogbook in interface StorageDistribution

Parameters:

strategyId - id of the strategy

logbookId - id of the logbook

Returns:

a logbook as a JsonNode

Throws:

UnsupportedOperationException

deleteLogbook

public void deleteLogbook(String strategyId,
                          String logbookId)
                   throws UnsupportedOperationException

Description copied from interface: StorageDistribution

Delete a logbook

Specified by:

deleteLogbook in interface StorageDistribution

Parameters:

strategyId - id of the strategy

logbookId - id of the logbook to be deleted

Throws:

UnsupportedOperationException - method not implemented yet

getContainerUnits

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

Description copied from interface: StorageDistribution

Get Container Units Information

Specified by:

getContainerUnits in interface StorageDistribution

Parameters:

strategyId - id of the strategy

Returns:

a JsonNode containing informations about units of the requested container

Throws:

UnsupportedOperationException - method not implemented yet

getContainerUnit

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

Description copied from interface: StorageDistribution

Get a specific Unit as a JsonNode

Specified by:

getContainerUnit in interface StorageDistribution

Parameters:

strategyId - id of the strategy

unitId - id of the unit

Returns:

a unit as a JsonNode

Throws:

UnsupportedOperationException - method not implemented yet

deleteUnit

public void deleteUnit(String strategyId,
                       String unitId)
                throws UnsupportedOperationException

Description copied from interface: StorageDistribution

Delete an unit

Specified by:

deleteUnit in interface StorageDistribution

Parameters:

strategyId - id of the strategy

unitId - id of the Unit to be deleted

Throws:

UnsupportedOperationException - method not implemented yet

getContainerObjectGroups

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

Description copied from interface: StorageDistribution

Get Container ObjectGroups Information

Specified by:

getContainerObjectGroups in interface StorageDistribution

Parameters:

strategyId - id of the strategy

Returns:

a JsonNode containing informations about objectGroups of the requested container

Throws:

UnsupportedOperationException - method not implemented yet

getContainerObjectGroup

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

Description copied from interface: StorageDistribution

Get a specific ObjectGroup as a JsonNode

Specified by:

getContainerObjectGroup in interface StorageDistribution

Parameters:

strategyId - id of the strategy

objectGroupId - id of the ObjectGroup

Returns:

an objectGroup as a JsonNode

Throws:

UnsupportedOperationException - method not implemented yet

deleteObjectGroup

public void deleteObjectGroup(String strategyId,
                              String objectGroupId)
                       throws UnsupportedOperationException

Description copied from interface: StorageDistribution

Delete an ObjectGroup

Specified by:

deleteObjectGroup in interface StorageDistribution

Parameters:

strategyId - id of the strategy

objectGroupId - id of the ObjectGroup to be deleted

Throws:

UnsupportedOperationException - method not implemented yet

status

public com.fasterxml.jackson.databind.JsonNode status()

Description copied from interface: StorageDistribution

Get the status from the service

Specified by:

status in interface StorageDistribution

Returns:

the status as a JsonNode

close

public void close()

Specified by:

close in interface VitamAutoCloseable

Specified by:

close in interface AutoCloseable