001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package javax.transaction;
038:
039: import java.lang.IllegalArgumentException;
040: import java.lang.IllegalStateException;
041: import java.lang.SecurityException;
042:
043: /**
044: * The UserTransaction interface defines the methods that allow an
045: * application to explicitly manage transaction boundaries.
046: */
047: public interface UserTransaction {
048:
049: /**
050: * Create a new transaction and associate it with the current thread.
051: *
052: * @exception NotSupportedException Thrown if the thread is already
053: * associated with a transaction and the Transaction Manager
054: * implementation does not support nested transactions.
055: *
056: * @exception SystemException Thrown if the transaction manager
057: * encounters an unexpected error condition.
058: *
059: */
060: void begin() throws NotSupportedException, SystemException;
061:
062: /**
063: * Complete the transaction associated with the current thread. When this
064: * method completes, the thread is no longer associated with a transaction.
065: *
066: * @exception RollbackException Thrown to indicate that
067: * the transaction has been rolled back rather than committed.
068: *
069: * @exception HeuristicMixedException Thrown to indicate that a heuristic
070: * decision was made and that some relevant updates have been committed
071: * while others have been rolled back.
072: *
073: * @exception HeuristicRollbackException Thrown to indicate that a
074: * heuristic decision was made and that all relevant updates have been
075: * rolled back.
076: *
077: * @exception SecurityException Thrown to indicate that the thread is
078: * not allowed to commit the transaction.
079: *
080: * @exception IllegalStateException Thrown if the current thread is
081: * not associated with a transaction.
082: *
083: * @exception SystemException Thrown if the transaction manager
084: * encounters an unexpected error condition.
085: */
086: void commit() throws RollbackException, HeuristicMixedException,
087: HeuristicRollbackException, SecurityException,
088: IllegalStateException, SystemException;
089:
090: /**
091: * Roll back the transaction associated with the current thread. When this
092: * method completes, the thread is no longer associated with a transaction.
093: *
094: * @exception SecurityException Thrown to indicate that the thread is
095: * not allowed to roll back the transaction.
096: *
097: * @exception IllegalStateException Thrown if the current thread is
098: * not associated with a transaction.
099: *
100: * @exception SystemException Thrown if the transaction manager
101: * encounters an unexpected error condition.
102: *
103: */
104: void rollback() throws IllegalStateException, SecurityException,
105: SystemException;
106:
107: /**
108: * Modify the transaction associated with the current thread such that
109: * the only possible outcome of the transaction is to roll back the
110: * transaction.
111: *
112: * @exception IllegalStateException Thrown if the current thread is
113: * not associated with a transaction.
114: *
115: * @exception SystemException Thrown if the transaction manager
116: * encounters an unexpected error condition.
117: *
118: */
119: void setRollbackOnly() throws IllegalStateException,
120: SystemException;
121:
122: /**
123: * Obtain the status of the transaction associated with the current thread.
124: *
125: * @return The transaction status. If no transaction is associated with
126: * the current thread, this method returns the Status.NoTransaction
127: * value.
128: *
129: * @exception SystemException Thrown if the transaction manager
130: * encounters an unexpected error condition.
131: *
132: */
133: int getStatus() throws SystemException;
134:
135: /**
136: * Modify the timeout value that is associated with transactions started
137: * by the current thread with the begin method.
138: *
139: * <p> If an application has not called this method, the transaction
140: * service uses some default value for the transaction timeout.
141: *
142: * @param seconds The value of the timeout in seconds. If the value is zero,
143: * the transaction service restores the default value. If the value
144: * is negative a SystemException is thrown.
145: *
146: * @exception SystemException Thrown if the transaction manager
147: * encounters an unexpected error condition.
148: *
149: */
150: void setTransactionTimeout(int seconds) throws SystemException;
151: }
|