StoragePutRequest.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.driver.model;

import java.io.InputStream;

/**
 * Holds every needed parameters that may be needed to put an object on the
 * distant storage offer.
 */
public class StoragePutRequest extends StorageObjectRequest {

    private final String digestAlgorithm;
    private final InputStream dataStream;

    /**
     * Initialize the needed parameters for put requests of an object.
     *
     * @param tenantId
     *            request tenantId
     * @param type
     *            the type
     * @param guid
     *            the object guid
     * @param digestAlgorithm
     *            the object digestAlgorithm
     * @param dataStream
     *            data stream of the object to put in offer
     */
    public StoragePutRequest(Integer tenantId, String type, String guid, String digestAlgorithm, InputStream dataStream) {
        super(tenantId, type, guid);
        this.digestAlgorithm = digestAlgorithm;
        this.dataStream = dataStream;
    }

    /**
     * Gets the digestAlgorithm
     * 
     * @return the digestAlgorithm
     */
    public String getDigestAlgorithm() {
        return digestAlgorithm;
    }

    /**
     * Gets the dataStream
     * 
     * @return the dataStream
     */
    public InputStream getDataStream() {
        return dataStream;
    }

    @Override
    public String toString() {
        return "DigestAlgo: " + digestAlgorithm + " DataStream:" + (dataStream != null) + " " + super.toString();
    }

}