http://jta-spec.java.net: Project GlassFish Java Transaction API (GlassFish Community)
  • Stephen Felts (Oracle, Inc.) 
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2013 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.transaction;

import java.lang.IllegalArgumentException;
import java.lang.IllegalStateException;
import java.lang.SecurityException;


The UserTransaction interface defines the methods that allow an
application to explicitly manage transaction boundaries.

/**
 * The UserTransaction interface defines the methods that allow an
 * application to explicitly manage transaction boundaries.
 */
public interface UserTransaction {

    
Create a new transaction and associate it with the current thread.

Throws:
  • NotSupportedException – Thrown if the thread is already
   associated with a transaction and the Transaction Manager
   implementation does not support nested transactions.
  • SystemException – Thrown if the transaction manager
   encounters an unexpected error condition.
/**
     * Create a new transaction and associate it with the current thread.
     *
     * @exception NotSupportedException Thrown if the thread is already
     *    associated with a transaction and the Transaction Manager
     *    implementation does not support nested transactions.
     *
     * @exception SystemException Thrown if the transaction manager
     *    encounters an unexpected error condition.
     *
     */
    void begin() throws NotSupportedException, SystemException;

    
Complete the transaction associated with the current thread. When this
method completes, the thread is no longer associated with a transaction.

Throws:
  • RollbackException – Thrown to indicate that
   the transaction has been rolled back rather than committed.
  • HeuristicMixedException – Thrown to indicate that a heuristic
   decision was made and that some relevant updates have been committed
   while others have been rolled back.
  • HeuristicRollbackException – Thrown to indicate that a
   heuristic decision was made and that all relevant updates have been
   rolled back.
  • SecurityException – Thrown to indicate that the thread is
   not allowed to commit the transaction.
  • IllegalStateException – Thrown if the current thread is
   not associated with a transaction.
  • SystemException – Thrown if the transaction manager
   encounters an unexpected error condition.
/**
     * Complete the transaction associated with the current thread. When this
     * method completes, the thread is no longer associated with a transaction.
     *
     * @exception RollbackException Thrown to indicate that
     *    the transaction has been rolled back rather than committed.
     *
     * @exception HeuristicMixedException Thrown to indicate that a heuristic
     *    decision was made and that some relevant updates have been committed
     *    while others have been rolled back.
     *
     * @exception HeuristicRollbackException Thrown to indicate that a
     *    heuristic decision was made and that all relevant updates have been
     *    rolled back.
     *
     * @exception SecurityException Thrown to indicate that the thread is
     *    not allowed to commit the transaction.
     *
     * @exception IllegalStateException Thrown if the current thread is
     *    not associated with a transaction.
     *
     * @exception SystemException Thrown if the transaction manager
     *    encounters an unexpected error condition.
    */
    void commit() throws RollbackException,
	HeuristicMixedException, HeuristicRollbackException, SecurityException,
	IllegalStateException, SystemException;

    
Roll back the transaction associated with the current thread. When this
method completes, the thread is no longer associated with a transaction.

Throws:
  • SecurityException – Thrown to indicate that the thread is
   not allowed to roll back the transaction.
  • IllegalStateException – Thrown if the current thread is
   not associated with a transaction.
  • SystemException – Thrown if the transaction manager
   encounters an unexpected error condition.
/**
     * Roll back the transaction associated with the current thread. When this
     * method completes, the thread is no longer associated with a transaction.
     *
     * @exception SecurityException Thrown to indicate that the thread is
     *    not allowed to roll back the transaction.
     *
     * @exception IllegalStateException Thrown if the current thread is
     *    not associated with a transaction.
     *
     * @exception SystemException Thrown if the transaction manager
     *    encounters an unexpected error condition.
     *
     */
    void rollback() throws IllegalStateException, SecurityException,
        SystemException;

    
Modify the transaction associated with the current thread such that
the only possible outcome of the transaction is to roll back the
transaction.

Throws:
  • IllegalStateException – Thrown if the current thread is
   not associated with a transaction.
  • SystemException – Thrown if the transaction manager
   encounters an unexpected error condition.
/**
     * Modify the transaction associated with the current thread such that
     * the only possible outcome of the transaction is to roll back the
     * transaction.
     *
     * @exception IllegalStateException Thrown if the current thread is
     *    not associated with a transaction.
     *
     * @exception SystemException Thrown if the transaction manager
     *    encounters an unexpected error condition.
     *
     */
    void setRollbackOnly() throws IllegalStateException, SystemException;

    
Obtain the status of the transaction associated with the current thread.

Throws:
  • SystemException – Thrown if the transaction manager
   encounters an unexpected error condition.
Returns:The transaction status. If no transaction is associated with
   the current thread, this method returns the Status.NoTransaction
   value.
/**
     * Obtain the status of the transaction associated with the current thread.
     *
     * @return The transaction status. If no transaction is associated with
     *    the current thread, this method returns the Status.NoTransaction
     *    value.
     *
     * @exception SystemException Thrown if the transaction manager
     *    encounters an unexpected error condition.
     *
     */
    int getStatus() throws SystemException;

    
Modify the timeout value that is associated with transactions started
by the current thread with the begin method.

 If an application has not called this method, the transaction
service uses some default value for the transaction timeout.

Params:
  • seconds – The value of the timeout in seconds. If the value is zero,
       the transaction service restores the default value. If the value
       is negative a SystemException is thrown.
Throws:
  • SystemException – Thrown if the transaction manager
   encounters an unexpected error condition.
/**
     * Modify the timeout value that is associated with transactions started
     * by the current thread with the begin method.
     *
     * <p> If an application has not called this method, the transaction
     * service uses some default value for the transaction timeout.
     *
     * @param seconds The value of the timeout in seconds. If the value is zero,
     *        the transaction service restores the default value. If the value
     *        is negative a SystemException is thrown.
     *
     * @exception SystemException Thrown if the transaction manager
     *    encounters an unexpected error condition.
     *
     */
    void setTransactionTimeout(int seconds) throws SystemException;
}