public interface

TransactionSynchronization

org.springframework.transaction.support.TransactionSynchronization
Known Indirect Subclasses

Class Overview

Interface for transaction synchronization callbacks. Supported by AbstractPlatformTransactionManager.

TransactionSynchronization implementations can implement the Ordered interface to influence their execution order. A synchronization that does not implement the Ordered interface is appended to the end of the synchronization chain.

System synchronizations performed by Spring itself use specific order values, allowing for fine-grained interaction with their execution order (if necessary).

Summary

Constants
int STATUS_COMMITTED Completion status in case of proper commit
int STATUS_ROLLED_BACK Completion status in case of proper rollback
int STATUS_UNKNOWN Completion status in case of heuristic mixed completion or system errors
Public Methods
abstract void afterCommit()
Invoked after transaction commit.
abstract void afterCompletion(int status)
Invoked after transaction commit/rollback.
abstract void beforeCommit(boolean readOnly)
Invoked before transaction commit (before "beforeCompletion").
abstract void beforeCompletion()
Invoked before transaction commit/rollback.
abstract void flush()
Flush the underlying session to the datastore, if applicable: for example, a Hibernate/JPA session.
abstract void resume()
Resume this synchronization.
abstract void suspend()
Suspend this synchronization.

Constants

public static final int STATUS_COMMITTED

Completion status in case of proper commit

Constant Value: 0 (0x00000000)

public static final int STATUS_ROLLED_BACK

Completion status in case of proper rollback

Constant Value: 1 (0x00000001)

public static final int STATUS_UNKNOWN

Completion status in case of heuristic mixed completion or system errors

Constant Value: 2 (0x00000002)

Public Methods

public abstract 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.

Throws
RuntimeException in case of errors; will be propagated to the caller (note: do not throw TransactionException subclasses here!)

public abstract 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
Throws
RuntimeException in case of errors; will be logged but not propagated (note: do not throw TransactionException subclasses here!)

public abstract 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
Throws
RuntimeException in case of errors; will be propagated to the caller (note: do not throw TransactionException subclasses here!)

public abstract 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.

Throws
RuntimeException in case of errors; will be logged but not propagated (note: do not throw TransactionException subclasses here!)

public abstract void flush ()

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

See Also

public abstract void resume ()

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

public abstract void suspend ()

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