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	DIGEST

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	checkObjectExisting(String strategyId, String objectId, DataCategory category, List<String> offerIds) Verify if object exists
void	close()
StoredInfoResult	copyObjectFromOfferToOffer(DataContext context, String sourceOffer, String destinationOffer) copy object from on offer to an another
com.fasterxml.jackson.databind.JsonNode	createContainer(String strategyId) Create a container Architects are aware of this.
void	deleteObjectInAllOffers(String strategyId, DataContext context) Delete an object
void	deleteObjectInOffers(String strategyId, DataContext context, List<String> offers) Delete an object in offers
javax.ws.rs.core.Response	getContainerByCategory(String strategyId, String objectId, DataCategory category, AccessLogInfoModel logInformation) Get a specific Object binary data as an input stream
javax.ws.rs.core.Response	getContainerByCategory(String strategyId, String objectId, DataCategory category, String offerId) Get a specific Object binary data as an input stream
com.fasterxml.jackson.databind.JsonNode	getContainerInformation(String strategyId) Get Storage Information (availability and capacity) for the requested tenant + strategy
com.fasterxml.jackson.databind.JsonNode	getContainerInformation(String strategyId, DataCategory type, String objectId, List<String> offerIds) Get a specific Object information
List<String>	getOfferIds(String strategyId) get offer ids list
RequestResponse<OfferLog>	getOfferLogs(String strategyId, DataCategory category, Long offset, int limit, Order order) Get offer log from referent
RequestResponse<OfferLog>	getOfferLogsByOfferId(String strategyId, String offerId, DataCategory category, Long offset, int limit, Order order) Get offer log from the given offer
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	storeDataInAllOffers(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
StoredInfoResult	storeDataInOffers(String strategyId, StreamAndInfo streamAndInfo, String objectId, DataCategory category, String requester, List<String> offerIds)
StoredInfoResult	storeDataInOffers(String strategyId, String objectId, DataCategory category, String requester, List<String> offerIds, javax.ws.rs.core.Response response) Store data of any type for given tenant on the given storage offer.

Methods inherited from class java.lang.Object

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

Field Detail

DIGEST

public static final String DIGEST

See Also:

Constant Field Values

Constructor Detail

StorageDistributionImpl

public StorageDistributionImpl(StorageConfiguration configuration,
                               StorageLog storageLogService)

Constructs the service with a given configuration

Parameters:

configuration - the configuration of the storage

storageLogService - service that allow write and access log

Method Detail

copyObjectFromOfferToOffer

public StoredInfoResult copyObjectFromOfferToOffer(DataContext context,
                                                   String sourceOffer,
                                                   String destinationOffer)
                                            throws StorageException

Description copied from interface: StorageDistribution

copy object from on offer to an another

Specified by:

copyObjectFromOfferToOffer in interface StorageDistribution

Parameters:

context - the context

sourceOffer - source offer

destinationOffer - destination Offer

Returns:

StoredInfoResult Object

Throws:

StorageException - StorageException

storeDataInOffers

public StoredInfoResult storeDataInOffers(String strategyId,
                                          String objectId,
                                          DataCategory category,
                                          String requester,
                                          List<String> offerIds,
                                          javax.ws.rs.core.Response response)
                                   throws StorageException

Description copied from interface: StorageDistribution

Store data of any type for given tenant on the given storage offer.

Specified by:

storeDataInOffers in interface StorageDistribution

Parameters:

strategyId - id of the strategy

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

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

requester - the requester information

offerIds - offer identfier

response - the response

Returns:

a StoredInfoResult containing informations about the created Data

Throws:

StorageException - StorageException

storeDataInOffers

public StoredInfoResult storeDataInOffers(String strategyId,
                                          StreamAndInfo streamAndInfo,
                                          String objectId,
                                          DataCategory category,
                                          String requester,
                                          List<String> offerIds)
                                   throws StorageException

Specified by:

storeDataInOffers in interface StorageDistribution

Parameters:

strategyId - id of the strategy

streamAndInfo - streamAndInfo

objectId - id of the object

category - the object type to list

requester - the requester information

offerIds - offer identfiers

Returns:

StoredInfoResult

Throws:

StorageException - StorageException

storeDataInAllOffers

public StoredInfoResult storeDataInAllOffers(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:

storeDataInAllOffers 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:

StorageException - StorageException

getOfferIds

public List<String> getOfferIds(String strategyId)
                         throws StorageException

Description copied from interface: StorageDistribution

get offer ids list

Specified by:

getOfferIds in interface StorageDistribution

Parameters:

strategyId - strategy id

Returns:

offers ids list

Throws:

StorageException

getContainerInformation

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

Description copied from interface: StorageDistribution

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

Specified by:

getContainerInformation 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

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

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

getOfferLogsByOfferId

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

Get offer log from the given offer

Specified by:

getOfferLogsByOfferId in interface StorageDistribution

Parameters:

strategyId - the strategy id to get offers

offerId - offerId

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,
                                                        AccessLogInfoModel logInformation)
                                                 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

category - category of the object

logInformation - information for accessLog

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

getContainerByCategory

public javax.ws.rs.core.Response getContainerByCategory(String strategyId,
                                                        String objectId,
                                                        DataCategory category,
                                                        String offerId)
                                                 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

category - category

offerId - offer identfier

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

getContainerInformation

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

Description copied from interface: StorageDistribution

Get a specific Object information

Specified by:

getContainerInformation 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,
                                   DataCategory category,
                                   List<String> offerIds)
                            throws StorageException

Verify if object exists

Specified by:

checkObjectExisting in interface StorageDistribution

Parameters:

strategyId - id of the strategy

objectId - id of the object

category - category

offerIds - list id of offers @return

Returns:

boolean

Throws:

StorageException - StorageException

deleteObjectInAllOffers

public void deleteObjectInAllOffers(String strategyId,
                                    DataContext context)
                             throws StorageException

Description copied from interface: StorageDistribution

Delete an object

Specified by:

deleteObjectInAllOffers in interface StorageDistribution

Parameters:

strategyId - id of the strategy

Throws:

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

StorageTechnicalException - thrown if a technical error happened

StorageException

deleteObjectInOffers

public void deleteObjectInOffers(String strategyId,
                                 DataContext context,
                                 List<String> offers)
                          throws StorageException

Description copied from interface: StorageDistribution

Delete an object in offers

Specified by:

deleteObjectInOffers in interface StorageDistribution

Parameters:

strategyId - id of the strategy

context - context

offers - offers

Throws:

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

StorageTechnicalException - thrown if a technical error happened

StorageException

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