AccessInternalModule.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.access.internal.api;

import javax.ws.rs.container.AsyncResponse;

import com.fasterxml.jackson.databind.JsonNode;

import fr.gouv.vitam.access.internal.common.exception.AccessInternalExecutionException;
import fr.gouv.vitam.common.exception.InvalidParseOperationException;
import fr.gouv.vitam.metadata.api.exception.MetaDataNotFoundException;
import fr.gouv.vitam.storage.engine.common.exception.StorageNotFoundException;

/**
 * AccessModule interface for database operations in select
 */
public interface AccessInternalModule {

    /**
     * select Unit
     *
     * @param queryJson as String { $query : query}
     * @return the result of the select on Unit
     * @throws IllegalArgumentException if json query is null
     * @throws InvalidParseOperationException Throw if json format is not correct
     * @throws AccessInternalExecutionException Throw if error occurs when send Unit to database
     */
    public JsonNode selectUnit(JsonNode queryJson)
        throws InvalidParseOperationException, AccessInternalExecutionException;

    /**
     * select Unit by id
     *
     * @param queryJson as String { $query : query}
     * @param idUnit as String
     * @return the corresponding JsonNode
     *
     * @throws InvalidParseOperationException Throw if json format is not correct
     * @throws AccessInternalExecutionException Throw if error occurs when send Unit to database
     * @throws IllegalArgumentException Throw if error occurs when checking argument
     */
    public JsonNode selectUnitbyId(JsonNode queryJson, String idUnit)
        throws InvalidParseOperationException, AccessInternalExecutionException;

    /**
     * update Unit by id
     *
     * @param queryJson json update query
     * @param idUnit as String
     * @param requestId the request id
     * @return the result of the update on Unit
     *
     * @throws InvalidParseOperationException Throw if json format is not correct
     * @throws AccessInternalExecutionException Throw if error occurs when send Unit to database
     * @throws IllegalArgumentException Throw if error occurs when checking argument
     */
    public JsonNode updateUnitbyId(JsonNode queryJson, String idUnit, String requestId)
        throws InvalidParseOperationException, AccessInternalExecutionException;

    /**
     * Retrieve an ObjectGroup by its id with results fields filtered based on given query
     *
     * @param queryJson the query DSL as a Json node
     * @param idObjectGroup the id of the ObjectGroup as
     * @return the ObjectGroup metadata as a JsonNode
     * @throws IllegalArgumentException in case of null/incorrect parameters
     * @throws InvalidParseOperationException thrown if json query is not syntactically correct
     * @throws AccessInternalExecutionException in case of access failure
     */
    JsonNode selectObjectGroupById(JsonNode queryJson, String idObjectGroup)
        throws InvalidParseOperationException, AccessInternalExecutionException;

    /**
     * Retrieve an object as InputStream based on the associated ObjectGroupId and qualifier + version requested
     *
     * @param asyncResponse the async Response
     * @param idObjectGroup The Object Group Id
     * @param queryJson the DSL query
     * @param qualifier the qualifier to be retrieve (ie: Dissemination etc.)
     * @param version the version number to get
     * @return The object requested as an InputStream within a Response from remote server and its original filename and
     *         mimetype
     *
     * @throws MetaDataNotFoundException If the ObjectGroup could not be find
     * @throws StorageNotFoundException If the object is not found in storage
     * @throws InvalidParseOperationException when a query is badly structured
     * @throws AccessInternalExecutionException For other technical errors
     */
    AccessBinaryData getOneObjectFromObjectGroup(AsyncResponse asyncResponse, String idObjectGroup, JsonNode queryJson,
        String qualifier, int version)
        throws MetaDataNotFoundException, StorageNotFoundException, InvalidParseOperationException,
        AccessInternalExecutionException;
}