jakarta.resource.spi.LocalTransactionException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.jakartaee-api Show documentation
Jakarta EE Platform API
There is a newer version: 11.0.0-M4
Show newest version
/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.resource.spi;

/** 
 * A LocalTransactionException represents various 
 * error conditions related to the local transaction management contract. 
 * The Jakarta™ Transactions specification specifies the 
 * javax.transaction.xa.XAException class for exceptions 
 * related to XAResource based transaction management contract. 
 *  
 * The LocalTransactionException is used for the local 
 * transaction management contract to indicate the following common 
 * error conditions:
 *  

 *  Invalid transaction context when a transaction operation is executed. 
 *      For example, calling commit method on 
 *      LocalTransaction object without an active
 *      local transaction is an error condition.
 *  
Transaction is rolled back instead of getting committed during a 
 *      commit method call on the LocalTransaction 
 *      object.
 *  
An attempt to start a local transaction from the same thread on a
 *      ManagedConnection that is already associated with
 *      an active local transaction.
 *  
Any resource adapter or resource manager specific error conditions 
 *      related to local transaction management. Examples are violation of 
 *      integrity of resources, deadlock detection, communication failure 
 *      during transaction completion, retry required or any internal error
 *      in a resource manager.
 *  
 *
 * @version 1.0
 * @author Rahul Sharma
 * @author Ram Jeyaraman
 */

public class LocalTransactionException 
        extends jakarta.resource.ResourceException {

    /**
     * Constructs a new instance with null as its detail message.
     */
    public LocalTransactionException() { super(); }

    /**
     * Constructs a new instance with the specified detail message.
     *
     * @param message the detail message.
     */
    public LocalTransactionException(String message) {
	super(message);
    }

    /**
     * Constructs a new throwable with the specified cause.
     *
     * @param cause a chained exception of type Throwable.
     */
    public LocalTransactionException(Throwable cause) {
	super(cause);
    }

    /**
     * Constructs a new throwable with the specified detail message and cause.
     *
     * @param message the detail message.
     *
     * @param cause a chained exception of type Throwable.
     */
    public LocalTransactionException(String message, Throwable cause) {
	super(message, cause);
    }

    /**
     * Constructs a new throwable with the specified detail message and
     * an error code.
     *
     * @param message a description of the exception.
     * @param errorCode a string specifying the vendor specific error code.
     */
    public LocalTransactionException(String message, String errorCode) {
	super(message, errorCode);
    }
}