javax.transaction
Interface TransactionManager
- public interface TransactionManager
The TransactionManager interface defines the methods that allow an
application server to manage transaction boundaries.
Method Summary |
void |
begin()
Create a new transaction and associate it with the current thread. |
void |
commit()
Complete the transaction associated with the current thread. |
int |
getStatus()
Obtain the status of the transaction associated with the current thread. |
Transaction |
getTransaction()
Get the transaction object that represents the transaction
context of the calling thread |
void |
resume(Transaction tobj)
Resume the transaction context association of the calling thread
with the transaction represented by the supplied Transaction object. |
void |
rollback()
Roll back the transaction associated with the current thread. |
void |
setRollbackOnly()
Modify the transaction associated with the current thread such that
the only possible outcome of the transaction is to roll back the
transaction. |
void |
setTransactionTimeout(int seconds)
Modify the value of the timeout value that is associated with the
transactions started by the current thread with the begin method. |
Transaction |
suspend()
Suspend the transaction currently associated with the calling
thread and return a Transaction object that represents the
transaction context being suspended. |
begin
public void begin()
throws NotSupportedException,
SystemException
- 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
commit
public void commit()
throws RollbackException,
HeuristicMixedException,
HeuristicRollbackException,
java.lang.SecurityException,
java.lang.IllegalStateException,
SystemException
- Complete the transaction associated with the current thread. When this
method completes, the thread becomes associated with no 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 some relevant updates have been
rolled back.
- java.lang.SecurityException - Thrown to indicate that the thread is
not allowed to commit the transaction.
- java.lang.IllegalStateException - Thrown if the current thread is
not associated with a transaction.
- SystemException - Thrown if the transaction manager
encounters an unexpected error condition
getStatus
public int getStatus()
throws SystemException
- Obtain the status of the transaction associated with the current thread.
- Returns:
- The transaction status. If no transaction is associated with
the current thread, this method returns the Status.NoTransaction
value.
- Throws:
- SystemException - Thrown if the transaction manager
encounters an unexpected error condition
getTransaction
public Transaction getTransaction()
throws SystemException
- Get the transaction object that represents the transaction
context of the calling thread
- Returns:
- the Transaction object representing the transaction
associated with the calling thread.
- Throws:
- SystemException - Thrown if the transaction manager
encounters an unexpected error condition
resume
public void resume(Transaction tobj)
throws InvalidTransactionException,
java.lang.IllegalStateException,
SystemException
- Resume the transaction context association of the calling thread
with the transaction represented by the supplied Transaction object.
When this method returns, the calling thread is associated with the
transaction context specified.
- Parameters:
tobj
- The Transaction
object that represents the
transaction to be resumed.- Throws:
- InvalidTransactionException - Thrown if the parameter
transaction object contains an invalid transaction
- java.lang.IllegalStateException - Thrown if the thread is already
associated with another transaction.
- SystemException - Thrown if the transaction manager
encounters an unexpected error condition
rollback
public void rollback()
throws java.lang.IllegalStateException,
java.lang.SecurityException,
SystemException
- Roll back the transaction associated with the current thread. When this
method completes, the thread becomes associated with no transaction.
- Throws:
- java.lang.SecurityException - Thrown to indicate that the thread is
not allowed to roll back the transaction.
- java.lang.IllegalStateException - Thrown if the current thread is
not associated with a transaction.
- SystemException - Thrown if the transaction manager
encounters an unexpected error condition
setRollbackOnly
public void setRollbackOnly()
throws java.lang.IllegalStateException,
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:
- java.lang.IllegalStateException - Thrown if the current thread is
not associated with a transaction.
- SystemException - Thrown if the transaction manager
encounters an unexpected error condition
setTransactionTimeout
public void setTransactionTimeout(int seconds)
throws SystemException
- Modify the value of the timeout value that is associated with the
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.
- Parameters:
seconds
- The value of the timeout in seconds. If the value
is zero, the transaction service restores the default value.- Throws:
- SystemException - Thrown if the transaction manager
encounters an unexpected error condition
suspend
public Transaction suspend()
throws SystemException
- Suspend the transaction currently associated with the calling
thread and return a Transaction object that represents the
transaction context being suspended. If the calling thread is
not associated with a transaction, the method returns a null
object reference. When this method returns, the calling thread
is associated with no transaction.
- Returns:
- Transaction object representing the suspended transaction.
- Throws:
- SystemException - Thrown if the transaction manager
encounters an unexpected error condition
- SystemException - Thrown if the transaction manager
encounters an unexpected error condition