IngestInternalClient.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.ingest.internal.client;

import java.io.InputStream;

import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import fr.gouv.vitam.common.client.IngestCollection;
import fr.gouv.vitam.common.client.OperationManagementClient;
import fr.gouv.vitam.common.exception.VitamClientException;
import fr.gouv.vitam.common.exception.VitamException;
import fr.gouv.vitam.common.guid.GUID;
import fr.gouv.vitam.logbook.common.parameters.LogbookOperationParameters;

/**
 * Ingest Internal client interface
 */

public interface IngestInternalClient extends OperationManagementClient {

    /**
     *
     * Upload compressed SIP as stream
     *
     * @param archiveType is a format (mime type) of SIP (should be zip ,tar, tar.gz or tar.bz2)
     * @param inputStream SIP
     * @param contextId context Identifier
     * @throws VitamException if stream is null
     * @return Response {@link Response}
     *
     */
    Response upload(InputStream inputStream, MediaType archiveType, String contextId) throws VitamException;

    /**
     * Create only Logbook
     *
     * @param logbookParametersList
     * @return Response as just CREATED
     * @throws VitamException
     */
    Response uploadInitialLogbook(Iterable<LogbookOperationParameters> logbookParametersList)
        throws VitamException;

    /**
     * Finalize the ingest operation by sending back the final Logbook Operation entries from Ingest external
     *
     * @param logbookParametersList
     * @throws VitamClientException
     */
    void uploadFinalLogbook(Iterable<LogbookOperationParameters> logbookParametersList)
        throws VitamClientException;


    /**
     * Download object stored by ingest operation
     * 
     * @param objectId
     * @param type
     * @return object as stream
     * @throws VitamClientException
     */
    Response downloadObjectAsync(String objectId, IngestCollection type)
        throws VitamClientException;

    /**
     * Store ATR in storage
     * 
     * @param guid
     * @param input
     * @return Response OK
     * @throws VitamClientException
     */
    Response storeATR(GUID guid, InputStream input)
        throws VitamClientException;


}