/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.resource.spi;
/**
* A <code>LocalTransactionException</code> represents various
* error conditions related to the local transaction management contract.
* The Java Transaction API specification specifies the
* <code>javax.transaction.xa.XAException</code> class for exceptions
* related to XAResource based transaction management contract.
*
* <p>The <code>LocalTransactionException</code> is used for the local
* transaction management contract to indicate the following common
* error conditions:
* <UL>
* <LI>Invalid transaction context when a transaction operation is executed.
* For example, calling <code>commit</code> method on
* <code>LocalTransaction</code> object without an active
* local transaction is an error condition.
* <LI>Transaction is rolled back instead of getting committed during a
* <code>commit</code> method call on the <code>LocalTransaction</code>
* object.
* <LI>An attempt to start a local transaction from the same thread on a
* <code>ManagedConnection</code> that is already associated with
* an active local transaction.
* <LI>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.
* </UL>
*
* @version 1.0
* @author Rahul Sharma
* @author Ram Jeyaraman
*/
public class LocalTransactionException
extends javax.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 <code>Throwable</code>.
*/
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 <code>Throwable</code>.
*/
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);
}
}