Package org.eclipse.persistence.transaction

Class 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.

    See Also:
    JTASynchronizationListener, AbstractTransactionController

    • Field Detail

      • defaultTransactionManager

        protected static javax.transaction.TransactionManager defaultTransactionManager

      • transactionManager

        protected javax.transaction.TransactionManager transactionManager

    • 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_impl in class AbstractTransactionController
        Parameters:
        listener - The synchronization listener created for this transaction
        txn - The active transaction for which notification is being requested
        Throws:
        java.lang.Exception

      • getTransaction_impl

        protected java.lang.Object getTransaction_impl()
                                        throws java.lang.Exception
        INTERNAL: Return the active external transaction, or null if none is currently active for this thread.
        Specified by:
        getTransaction_impl in class AbstractTransactionController
        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.Exception
        INTERNAL: 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_impl in class AbstractTransactionController
        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.Exception
        INTERNAL: Return the transaction status as an object. We will pass around Integers that wrap the int JTA status values.
        Specified by:
        getTransactionStatus_impl in class AbstractTransactionController
        Returns:
        The current transaction status
        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_impl in class AbstractTransactionController
        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_impl in class AbstractTransactionController
        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_impl in class AbstractTransactionController
        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_impl in class AbstractTransactionController
        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_impl in class AbstractTransactionController
        Parameters:
        status - The current transaction status
        Returns:
        true if the current state dictates that the unit of work should be merged

      • acquireTransactionManager

        protected javax.transaction.TransactionManager acquireTransactionManager()
                                                                  throws java.lang.Exception
        INTERNAL: 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.

      • 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.