public abstract class

TransactionSynchronizationAdapter

extends Object
implements Ordered TransactionSynchronization
java.lang.Object
   ↳ org.springframework.transaction.support.TransactionSynchronizationAdapter
Known Direct Subclasses

Class Overview

Simple TransactionSynchronization adapter containing empty method implementations, for easier overriding of single methods.

Also implements the Ordered interface to enable the execution order of synchronizations to be controlled declaratively. The default order is LOWEST_PRECEDENCE, indicating late execution; return a lower value for earlier execution.

Summary

[Expand]
Inherited Constants
From interface org.springframework.core.Ordered
From interface org.springframework.transaction.support.TransactionSynchronization
Public Constructors
TransactionSynchronizationAdapter()
Public Methods
void afterCommit()
Invoked after transaction commit.
void afterCompletion(int status)
Invoked after transaction commit/rollback.
void beforeCommit(boolean readOnly)
Invoked before transaction commit (before "beforeCompletion").
void beforeCompletion()
Invoked before transaction commit/rollback.
void flush()
Flush the underlying session to the datastore, if applicable: for example, a Hibernate/JPA session.
int getOrder()
Return the order value of this object, with a higher value meaning greater in terms of sorting.
void resume()
Resume this synchronization.
void suspend()
Suspend this synchronization.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.core.Ordered
From interface org.springframework.transaction.support.TransactionSynchronization

Public Constructors

public TransactionSynchronizationAdapter ()

Public Methods

public void afterCommit ()

Invoked after transaction commit. Can perform further operations right after the main transaction has successfully committed.

Can e.g. commit further operations that are supposed to follow on a successful commit of the main transaction, like confirmation messages or emails.

NOTE: The transaction will have been committed already, but the transactional resources might still be active and accessible. As a consequence, any data access code triggered at this point will still "participate" in the original transaction, allowing to perform some cleanup (with no commit following anymore!), unless it explicitly declares that it needs to run in a separate transaction. Hence: Use PROPAGATION_REQUIRES_NEW for any transactional operation that is called from here.

public void afterCompletion (int status)

Invoked after transaction commit/rollback. Can perform resource cleanup after transaction completion.

NOTE: The transaction will have been committed or rolled back already, but the transactional resources might still be active and accessible. As a consequence, any data access code triggered at this point will still "participate" in the original transaction, allowing to perform some cleanup (with no commit following anymore!), unless it explicitly declares that it needs to run in a separate transaction. Hence: Use PROPAGATION_REQUIRES_NEW for any transactional operation that is called from here.

Parameters
status completion status according to the STATUS_* constants

public void beforeCommit (boolean readOnly)

Invoked before transaction commit (before "beforeCompletion"). Can e.g. flush transactional O/R Mapping sessions to the database.

This callback does not mean that the transaction will actually be committed. A rollback decision can still occur after this method has been called. This callback is rather meant to perform work that's only relevant if a commit still has a chance to happen, such as flushing SQL statements to the database.

Note that exceptions will get propagated to the commit caller and cause a rollback of the transaction.

Parameters
readOnly whether the transaction is defined as read-only transaction

public void beforeCompletion ()

Invoked before transaction commit/rollback. Can perform resource cleanup before transaction completion.

This method will be invoked after beforeCommit, even when beforeCommit threw an exception. This callback allows for closing resources before transaction completion, for any outcome.

public void flush ()

Flush the underlying session to the datastore, if applicable: for example, a Hibernate/JPA session.

public int getOrder ()

Return the order value of this object, with a higher value meaning greater in terms of sorting.

Normally starting with 0, with Integer.MAX_VALUE indicating the greatest value. Same order values will result in arbitrary positions for the affected objects.

Higher values can be interpreted as lower priority. As a consequence, the object with the lowest value has highest priority (somewhat analogous to Servlet "load-on-startup" values).

Returns
  • the order value

public void resume ()

Resume this synchronization. Supposed to rebind resources to TransactionSynchronizationManager if managing any.

public void suspend ()

Suspend this synchronization. Supposed to unbind resources from TransactionSynchronizationManager if managing any.