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 TransactionManager interface defines the methods that allow an
045: * application server to manage transaction boundaries.
046: */
047: public interface TransactionManager {
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: public 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: */
087: public void commit() throws RollbackException,
088: HeuristicMixedException, HeuristicRollbackException,
089: SecurityException, IllegalStateException, SystemException;
090:
091: /**
092: * Obtain the status of the transaction associated with the current thread.
093: *
094: * @return The transaction status. If no transaction is associated with
095: * the current thread, this method returns the Status.NoTransaction
096: * value.
097: *
098: * @exception SystemException Thrown if the transaction manager
099: * encounters an unexpected error condition.
100: *
101: */
102: public int getStatus() throws SystemException;
103:
104: /**
105: * Get the transaction object that represents the transaction
106: * context of the calling thread.
107: *
108: * @return the <code>Transaction</code> object representing the
109: * transaction associated with the calling thread.
110: *
111: * @exception SystemException Thrown if the transaction manager
112: * encounters an unexpected error condition.
113: *
114: */
115: public Transaction getTransaction() throws SystemException;
116:
117: /**
118: * Resume the transaction context association of the calling thread
119: * with the transaction represented by the supplied Transaction object.
120: * When this method returns, the calling thread is associated with the
121: * transaction context specified.
122: *
123: * @param tobj The <code>Transaction</code> object that represents the
124: * transaction to be resumed.
125: *
126: * @exception InvalidTransactionException Thrown if the parameter
127: * transaction object contains an invalid transaction.
128: *
129: * @exception IllegalStateException Thrown if the thread is already
130: * associated with another transaction.
131: *
132: * @exception SystemException Thrown if the transaction manager
133: * encounters an unexpected error condition.
134: */
135: public void resume(Transaction tobj)
136: throws InvalidTransactionException, IllegalStateException,
137: SystemException;
138:
139: /**
140: * Roll back the transaction associated with the current thread. When this
141: * method completes, the thread is no longer associated with a
142: * transaction.
143: *
144: * @exception SecurityException Thrown to indicate that the thread is
145: * not allowed to roll back the transaction.
146: *
147: * @exception IllegalStateException Thrown if the current thread is
148: * not associated with a transaction.
149: *
150: * @exception SystemException Thrown if the transaction manager
151: * encounters an unexpected error condition.
152: *
153: */
154: public void rollback() throws IllegalStateException,
155: SecurityException, SystemException;
156:
157: /**
158: * Modify the transaction associated with the current thread such that
159: * the only possible outcome of the transaction is to roll back the
160: * transaction.
161: *
162: * @exception IllegalStateException Thrown if the current thread is
163: * not associated with a transaction.
164: *
165: * @exception SystemException Thrown if the transaction manager
166: * encounters an unexpected error condition.
167: *
168: */
169: public void setRollbackOnly() throws IllegalStateException,
170: SystemException;
171:
172: /**
173: * Modify the timeout value that is associated with transactions started
174: * by the current thread with the begin method.
175: *
176: * <p> If an application has not called this method, the transaction
177: * service uses some default value for the transaction timeout.
178: *
179: * @param seconds The value of the timeout in seconds. If the value is zero,
180: * the transaction service restores the default value. If the value
181: * is negative a SystemException is thrown.
182: *
183: * @exception SystemException Thrown if the transaction manager
184: * encounters an unexpected error condition.
185: *
186: */
187: public void setTransactionTimeout(int seconds)
188: throws SystemException;
189:
190: /**
191: * Suspend the transaction currently associated with the calling
192: * thread and return a Transaction object that represents the
193: * transaction context being suspended. If the calling thread is
194: * not associated with a transaction, the method returns a null
195: * object reference. When this method returns, the calling thread
196: * is not associated with a transaction.
197: *
198: * @return Transaction object representing the suspended transaction.
199: *
200: * @exception SystemException Thrown if the transaction manager
201: * encounters an unexpected error condition.
202: *
203: */
204: public Transaction suspend() throws SystemException;
205: }
|