Top Description Fields Methods
org.springframework.transaction.support

public Interface TransactionSynchronization

extends Ordered, Flushable
Known Direct Implementers
org.springframework.transaction.support.TransactionSynchronizationAdapter, org.springframework.transaction.event.TransactionalApplicationListenerSynchronization.PlatformSynchronization, org.springframework.transaction.support.ResourceHolderSynchronization, org.springframework.transaction.support.SimpleTransactionScope.CleanupSynchronization
Imports
java.io.Flushable, org.springframework.core.Ordered
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).

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

Author
Juergen Hoeller
Since
02.06.2003
See Also
TransactionSynchronizationManager, AbstractPlatformTransactionManager, org.springframework.jdbc.datasource.DataSourceUtils#CONNECTION_SYNCHRONIZATION_ORDER

Field Summary

Modifier and TypeField and Description
public static final int
STATUS_COMMITTED

Completion status in case of proper commit.

public static final int
STATUS_ROLLED_BACK

Completion status in case of proper rollback.

public static final int
STATUS_UNKNOWN

Completion status in case of heuristic mixed completion or system errors.

Inherited from org.springframework.core.Ordered:
HIGHEST_PRECEDENCELOWEST_PRECEDENCE

Method Summary

Modifier and TypeMethod and Description
public default void
afterCommit()

Invoked after transaction commit.

public default void
afterCompletion(int
completion status according to the STATUS_* constants
status)

Invoked after transaction commit/rollback.

public default void
beforeCommit(boolean
whether the transaction is defined as read-only transaction
readOnly)

Invoked before transaction commit (before "beforeCompletion").

public default void
beforeCompletion()

Invoked before transaction commit/rollback.

public default void
flush()

Implements java.io.Flushable.flush.

Flush the underlying session to the datastore, if applicable: for example, a Hibernate/JPA session.
public default int
getOrder()

Implements org.springframework.core.Ordered.getOrder.

Return the execution order for this transaction synchronization.
public default void
resume()

Resume this synchronization.

public default void
suspend()

Suspend this synchronization.

Field Detail

STATUS_COMMITTEDback to summary
public static final int STATUS_COMMITTED

Completion status in case of proper commit.

STATUS_ROLLED_BACKback to summary
public static final int STATUS_ROLLED_BACK

Completion status in case of proper rollback.

STATUS_UNKNOWNback to summary
public static final int STATUS_UNKNOWN

Completion status in case of heuristic mixed completion or system errors.

Method Detail

afterCommitback to summary
public default 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.

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

completion status according to the STATUS_* constants

Exceptions
RuntimeException:
in case of errors; will be logged but not propagated (note: do not throw TransactionException subclasses here!)
See Also
STATUS_COMMITTED, STATUS_ROLLED_BACK, STATUS_UNKNOWN, beforeCompletion
beforeCommitback to summary
public default 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:boolean

whether the transaction is defined as read-only transaction

Exceptions
RuntimeException:
in case of errors; will be propagated to the caller (note: do not throw TransactionException subclasses here!)
See Also
beforeCompletion
beforeCompletionback to summary
public default 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.

Exceptions
RuntimeException:
in case of errors; will be logged but not propagated (note: do not throw TransactionException subclasses here!)
See Also
beforeCommit, afterCompletion
flushback to summary
public default void flush()

Implements java.io.Flushable.flush.

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

Annotations
@Override
See Also
org.springframework.transaction.TransactionStatus#flush()
getOrderback to summary
public default int getOrder()

Implements org.springframework.core.Ordered.getOrder.

Return the execution order for this transaction synchronization.

Default is Ordered#LOWEST_PRECEDENCE.

Returns:int

Doc from org.springframework.core.Ordered.getOrder.

the order value

Annotations
@Override
resumeback to summary
public default void resume()

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

See Also
TransactionSynchronizationManager#bindResource
suspendback to summary
public default void suspend()

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

See Also
TransactionSynchronizationManager#unbindResource