oracle.webcenter.portal.transaction

Class TransactionManager

java.lang.Object

oracle.webcenter.portal.transaction.TransactionManager

public abstract class TransactionManager
extends java.lang.Object

TransactionManager is an abstract class which supports executing a transactional method TransactionManager.TransactionalMethod, TransactionManager.NonVoidTransactionalMethod in the context of a transaction. The manager is responsible for interacting with the appropriate underlying transaction.

The manager may be asked to execute nested transactional methods. In this case only the outermost transactional method can cause a begin and commit on the underlying transaction.

Any transactional method which throws an exception will cause the underlying transaction to be immediately rolled-back. This will leave the TransactionManager in a rollback-only state. When in this state, the manager will not execute any new transactional method. The state is cleared once all of its existing transactional method have been rolled-back.

The TransactionManager is not-thread safe. The current TransactionManager can be retrieved using the #getCurrentTransactionManager() method, which returns a TransactionManager scoped to the current PortalRequestScope scope.

Since:

12.2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TransactionManager.NonVoidTransactionalMethod<R>
static interface	TransactionManager.TransactionalMethod
static interface	TransactionManager.TransactionToken

Constructor Summary

Constructors

Constructor and Description
TransactionManager()

Method Summary

Modifier and Type	Method and Description
abstract TransactionManager.TransactionToken	beginTransaction() Indicates to the TransactionManager that the caller is starting a new transaction.
abstract void	commitTransaction(TransactionManager.TransactionToken token) Requests that the TransactionManager commits the caller's transaction identified by the given token.
abstract <R> R	execute(TransactionManager.NonVoidTransactionalMethod<R> tm) Executes a non void transactional method, which is a method that returns a value.
abstract void	execute(TransactionManager.TransactionalMethod tm) Executes a void transactional method.
static TransactionManager	getCurrent() The current transaction manager.
abstract boolean	isActive() The TransactionManager is active if there is at least one transactional method that has started executing but not yet committed or rolled-back.
abstract void	rollbackAllTransactions() Reinitializes the TransactionManager, by rolling back the underlying transaction if it is active, and returning the manager toa state where it can begin or execute a new caller transaction.
abstract void	rollbackTransaction(TransactionManager.TransactionToken token) Requests that the TransactionManager rolls back the caller transaction identified by the given token.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransactionManager

public TransactionManager()

Method Detail

getCurrent

public static TransactionManager getCurrent()

The current transaction manager.

Returns:

the current transaction manager.

isActive

public abstract boolean isActive()
                          throws TransactionException

The TransactionManager is active if there is at least one transactional method that has started executing but not yet committed or rolled-back.

Returns:

true if the TransactionManager is active.

Throws:

TransactionException

execute

public abstract void execute(TransactionManager.TransactionalMethod tm)
                      throws oracle.webcenter.portal.BasePortalRuntimeException

Executes a void transactional method.

Portal runtime errors raised by the transactional method are directly propagated. Any other exception is wrapped in a TransactionException which is then thrown. The original exception is available as the cause of the TransactionException.

Parameters:

tm - a TransactionalMethod to execute.

Throws:

oracle.webcenter.portal.BasePortalRuntimeException - if any exception occurs.

execute

public abstract <R> R execute(TransactionManager.NonVoidTransactionalMethod<R> tm)
                       throws oracle.webcenter.portal.BasePortalRuntimeException

Executes a non void transactional method, which is a method that returns a value.

Portal runtime errors raised by the transactional method are directly propagated. Any other exception is wrapped in a TransactionException which is then thrown. The original exception is available as the cause of the TransactionException.

Parameters:

tm - a NonVoidTransactionalMethod to execute.

Returns:

the value returned by executing the non-void transactional method.

Throws:

TransactionException - if any exception occurs.

oracle.webcenter.portal.BasePortalRuntimeException

beginTransaction

public abstract TransactionManager.TransactionToken beginTransaction()
                                                              throws TransactionException

Indicates to the TransactionManager that the caller is starting a new transaction. This may or may not affect the underlying actual transaction.

Returns:

a transaction token, to be used in future commitTransaction or rollbackTransaction calls.

Throws:

TransactionException - if any exception occurs.

commitTransaction

public abstract void commitTransaction(TransactionManager.TransactionToken token)
                                throws TransactionException

Requests that the TransactionManager commits the caller's transaction identified by the given token. This will only result in a commit of the underlying transaction if the TransactionManager is not managing any other transactions.

Parameters:

token - a TransactionToken identifying which transaction to commit.

Throws:

TransactionException - if the token does not identify the most recently begun caller transaction, or if any other exception occurs.

rollbackTransaction

public abstract void rollbackTransaction(TransactionManager.TransactionToken token)
                                  throws TransactionException

Requests that the TransactionManager rolls back the caller transaction identified by the given token. This will immediately roll back the underlying transaction, after which any other caller transaction must also be rolled back.

Parameters:

token - a TransactionToken identifying which transaction to rollback.

Throws:

TransactionException - if teh token is not a valid TransactionToken or any other exception occurs.

rollbackAllTransactions

public abstract void rollbackAllTransactions()
                                      throws TransactionException

Reinitializes the TransactionManager, by rolling back the underlying transaction if it is active, and returning the manager toa state where it can begin or execute a new caller transaction. All outstanding transactionTokens become invalid after rollbackAllTransactions has been called.

Throws:

TransactionException - if any exception occurs rolling back and re-initializing the TransactionManager.