public abstract class

ResourceHolderSynchronization

extends Object
implements TransactionSynchronization
java.lang.Object
   ↳ org.springframework.transaction.support.ResourceHolderSynchronization<H extends org.springframework.transaction.support.ResourceHolder, K>

Class Overview

TransactionSynchronization implementation that manages a ResourceHolder bound through TransactionSynchronizationManager.

Summary

[Expand]
Inherited Constants
From interface org.springframework.transaction.support.TransactionSynchronization
Public Constructors
ResourceHolderSynchronization(H resourceHolder, K resourceKey)
Create a new ResourceHolderSynchronization for the given holder.
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.
void resume()
Resume this synchronization.
void suspend()
Suspend this synchronization.
Protected Methods
void cleanupResource(H resourceHolder, K resourceKey, boolean committed)
Perform a cleanup on the given resource (which is left bound to the thread).
void flushResource(H resourceHolder)
Flush callback for the given resource holder.
void processResourceAfterCommit(H resourceHolder)
After-commit callback for the given resource holder.
void releaseResource(H resourceHolder, K resourceKey)
Release the given resource (after it has been unbound from the thread).
boolean shouldReleaseBeforeCompletion()
Return whether this holder's resource should be released before transaction completion (true) or rather after transaction completion (false).
boolean shouldUnbindAtCompletion()
Return whether this holder should be unbound at completion (or should rather be left bound to the thread after the transaction).
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.transaction.support.TransactionSynchronization

Public Constructors

public ResourceHolderSynchronization (H resourceHolder, K resourceKey)

Create a new ResourceHolderSynchronization for the given holder.

Parameters
resourceHolder the ResourceHolder to manage
resourceKey the key to bind the ResourceHolder for

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

Protected Methods

protected void cleanupResource (H resourceHolder, K resourceKey, boolean committed)

Perform a cleanup on the given resource (which is left bound to the thread).

Parameters
resourceHolder the resource holder to process
resourceKey the key that the ResourceHolder was bound for
committed whether the transaction has committed (true) or rolled back (false)

protected void flushResource (H resourceHolder)

Flush callback for the given resource holder.

Parameters
resourceHolder the resource holder to flush

protected void processResourceAfterCommit (H resourceHolder)

After-commit callback for the given resource holder. Only called when the resource hasn't been released yet (shouldReleaseBeforeCompletion()).

Parameters
resourceHolder the resource holder to process

protected void releaseResource (H resourceHolder, K resourceKey)

Release the given resource (after it has been unbound from the thread).

Parameters
resourceHolder the resource holder to process
resourceKey the key that the ResourceHolder was bound for

protected boolean shouldReleaseBeforeCompletion ()

Return whether this holder's resource should be released before transaction completion (true) or rather after transaction completion (false).

Note that resources will only be released when they are unbound from the thread (shouldUnbindAtCompletion()).

The default implementation returns true.

protected boolean shouldUnbindAtCompletion ()

Return whether this holder should be unbound at completion (or should rather be left bound to the thread after the transaction).

The default implementation returns true.