org.firebirdsql.jca.FBResourceException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jaybird-jdk17 Show documentation
JDBC Driver for the Firebird RDBMS
There is a newer version: 4.0.10.java7
/*
 * Firebird Open Source JavaEE Connector - JDBC Driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a source control history command.
 *
 * All rights reserved.
 */
package org.firebirdsql.jca;

import org.firebirdsql.jdbc.SQLStateConstants;

import javax.resource.ResourceException;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.sql.SQLException;

/**
 * {@code FBResourceException} should be used in places where {@link ResourceException} should be thrown according to
 * the interface specification, but we do not want to lose the exception that we caught.
 * 
 * Example:
 * 
 * try {
 *     // execute some code here
 *     ...
 * } catch(GDSException gdsex) {
 *     throw new FBResourceException(gdsex);
 * }
 * 
 * 
 *
 * @author Roman Rokytskyy
 */
@SuppressWarnings("deprecation")
public class FBResourceException extends ResourceException {

    /* Some versions of JCA will call initCause from setLinkedException. A subsequent call to initCause will then
     * throw an IllegalStateException.
     * We check this behavior once, so we don't need to check if cause is null for each exception.
     */
    private static final boolean PERFORM_EXPLICIT_INIT_CAUSE;
    static {
        ResourceException resourceException = new ResourceException();
        resourceException.setLinkedException(new RuntimeException());
        PERFORM_EXPLICIT_INIT_CAUSE = resourceException.getCause() == null;
    }

    /**
     * @deprecated Use constants from {@link SQLStateConstants}. To be removed in Jaybird 4.
     */
    @Deprecated
    public static final String SQL_STATE_GENERAL_ERROR = SQLStateConstants.SQL_STATE_GENERAL_ERROR;

    /**
     * Create a new instance of {@code FBResourceException} with a given string message and generic error code.
     *
     * @param reason
     *         The string message for the exception
     */
    public FBResourceException(String reason) {
        super(reason, SQLStateConstants.SQL_STATE_GENERAL_ERROR);
    }

    /**
     * Create a new instance of {@code FBResourceException} with a message and specific error code.
     *
     * @param reason
     *         The string message for the exception
     * @param errorCode
     *         The error code for the cause of the exception
     */
    public FBResourceException(String reason, String errorCode) {
        super(reason, errorCode);
    }

    /**
     * Create a new instance of {@code FBResourceException} with a generic error code that is linked to another
     * (sub) exception.
     *
     * @param reason
     *         The string message for the exception
     * @param original
     *         The original exception to which this instance is to
     *         be linked to
     */
    public FBResourceException(String reason, Exception original) {
        super(reason, SQLStateConstants.SQL_STATE_GENERAL_ERROR);
        // Preserve setLinkedException for backwards compatibility
        setLinkedException(original);
        if (PERFORM_EXPLICIT_INIT_CAUSE) {
            initCause(original);
        }
        if (original instanceof SQLException) {
            SQLException origSql = (SQLException) original;
            if (origSql.getSQLState() != null) {
                setErrorCode(origSql.getSQLState());
            }
        }
    }

    /**
     * Create a new instance of {@code FBResourceException} with a generic error code that is linked to another
     * (sub) exception.
     *
     * @param original
     *         The original exception to which this instance is
     *         to be linked to
     */
    public FBResourceException(Exception original) {
        this(original.getMessage(), original);
    }

    /**
     * Get message of this exception.
     *
     * @return combined message of this exception and original exception.
     */
    public String getMessage() {
        String message = super.getMessage();
        String causeMessage = null;

        if (getCause() != null) {
            causeMessage = getCause().getMessage();
        } else if (getLinkedException() != null) {
            causeMessage = getLinkedException().getMessage();
        }

        if (causeMessage == null) {
            return message;
        }

        if (message == null) {
            return causeMessage;
        }

        return message + "\nReason: " + causeMessage;
    }


    /**
     * Print the stack trace of this exception to {@code STDERR}
     */
    public void printStackTrace() {
        printStackTrace(System.err);
    }

    /**
     * Print the stack trace of this exception to a given {@code PrintStream}
     *
     * @param s
     *         The {@code PrintStream} to which to write the stack trace
     */
    public void printStackTrace(PrintStream s) {
        super.printStackTrace(s);
        if (getLinkedException() != null) {
            s.print("at ");
            getLinkedException().printStackTrace(s);
        }
    }

    /**
     * Print the stack trace of this exception to a given {@code PrintWriter}
     *
     * @param s
     *         The {@code PrintWriter} to which to write the stack trace
     */
    public void printStackTrace(PrintWriter s) {
        super.printStackTrace(s);
        if (getLinkedException() != null) {
            s.print("at ");
            getLinkedException().printStackTrace(s);
        }
    }
}