StorageDriverException.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.exception;

/**
 * Exceptions to be thrown by the storage drivers
 *
 * Note: it is intended to NOT extends VitamException in order to not have a
 * dependency to common-public in this module
 */
public class StorageDriverException extends Exception {

    /**
     *
     */
    private static final long serialVersionUID = -5618781604751959001L;
    private final String driverInfo;
    private final ErrorCode errorCode;
    private static final String ERROR_MESSAGE = "An error occured for driver '";

    /**
     * Constructor with a message and additional info about the driver
     *
     * @param driverInfos
     *            information about the driver (id, name, version...)
     * @param errorCode
     *            code representing the error
     * @param message
     *            a message to add
     */
    public StorageDriverException(String driverInfos, ErrorCode errorCode, String message) {
        super(ERROR_MESSAGE + driverInfos + "' with message :" + message);
        driverInfo = driverInfos;
        this.errorCode = errorCode;
    }

    /**
     * Constructor with a message and an original exception and additional info
     * about the driver
     *
     * @param driverInfos
     *            information about the driver (id, name, version...)
     * @param errorCode
     *            code representing the error
     * @param message
     *            the exception message
     * @param cause
     *            the original exception
     */
    public StorageDriverException(String driverInfos, ErrorCode errorCode, String message, Throwable cause) {
        super(ERROR_MESSAGE + driverInfos + "' with message :" + message, cause);
        driverInfo = driverInfos;
        this.errorCode = errorCode;
    }

    /**
     * Constructor with an original exception and additional info about the
     * driver
     *
     * @param driverInfos
     *            information about the driver (id, name, version...)
     * @param errorCode
     *            code representing the error
     * @param cause
     *            the original exception
     */
    public StorageDriverException(String driverInfos, ErrorCode errorCode, Throwable cause) {
        super(ERROR_MESSAGE + driverInfos, cause);
        driverInfo = driverInfos;
        this.errorCode = errorCode;
    }

    /**
     * Get the driverInfo
     *
     * @return driverInfo
     */
    public String getDriverInfo() {
        return driverInfo;
    }

    /**
     * Get error code
     *
     * @return the error code
     */
    public ErrorCode getErrorCode() {
        return errorCode;
    }

    /**
     * Enum representing exception error
     */
    public enum ErrorCode {
        /**
         * Not found code
         */
        NOT_FOUND,
        /**
         * Precondition failed code
         */
        PRECONDITION_FAILED,
        /**
         * Internal server error code
         */
        INTERNAL_SERVER_ERROR
    }
}