Module org.eclipse.persistence.core
Class AbstractSynchronizationListener
java.lang.Object
org.eclipse.persistence.transaction.AbstractSynchronizationListener
- All Implemented Interfaces:
Synchronization
- Direct Known Subclasses:
JTASynchronizationListener
Purpose: Abstract Synchronization Listener class Description: This abstract class is paired with the AbstractTransactionController class. It contains most of the implementation logic to handle callback notifications from an external transaction manager to ensure consistency between the global transaction and the EclipseLink unit of work. It does not assume any particular specification or interface, but can be called by any implementation subclass.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected AbstractTransactionController
The external txn controller that is intimate with the transaction manager and knows how to do things like rolling back transactions, etc.protected SequencingCallback
sequencingCallback used in case listener has a single callback.protected Map
<DatabaseSession, SequencingCallback> sequencingCallbackMap used in case listener has more than one callback: SessionBroker with at least two members requiring callbacks.protected AbstractSession
The parent of the uow.protected Object
The global transaction object.protected Object
The global transaction key.protected UnitOfWorkImpl
The unit of work associated with the global txn that this listener is bound to. -
Constructor Summary
ModifierConstructorDescriptionprotected
INTERNAL:protected
AbstractSynchronizationListener
(UnitOfWorkImpl unitOfWork, AbstractSession session, Object transaction, AbstractTransactionController controller) INTERNAL: -
Method Summary
Modifier and TypeMethodDescriptionvoid
afterCompletion
(Object status) INTERNAL: The method performs the logic that should be executed after the transaction has been completed.void
INTERNAL: This method performs the logic that occurs at transaction completion time.protected void
getSequencingCallback
(DatabaseSession dbSession, SequencingCallbackFactory sequencingCallbackFactory) Return sequencingCallback corresponding to the passed session.protected AbstractSession
protected Object
protected AbstractTransactionController
protected Object
protected UnitOfWorkImpl
void
handleException
(RuntimeException exception) INTERNAL: Do the appropriate thing for when an exception occurs during SQL issuance.protected void
setSession
(AbstractSession session) protected void
setTransaction
(Object transaction) protected void
setTransactionController
(AbstractTransactionController newController) protected void
setTransactionKey
(Object transactionKey) protected void
setUnitOfWork
(UnitOfWorkImpl unitOfWork) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jakarta.transaction.Synchronization
afterCompletion
-
Field Details
-
controller
The external txn controller that is intimate with the transaction manager and knows how to do things like rolling back transactions, etc. -
session
The parent of the uow. -
unitOfWork
The unit of work associated with the global txn that this listener is bound to. Note that unitOfWork is null in case it's a purely sequencing listener. -
transaction
The global transaction object. -
transactionKey
The global transaction key. -
sequencingCallback
sequencingCallback used in case listener has a single callback. -
sequencingCallbackMap
sequencingCallbackMap used in case listener has more than one callback: SessionBroker with at least two members requiring callbacks.
-
-
Constructor Details
-
AbstractSynchronizationListener
protected AbstractSynchronizationListener()INTERNAL: -
AbstractSynchronizationListener
protected AbstractSynchronizationListener(UnitOfWorkImpl unitOfWork, AbstractSession session, Object transaction, AbstractTransactionController controller) INTERNAL:
-
-
Method Details
-
beforeCompletion
public void beforeCompletion()INTERNAL: This method performs the logic that occurs at transaction completion time. This includes issuing the SQL, etc. This method executes within the transaction context of the caller of transaction.commit(), or in the case of container-managed transactions, in the context of the method for which the Container started the transaction.- Specified by:
beforeCompletion
in interfaceSynchronization
-
afterCompletion
INTERNAL: The method performs the logic that should be executed after the transaction has been completed. The status passed in indicates whether the transaction was committed or rolled back. This status flag may be different for different implementations. This method executes without a transaction context.- Parameters:
status
- The status code of the transaction completion.
-
handleException
INTERNAL: Do the appropriate thing for when an exception occurs during SQL issuance. The default thing to do is to simply mark the transaction to be rolled back, for those transaction managers that support this, and rethrow the exception. We hope that the exception will do the trick for those that do not allow marking rollback. This method may optionally be overridden by concrete subclass implementations. Different transaction manager vendors may have different reactions to exceptions that get signalled during the commit phase of synchronization. -
getTransactionController
-
setTransactionController
-
getTransaction
-
setTransaction
-
getTransactionKey
-
setTransactionKey
-
getSession
-
setSession
-
getUnitOfWork
-
setUnitOfWork
-
callSequencingCallback
protected void callSequencingCallback() -
getSequencingCallback
public SequencingCallback getSequencingCallback(DatabaseSession dbSession, SequencingCallbackFactory sequencingCallbackFactory) Return sequencingCallback corresponding to the passed session.
-