/* * 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.transaction; import javax.transaction.xa.XAResource; import java.lang.IllegalStateException; import java.lang.SecurityException; /** * The Transaction interface allows operations to be performed against * the transaction in the target Transaction object. A Transaction * object is created corresponding to each global transaction creation. * The Transaction object can be used for resource enlistment, * synchronization registration, transaction completion, and status * query operations. */ public interface Transaction { /** * Complete the transaction represented by this Transaction object. * * @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 transaction in the * target object is inactive. * * @exception SystemException Thrown if the transaction manager * encounters an unexpected error condition. */ public void commit() throws RollbackException, HeuristicMixedException, HeuristicRollbackException, SecurityException, IllegalStateException, SystemException; /** * Disassociate the resource specified from the transaction associated * with the target Transaction object. * * @param xaRes The XAResource object associated with the resource * (connection). * * @param flag One of the values of TMSUCCESS, TMSUSPEND, or TMFAIL. * * @exception IllegalStateException Thrown if the transaction in the * target object is inactive. * * @exception SystemException Thrown if the transaction manager * encounters an unexpected error condition. * * @return <i>true</i> if the resource was delisted successfully; otherwise * <i>false</i>. * */ public boolean delistResource(XAResource xaRes, int flag) throws IllegalStateException, SystemException; /** * Enlist the resource specified with the transaction associated with the * target Transaction object. * * @param xaRes The XAResource object associated with the resource * (connection). * * @return <i>true</i> if the resource was enlisted successfully; otherwise * <i>false</i>. * * @exception RollbackException Thrown to indicate that * the transaction has been marked for rollback only. * * @exception IllegalStateException Thrown if the transaction in the * target object is in the prepared state or the transaction is * inactive. * * @exception SystemException Thrown if the transaction manager * encounters an unexpected error condition. * */ public boolean enlistResource(XAResource xaRes) throws RollbackException, IllegalStateException, SystemException; /** * Obtain the status of the transaction associated with the target * Transaction object. * * @return The transaction status. If no transaction is associated with * the target object, this method returns the * Status.NoTransaction value. * * @exception SystemException Thrown if the transaction manager * encounters an unexpected error condition. * */ public int getStatus() throws SystemException; /** * Register a synchronization object for the transaction currently * associated with the target object. The transction manager invokes * the beforeCompletion method prior to starting the two-phase transaction * commit process. After the transaction is completed, the transaction * manager invokes the afterCompletion method. * * @param sync The Synchronization object for the transaction associated * with the target object. * * @exception RollbackException Thrown to indicate that * the transaction has been marked for rollback only. * * @exception IllegalStateException Thrown if the transaction in the * target object is in the prepared state or the transaction is * inactive. * * @exception SystemException Thrown if the transaction manager * encounters an unexpected error condition. * */ public void registerSynchronization(Synchronization sync) throws RollbackException, IllegalStateException, SystemException; /** * Rollback the transaction represented by this Transaction object. * * @exception IllegalStateException Thrown if the transaction in the * target object is in the prepared state or the transaction is * inactive. * * @exception SystemException Thrown if the transaction manager * encounters an unexpected error condition. * */ public void rollback() throws IllegalStateException, SystemException; /** * Modify the transaction associated with the target object such that * the only possible outcome of the transaction is to roll back the * transaction. * * @exception IllegalStateException Thrown if the target object is * not associated with any transaction. * * @exception SystemException Thrown if the transaction manager * encounters an unexpected error condition. * */ public void setRollbackOnly() throws IllegalStateException, SystemException; }