Package fr.gouv.vitam.storage.engine.common.referential

# Interface StorageOfferHACapabilityProvider

public interface StorageOfferHACapabilityProvider
This interface aims to provide a set of methods (or adjust some ones in `StorageOfferProvider`) that offer some HA (High Availability) capabilities : Through manual or automatic failover mechanism to make an offer in inactive state

no concerns of the offer configuration persistence implementation (ie: implementation could be Filesystem, Database...)

- ## Method Summary

  Modifier and Type
  Method
  Description
  `StorageOffer`
  `getStorageOfferForHA(String idOffer, boolean includeDisabled)`
  Retrieve an offer full configuration by its id, may include disabled one ( `ActivationStatus.INACTIVE`)

- ## Method Details

  - ### getStorageOfferForHA

    StorageOffer getStorageOfferForHA(String idOffer, boolean includeDisabled) throws StorageException
    Retrieve an offer full configuration by its id, may include disabled one ( `ActivationStatus.INACTIVE`)
    Parameters:
      `idOffer` - the id of the storage offer to retrieve
      `includeDisabled` - whether to include offer with inactive state
    Returns:
      an object representation of a storage offer
    Throws:
      `StorageException` - if any unwanted technical issue happens