Class JTATransactionController
- java.lang.Object
-
- org.eclipse.persistence.transaction.AbstractTransactionController
-
- org.eclipse.persistence.transaction.JTATransactionController
-
- All Implemented Interfaces:
ExternalTransactionController
- Direct Known Subclasses:
GlassfishTransactionController,JBossTransactionController,JotmTransactionController,Oc4jTransactionController,SAPNetWeaverTransactionController,WebLogicTransactionController,WebSphereTransactionController
public class JTATransactionController extends AbstractTransactionController
Purpose: TransactionController implementation for JTA 1.0
Description: Implements the required behavior for controlling JTA 1.0 transactions. Specific JTA implementations may need to extend this class when special controller behavior is necessary.
The JTA TransactionManager must be obtained and set on the instance in order for a Synchronization listener to be registered against the transaction. This can be done either by extending this class and defining acquireTransactionManager() to return the manager for the server, or by using this class and explicitly calling the setTransactionManager() method on it after the fact. e.g. TransactionManager mgr = controller.jndiLookup("java:comp/TransactionManager"); controller.setTransactionManager(mgr);
If a different listener needs to be used for synchronization, the SynchronizationListenerFactory should be set on the controller instance. The listener subclass should implement the factory interface, so that setting the factory is simply a matter of assigning an instance of the listener. e.g. controller.setSynchronizationListenerFactory( new DifferentServerSynchronizationListener()); The default listener factory creates instances of JTATransactionListener.
-
-
Field Summary
Fields Modifier and Type Field Description protected static javax.transaction.TransactionManagerdefaultTransactionManagerprotected javax.transaction.TransactionManagertransactionManager-
Fields inherited from class org.eclipse.persistence.transaction.AbstractTransactionController
activeUnitOfWorkThreadLocal, currentlyProcessedListeners, exceptionHandler, listenerFactory, numSessionsRequiringSequencingCallback, sequencingListeners, session, unitsOfWork
-
-
Constructor Summary
Constructors Constructor Description JTATransactionController()PUBLIC: Return a new controller for use with a JTA 1.0 compliant TransactionManager.JTATransactionController(javax.transaction.TransactionManager transactionManager)PUBLIC: Return a new controller for use with a JTA 1.0 compliant TransactionManager.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected javax.transaction.TransactionManageracquireTransactionManager()INTERNAL: Obtain and return the JTA TransactionManager on this platform.protected voidbeginTransaction_impl()INTERNAL: Begin an external transaction.protected booleancanBeginTransaction_impl(java.lang.Object status)INTERNAL: Return true if the status indicates that a transaction can be started.protected booleancanCommitTransaction_impl(java.lang.Object status)INTERNAL: Return true if the status indicates that a transaction can be committed.protected booleancanIssueSQLToDatabase_impl(java.lang.Object status)INTERNAL: Return true if the status indicates that the SQL should be issued to the db.protected booleancanMergeUnitOfWork_impl(java.lang.Object status)INTERNAL: Return true if the status indicates that the unit of work should be merged into the shared cache.protected booleancanRollbackTransaction_impl(java.lang.Object status)INTERNAL: Return true if the status indicates that a transaction can be rolled back.protected voidcommitTransaction_impl()INTERNAL: Commit the external transaction.static javax.transaction.TransactionManagergetDefaultTransactionManager()protected intgetIntStatus(java.lang.Object status)INTERNAL: Convenience method to return the int value of the transaction status.protected java.lang.ObjectgetTransaction_impl()INTERNAL: Return the active external transaction, or null if none is currently active for this thread.protected java.lang.ObjectgetTransactionKey_impl(java.lang.Object transaction)INTERNAL: Return a key for the specified external transaction object.javax.transaction.TransactionManagergetTransactionManager()PUBLIC: Return the transaction manager used to control the JTA transactions.protected java.lang.ObjectgetTransactionStatus_impl()INTERNAL: Return the transaction status as an object.booleanisRolledBack_impl(java.lang.Object status)INTERNAL: Return true if the transaction is rolled back.protected voidmarkTransactionForRollback_impl()INTERNAL: Mark the external transaction for rollback.protected voidregisterSynchronization_impl(AbstractSynchronizationListener listener, java.lang.Object txn)INTERNAL: Register the specified synchronization listener with the given active transaction.protected voidrollbackTransaction_impl()INTERNAL: Roll back the external transaction.static voidsetDefaultTransactionManager(javax.transaction.TransactionManager defaultTransactionManager)PUBLIC: Set the JTA transaction manager to be used.voidsetTransactionManager(javax.transaction.TransactionManager mgr)PUBLIC: Set the transaction manager used to control the JTA transactions.protected java.lang.StringstatusToString_impl(java.lang.Object status)INTERNAL: Convert the status to a string for tracing.-
Methods inherited from class org.eclipse.persistence.transaction.AbstractTransactionController
addUnitOfWork, beginTransaction, bindToCurrentTransaction, clearSequencingListeners, commitTransaction, getActiveSequencingCallback, getActiveUnitOfWork, getExceptionHandler, getListenerFactory, getSession, getTransaction, getTransactionKey, getTransactionStatus, getUnitsOfWork, hasActiveUnitOfWork, initializeSequencingListeners, isSequencingCallbackRequired, jndiLookup, logTxStateTrace, logTxTrace, lookupActiveUnitOfWork, lookupActiveUnitOfWork, markTransactionForRollback, noTransactionOrRolledBackOrCommited, numSessionsRequiringSequencingCallback, registerSynchronizationListener, removeSequencingListener, removeUnitOfWork, rollbackTransaction, setExceptionHandler, setListenerFactory, setSession, setUnitsOfWork
-
-
-
-
Constructor Detail
-
JTATransactionController
public JTATransactionController()
PUBLIC: Return a new controller for use with a JTA 1.0 compliant TransactionManager.
-
JTATransactionController
public JTATransactionController(javax.transaction.TransactionManager transactionManager)
PUBLIC: Return a new controller for use with a JTA 1.0 compliant TransactionManager.
-
-
Method Detail
-
registerSynchronization_impl
protected void registerSynchronization_impl(AbstractSynchronizationListener listener, java.lang.Object txn) throws java.lang.Exception
INTERNAL: Register the specified synchronization listener with the given active transaction.- Specified by:
registerSynchronization_implin classAbstractTransactionController- Parameters:
listener- The synchronization listener created for this transactiontxn- The active transaction for which notification is being requested- Throws:
java.lang.Exception
-
getTransaction_impl
protected java.lang.Object getTransaction_impl() throws java.lang.ExceptionINTERNAL: Return the active external transaction, or null if none is currently active for this thread.- Specified by:
getTransaction_implin classAbstractTransactionController- Returns:
- The active transaction object or id, or null if no transaction is active
- Throws:
java.lang.Exception
-
getTransactionKey_impl
protected java.lang.Object getTransactionKey_impl(java.lang.Object transaction) throws java.lang.ExceptionINTERNAL: Return a key for the specified external transaction object. The key is just something that can be inserted into a hashtable (must support hashCode() and equals() methods).- Specified by:
getTransactionKey_implin classAbstractTransactionController- Parameters:
transaction- The transaction to which the returned key applies (may be null)- Returns:
- A key for the passed in transaction, or null if no transaction specified
- Throws:
java.lang.Exception
-
getTransactionStatus_impl
protected java.lang.Object getTransactionStatus_impl() throws java.lang.ExceptionINTERNAL: Return the transaction status as an object. We will pass around Integers that wrap the int JTA status values.- Specified by:
getTransactionStatus_implin classAbstractTransactionController- Returns:
- The current transaction status
- Throws:
java.lang.Exception
-
beginTransaction_impl
protected void beginTransaction_impl() throws java.lang.ExceptionINTERNAL: Begin an external transaction.- Specified by:
beginTransaction_implin classAbstractTransactionController- Throws:
java.lang.Exception
-
commitTransaction_impl
protected void commitTransaction_impl() throws java.lang.ExceptionINTERNAL: Commit the external transaction.- Specified by:
commitTransaction_implin classAbstractTransactionController- Throws:
java.lang.Exception
-
rollbackTransaction_impl
protected void rollbackTransaction_impl() throws java.lang.ExceptionINTERNAL: Roll back the external transaction.- Specified by:
rollbackTransaction_implin classAbstractTransactionController- Throws:
java.lang.Exception
-
markTransactionForRollback_impl
protected void markTransactionForRollback_impl() throws java.lang.ExceptionINTERNAL: Mark the external transaction for rollback.- Specified by:
markTransactionForRollback_implin classAbstractTransactionController- Throws:
java.lang.Exception
-
canBeginTransaction_impl
protected boolean canBeginTransaction_impl(java.lang.Object status)
INTERNAL: Return true if the status indicates that a transaction can be started. This would normally mean that no transaction is currently active.- Specified by:
canBeginTransaction_implin classAbstractTransactionController- Parameters:
status- The current transaction status- Returns:
- true if the current state allows for a transaction to be started
-
canCommitTransaction_impl
protected boolean canCommitTransaction_impl(java.lang.Object status)
INTERNAL: Return true if the status indicates that a transaction can be committed. This would normally mean that a transaction is currently active.- Specified by:
canCommitTransaction_implin classAbstractTransactionController- Parameters:
status- The current transaction status- Returns:
- true if the current state allows for a transaction to be committed
-
canRollbackTransaction_impl
protected boolean canRollbackTransaction_impl(java.lang.Object status)
INTERNAL: Return true if the status indicates that a transaction can be rolled back. This would normally mean that a transaction is currently active.- Specified by:
canRollbackTransaction_implin classAbstractTransactionController- Parameters:
status- The current transaction status- Returns:
- true if the current state allows for a transaction to be rolled back
-
canIssueSQLToDatabase_impl
protected boolean canIssueSQLToDatabase_impl(java.lang.Object status)
INTERNAL: Return true if the status indicates that the SQL should be issued to the db. This would normally mean that a transaction was active.- Specified by:
canIssueSQLToDatabase_implin classAbstractTransactionController- Parameters:
status- The current transaction status- Returns:
- true if the current state allows for the SQL to be sent to the database
-
canMergeUnitOfWork_impl
protected boolean canMergeUnitOfWork_impl(java.lang.Object status)
INTERNAL: Return true if the status indicates that the unit of work should be merged into the shared cache. This would normally mean that the transaction was committed successfully.- Specified by:
canMergeUnitOfWork_implin classAbstractTransactionController- Parameters:
status- The current transaction status- Returns:
- true if the current state dictates that the unit of work should be merged
-
isRolledBack_impl
public boolean isRolledBack_impl(java.lang.Object status)
INTERNAL: Return true if the transaction is rolled back.- Specified by:
isRolledBack_implin classAbstractTransactionController
-
acquireTransactionManager
protected javax.transaction.TransactionManager acquireTransactionManager() throws java.lang.ExceptionINTERNAL: Obtain and return the JTA TransactionManager on this platform. By default try java:comp JNDI lookup. This method can be can be overridden by subclasses to obtain the transaction manager by whatever means is appropriate to the server. This method is invoked by the constructor to initialize the transaction manager at instance-creation time. Alternatively the transaction manager can be set directly on the controller instance using the setTransactionManager() method after the instance has been created.- Returns:
- The TransactionManager for the transaction system
- Throws:
java.lang.Exception
-
getIntStatus
protected int getIntStatus(java.lang.Object status)
INTERNAL: Convenience method to return the int value of the transaction status. Assumes that the status object is an Integer.
-
getTransactionManager
public javax.transaction.TransactionManager getTransactionManager()
PUBLIC: Return the transaction manager used to control the JTA transactions.- Returns:
- The JTA TransactionManager that is used to obtain transaction state information and control the active transaction.
-
setTransactionManager
public void setTransactionManager(javax.transaction.TransactionManager mgr)
PUBLIC: Set the transaction manager used to control the JTA transactions.- Parameters:
mgr- A valid JTA TransactionManager that can be accessed by this controller to obtain transaction state information and control the active transaction.
-
statusToString_impl
protected java.lang.String statusToString_impl(java.lang.Object status)
Description copied from class:AbstractTransactionControllerINTERNAL: Convert the status to a string for tracing.- Specified by:
statusToString_implin classAbstractTransactionController
-
getDefaultTransactionManager
public static javax.transaction.TransactionManager getDefaultTransactionManager()
-
setDefaultTransactionManager
public static void setDefaultTransactionManager(javax.transaction.TransactionManager defaultTransactionManager)
PUBLIC: Set the JTA transaction manager to be used. This can be called directly before login to configure JTA integration manually, or using Spring injection.
-
-