org.firebirdsql.gds.ng.TransactionHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation
JDBC Driver for the Firebird RDBMS
The newest version!
/*
 * Firebird Open Source 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.gds.ng;

import org.firebirdsql.jdbc.SQLStateConstants;

import java.sql.SQLException;
import java.sql.SQLNonTransientException;

/**
 * Class with static helper methods for use with transactions
 *
 * @author Mark Rotteveel
 * @since 3.0
 */
public final class TransactionHelper {

    public static final String NO_TRANSACTION_ACTIVE = "No transaction or transaction not ACTIVE";

    private TransactionHelper() {
        // no instances
    }

    /**
     * Checks if the transaction is {@link TransactionState#ACTIVE}.
     *
     * @param transaction
     *         transaction to check
     * @throws SQLException
     *         when {@code transaction} is {@code null}, or its state is not active
     */
    public static void checkTransactionActive(FbTransaction transaction) throws SQLException {
        if (transaction == null || transaction.getState() != TransactionState.ACTIVE) {
            throw new SQLNonTransientException(NO_TRANSACTION_ACTIVE, SQLStateConstants.SQL_STATE_INVALID_TX_STATE);
        }
    }

    /**
     * Checks if the transaction is {@link TransactionState#ACTIVE}.
     *
     * @param transaction
     *         transaction to check
     * @param fbErrorCode
     *         Firebird error code to use for generating the exception message
     * @throws SQLException
     *         when {@code transaction} is {@code null}, or its state is not active
     */
    public static void checkTransactionActive(FbTransaction transaction, final int fbErrorCode) throws SQLException {
        if (transaction == null || transaction.getState() != TransactionState.ACTIVE) {
            throw FbExceptionBuilder.forNonTransientException(fbErrorCode).toSQLException();
        }
    }

    /**
     * Checks if the transaction is ending (meaning its state is {@link TransactionState#COMMITTING},
     * {@link TransactionState#ROLLING_BACK} or {@link TransactionState#PREPARING}).
     *
     * @param transaction
     *         transaction to check
     * @return {@code true} if the state is {@code COMMITTING}, {@code ROLLING_BACK} or {@code PREPARING}, otherwise
     * {@code false} (including when {@code transaction} is {@code null})
     * @since 6
     */
    public static boolean isTransactionEnding(FbTransaction transaction) {
        if (transaction == null) return false;
        return switch(transaction.getState()) {
            case COMMITTING, ROLLING_BACK, PREPARING -> true;
            default -> false;
        };
    }

}