JavaEE Web API 8.0.1 · javax.transaction.TransactionManager

Method Summary

Modifier and Type	Method and Description
public void	begin() Create a new transaction and associate it with the current thread.
public void	commit() Complete the transaction associated with the current thread.
public int	Returns: The transaction status. If no transaction is associated with the current thread, this method returns the Status.NoTransaction value. getStatus() Obtain the status of the transaction associated with the current thread.
public Transaction	Returns: the `Transaction` object representing the transaction associated with the calling thread. getTransaction() Get the transaction object that represents the transaction context of the calling thread.
public void	resume(Transaction The `Transaction` object that represents the transaction to be resumed. tobj) Resume the transaction context association of the calling thread with the transaction represented by the supplied Transaction object.
public void	rollback() Roll back the transaction associated with the current thread.
public 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.
public void	setTransactionTimeout(int 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. seconds) Modify the timeout value that is associated with transactions started by the current thread with the begin method.
public Transaction	Returns: Transaction object representing the suspended transaction. suspend() Suspend the transaction currently associated with the calling thread and return a Transaction object that represents the transaction context being suspended.

Method Detail

begin	back to summary
public void begin() throws NotSupportedException, SystemException Create a new transaction and associate it with the current thread. Exceptions 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.

begin

back to summary

public void begin() throws NotSupportedException, SystemException

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

Exceptions

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	back to summary
public void commit() throws RollbackException, HeuristicMixedException, HeuristicRollbackException, SecurityException, IllegalStateException, SystemException Complete the transaction associated with the current thread. When this method completes, the thread is no longer associated with a transaction. Exceptions 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.

commit

back to summary

public void commit() throws RollbackException, HeuristicMixedException, HeuristicRollbackException, SecurityException, IllegalStateException, SystemException

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

Exceptions

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.

getStatus	back to summary
public int getStatus() throws SystemException Obtain the status of the transaction associated with the current thread. Returns:int The transaction status. If no transaction is associated with the current thread, this method returns the Status.NoTransaction value. Exceptions SystemException: Thrown if the transaction manager encounters an unexpected error condition.

getStatus

back to summary

public int getStatus() throws SystemException

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

Returns:int

The transaction status. If no transaction is associated with the current thread, this method returns the Status.NoTransaction value.

Exceptions

SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

getTransaction back to summary

getTransaction	back to summary
public Transaction getTransaction() throws SystemException Get the transaction object that represents the transaction context of the calling thread. Returns:Transaction the `Transaction` object representing the transaction associated with the calling thread. Exceptions SystemException: Thrown if the transaction manager encounters an unexpected error condition.

public Transaction getTransaction() throws SystemException

Get the transaction object that represents the transaction context of the calling thread.

Returns:Transaction

the Transaction object representing the transaction associated with the calling thread.

Exceptions

SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

resume back to summary

resume	back to summary
public void resume(Transaction tobj) throws InvalidTransactionException, 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:Transaction The `Transaction` object that represents the transaction to be resumed. Exceptions InvalidTransactionException: Thrown if the parameter transaction object contains an invalid transaction. IllegalStateException: Thrown if the thread is already associated with another transaction. SystemException: Thrown if the transaction manager encounters an unexpected error condition.

public void resume(Transaction tobj) throws InvalidTransactionException, 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:Transaction: The Transaction object that represents the transaction to be resumed.

Exceptions

InvalidTransactionException:: Thrown if the parameter transaction object contains an invalid transaction.
IllegalStateException:: Thrown if the thread is already associated with another transaction.
SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

rollback	back to summary
public void rollback() throws IllegalStateException, SecurityException, SystemException Roll back the transaction associated with the current thread. When this method completes, the thread is no longer associated with a transaction. Exceptions IllegalStateException: Thrown if the current thread is not associated with a transaction. SecurityException: Thrown to indicate that the thread is not allowed to roll back the transaction. SystemException: Thrown if the transaction manager encounters an unexpected error condition.

rollback

back to summary

public void rollback() throws IllegalStateException, SecurityException, SystemException

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

Exceptions

IllegalStateException:: Thrown if the current thread is not associated with a transaction.
SecurityException:: Thrown to indicate that the thread is not allowed to roll back the transaction.
SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

setRollbackOnly	back to summary
public void setRollbackOnly() throws 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. Exceptions IllegalStateException: Thrown if the current thread is not associated with a transaction. SystemException: Thrown if the transaction manager encounters an unexpected error condition.

setRollbackOnly

back to summary

public void setRollbackOnly() throws 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.

Exceptions

IllegalStateException:: Thrown if the current thread is not associated with a transaction.
SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

setTransactionTimeout	back to summary
public void setTransactionTimeout(int seconds) 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. Parameters seconds:int 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. Exceptions SystemException: Thrown if the transaction manager encounters an unexpected error condition.

setTransactionTimeout

back to summary

public void setTransactionTimeout(int seconds) 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.

Parameters

seconds:int: 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.

Exceptions

SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

suspend	back to summary
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 not associated with a transaction. Returns:Transaction Transaction object representing the suspended transaction. Exceptions SystemException: Thrown if the transaction manager encounters an unexpected error condition.

suspend

back to summary

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 not associated with a transaction.

Returns:Transaction

Transaction object representing the suspended transaction.

Exceptions

SystemException:: Thrown if the transaction manager encounters an unexpected error condition.

public Interface TransactionManager

Method Summary

Method Detail