StorageClient.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.client;

import javax.ws.rs.core.Response;

import com.fasterxml.jackson.databind.JsonNode;

import fr.gouv.vitam.common.client.BasicClient;
import fr.gouv.vitam.common.client.VitamRequestIterator;
import fr.gouv.vitam.common.digest.DigestType;
import fr.gouv.vitam.storage.engine.client.exception.StorageAlreadyExistsClientException;
import fr.gouv.vitam.storage.engine.client.exception.StorageNotFoundClientException;
import fr.gouv.vitam.storage.engine.client.exception.StorageServerClientException;
import fr.gouv.vitam.storage.engine.common.exception.StorageNotFoundException;
import fr.gouv.vitam.storage.engine.common.model.DataCategory;
import fr.gouv.vitam.storage.engine.common.model.StorageCollectionType;
import fr.gouv.vitam.storage.engine.common.model.request.ObjectDescription;
import fr.gouv.vitam.storage.engine.common.model.response.StoredInfoResult;

/**
 * Storage Client interface
 */
public interface StorageClient extends BasicClient {

    /**
     * Check if the storage of objects could be done, knowing a required size
     *
     * @param strategyId
     *            the storage strategy id
     * @return the capacity of the storage
     * @throws StorageNotFoundClientException
     *             if the Server got a NotFound result
     * @throws StorageServerClientException
     *             if the Server got an internal error
     */
    JsonNode getStorageInformation(String strategyId) throws StorageNotFoundClientException, StorageServerClientException;

    /**
     * Store an object available in workspace by its vitam guid
     *
     * @param strategyId
     *            the storage strategy id
     * @param type
     *            the type of object collection
     * @param guid
     *            vitam guid
     * @param description
     *            object description
     * @throws StorageAlreadyExistsClientException
     *             if the Server got a CONFLICT status result
     * @throws StorageNotFoundClientException
     *             if the Server got a NotFound result
     * @throws StorageServerClientException
     *             if the Server got an internal error
     * @return the result status of object creation
     */
    StoredInfoResult storeFileFromWorkspace(String strategyId, StorageCollectionType type, String guid,
            ObjectDescription description)
            throws StorageAlreadyExistsClientException, StorageNotFoundClientException, StorageServerClientException;

    /**
     * Check the existance of a tenant container in storage by its id
     *
     * @param strategyId
     *            the storage strategy id
     * @return true if exist
     * @throws StorageServerClientException
     *             if the Server got an internal error
     */
    boolean existsContainer(String strategyId) throws StorageServerClientException;

    /**
     * Check the existence of an object in storage by its id and type
     * {@link StorageCollectionType}.
     *
     * @param strategyId
     *            the storage strategy id
     * @param type
     *            the type of object collection
     * @param guid
     *            vitam guid
     * @return true if exist
     * @throws StorageServerClientException
     *             if the Server got an internal error
     */
    boolean exists(String strategyId, StorageCollectionType type, String guid) throws StorageServerClientException;

    /**
     * Delete a container in the storage offer strategy A non-empty container
     * CANNOT be deleted !
     *
     * @param strategyId
     *            the storage strategy id
     * @return true if deleted
     * @throws StorageServerClientException
     *             if the Server got an internal error
     */
    boolean deleteContainer(String strategyId) throws StorageServerClientException;

    /**
     * Delete an object of given type in the storage offer strategy
     *
     * @param strategyId
     *            the storage strategy id
     * @param type
     *            the type of object collection
     * @param guid
     *            vitam guid
     * @param digest
     *            the digest to be compared with
     * @param digestAlgorithm
     *            the digest Algorithm
     * @return true if deleted
     * @throws StorageServerClientException
     *             if the Server got an internal error
     */
    boolean delete(String strategyId, StorageCollectionType type, String guid, String digest, DigestType digestAlgorithm)
            throws StorageServerClientException;

    /**
     * Retrieves a binary object knowing its guid as an inputStream for a
     * specific tenant/strategy
     *
     * @param strategyId
     *            the storage strategy id
     * @param guid
     *            vitam guid of the object to be returned
     * @param type
     * @return the object requested
     * @throws StorageServerClientException
     *             if the Server got an internal error
     * @throws StorageNotFoundException
     *             if the Server got a NotFound result, if the container or the
     *             object does not exist
     */
    Response getContainerAsync(String strategyId, String guid, StorageCollectionType type)
            throws StorageServerClientException, StorageNotFoundException;

    /**
     * List object type in container
     *
     * @param strategyId
     *            the strategy ID
     * @param type
     *            the object type to list
     * @return an iterator with object list
     * @throws StorageServerClientException
     *             thrown if the server got an internal error
     */
    VitamRequestIterator<JsonNode> listContainer(String strategyId, DataCategory type) throws StorageServerClientException;

}