DriverMapper.java

/*******************************************************************************
 * Copyright French Prime minister Office/SGMAP/DINSIC/Vitam Program (2015-2019)
 *
 * contact.vitam@culture.gouv.fr
 *
 * This software is a computer program whose purpose is to implement a digital archiving back-office system managing
 * high volumetry securely and efficiently.
 *
 * This software is governed by the CeCILL 2.1 license under French law and abiding by the rules of distribution of free
 * software. You can use, modify and/ or redistribute the software under the terms of the CeCILL 2.1 license as
 * circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license,
 * users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the
 * successive licensors have only limited liability.
 *
 * In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or
 * developing or reproducing the software by the user in light of its specific status of free software, that may mean
 * that it is complicated to manipulate, and that also therefore means that it is reserved for developers and
 * experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the
 * software's suitability as regards their requirements in conditions enabling the security of their systems and/or data
 * to be ensured and, more generally, to use and operate it in the same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had knowledge of the CeCILL 2.1 license and that you
 * accept its terms.
 *******************************************************************************/

package fr.gouv.vitam.storage.engine.server.spi.mapper;

import java.util.List;

import fr.gouv.vitam.storage.engine.common.exception.StorageDriverMapperException;

/**
 * Interface use to implement DriverMapper. This object is use to persist
 * informations about drivers and offers associations.
 */
public interface DriverMapper {

    /**
     * Get persisted offers list for a driver
     *
     * @param driverName
     *            the driver name
     * @return offers IDs list for driverName or empty list if there is actually
     *         no association
     * @throws StorageDriverMapperException
     *             if application cannot have information (reading error for
     *             example)
     */
    List<String> getOffersFor(String driverName) throws StorageDriverMapperException;

    /**
     * Add one offer to a driver's offers persisted list (and persists it)
     *
     * @param offerId
     *            the offer ID to add and persist
     * @param driverName
     *            the driver name
     * @throws StorageDriverMapperException
     *             if application cannot have information (writing error for
     *             example)
     */
    void addOfferTo(String offerId, String driverName) throws StorageDriverMapperException;

    /**
     * Add list of offers to a driver's offers persisted list (and persists it)
     *
     * @param offersIdsToAdd
     *            the offers IDs list to add and persist
     * @param driverName
     *            the driver name
     * @throws StorageDriverMapperException
     *             if application cannot have information (writing error for
     *             example)
     */
    void addOffersTo(List<String> offersIdsToAdd, String driverName) throws StorageDriverMapperException;

    /**
     * Remove one offer to a driver's offers persisted list (and persists it)
     *
     * @param offerId
     *            the offer ID to remove and persist
     * @param driverName
     *            the driver name
     * @throws StorageDriverMapperException
     *             if application cannot have information (writing error for
     *             example)
     */
    void removeOfferTo(String offerId, String driverName) throws StorageDriverMapperException;

    /**
     * Remove list of offers to a driver's offers persisted list (and persist
     * it)
     *
     * @param offersIdsToRemove
     *            the offers IDs list to remove and persist
     * @param driverName
     *            the driver name
     * @throws StorageDriverMapperException
     *             if application cannot have information (writing error for
     *             example)
     */
    void removeOffersTo(List<String> offersIdsToRemove, String driverName) throws StorageDriverMapperException;
}