io.micronaut.transaction.hibernate5

Class HibernateTransactionManager

java.lang.Object

io.micronaut.transaction.support.AbstractSynchronousTransactionManager<java.sql.Connection>

io.micronaut.transaction.hibernate5.HibernateTransactionManager

All Implemented Interfaces:

ResourceTransactionManager<javax.persistence.EntityManagerFactory,java.sql.Connection>, SynchronousTransactionManager<java.sql.Connection>, TransactionManager, TransactionOperations<java.sql.Connection>, java.io.Serializable

@EachBean(value=org.hibernate.SessionFactory.class)
 @Requires(missingClasses="org.springframework.orm.hibernate5.HibernateTransactionManager")
 @Replaces(value=DataSourceTransactionManager.class)
public class HibernateTransactionManager
extends AbstractSynchronousTransactionManager<java.sql.Connection>
implements ResourceTransactionManager<javax.persistence.EntityManagerFactory,java.sql.Connection>

SynchronousTransactionManager implementation for a single Hibernate SessionFactory. Binds a Hibernate Session from the specified factory to the thread, potentially allowing for one thread-bound Session per factory. SessionFactory.getCurrentSession() is required for Hibernate access code that needs to support this transaction handling mechanism, with the SessionFactory being configured with MicronautSessionContext.

Supports custom isolation levels, and timeouts that get applied as Hibernate transaction timeouts.

This transaction manager is appropriate for applications that use a single Hibernate SessionFactory for transactional data access, but it also supports direct DataSource access within a transaction (i.e. plain JDBC code working with the same DataSource). This allows for mixing services which access Hibernate and services which use plain JDBC (without being aware of Hibernate)! Application code needs to stick to the same simple Connection lookup pattern as with DataSourceTransactionManager (i.e. DataSourceUtils.getConnection(javax.sql.DataSource).

This transaction manager supports nested transactions via JDBC 3.0 Savepoints. The AbstractSynchronousTransactionManager.setNestedTransactionAllowed(boolean) "nestedTransactionAllowed"} flag defaults to "false", though, as nested transactions will just apply to the JDBC Connection, not to the Hibernate Session and its cached entity objects and related context. You can manually set the flag to "true" if you want to use nested transactions for JDBC access code which participates in Hibernate transactions (provided that your JDBC driver supports Savepoints). Note that Hibernate itself does not support nested transactions! Hence, do not expect Hibernate access code to semantically participate in a nested transaction.

Since:

4.2

Author:

Juergen Hoeller, graemerocher

See Also:

SessionFactory.getCurrentSession(), DataSourceUtils.getConnection(javax.sql.DataSource), DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource), DataSourceTransactionManager, Serialized Form

Field Summary

Fields inherited from class io.micronaut.transaction.support.AbstractSynchronousTransactionManager

logger

Constructor Summary

Constructors

Constructor and Description
HibernateTransactionManager(org.hibernate.SessionFactory sessionFactory, javax.sql.DataSource dataSource, org.hibernate.Interceptor entityInterceptor) Create a new HibernateTransactionManager instance.

Method Summary

Modifier and Type	Method and Description
protected void	disconnectOnCompletion(org.hibernate.Session session) Disconnect a pre-existing Hibernate Session on transaction completion, returning its database connection but preserving its entity state.
protected void	doBegin(java.lang.Object transaction, TransactionDefinition definition) Begin a new transaction with semantics according to the given transaction definition.
protected void	doCleanupAfterCompletion(java.lang.Object transaction) Cleanup resources after transaction completion.
protected void	doCommit(DefaultTransactionStatus status) Perform an actual commit of the given transaction.
protected java.lang.Object	doGetTransaction() Return a transaction object for the current transaction state.
protected void	doResume(java.lang.Object transaction, java.lang.Object suspendedResources) Resume the resources of the current transaction.
protected void	doRollback(DefaultTransactionStatus status) Perform an actual rollback of the given transaction.
protected void	doSetRollbackOnly(DefaultTransactionStatus status) Set the given transaction rollback-only.
protected java.lang.Object	doSuspend(java.lang.Object transaction) Suspend the resources of the current transaction.
java.sql.Connection	getConnection() Obtains the connection for the current transaction.
protected java.sql.Connection	getConnection(java.lang.Object transaction) The connection for the given transaction object.
javax.sql.DataSource	getDataSource()
org.hibernate.Interceptor	getEntityInterceptor()
javax.persistence.EntityManagerFactory	getResourceFactory() Return the resource factory that this transaction manager operates on, e.g.
org.hibernate.SessionFactory	getSessionFactory()
protected boolean	isExistingTransaction(java.lang.Object transaction) Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).
protected boolean	isPhysicallyConnected(org.hibernate.Session session) Determine whether the given Session is (still) physically connected to the database, that is, holds an active JDBC Connection internally.
protected boolean	isSameConnectionForEntireSession(org.hibernate.Session session) Return whether the given Hibernate Session will always hold the same JDBC Connection.
void	setAllowResultAccessAfterCompletion(boolean allowResultAccessAfterCompletion) Set whether to allow result access after completion, typically via Hibernate's ScrollableResults mechanism.
void	setHibernateManagedSession(boolean hibernateManagedSession) Set whether to operate on a Hibernate-managed Session, that is, whether to obtain the Session through Hibernate's SessionFactory.getCurrentSession() instead of SessionFactory.openSession() (with a TransactionSynchronizationManager check preceding it).
void	setPrepareConnection(boolean prepareConnection) Set whether to prepare the underlying JDBC Connection of a transactional Hibernate Session, that is, whether to apply a transaction-specific isolation level and/or the transaction's read-only flag to the underlying JDBC Connection.

Methods inherited from class io.micronaut.transaction.support.AbstractSynchronousTransactionManager

commit, determineTimeout, execute, executeRead, executeWrite, getDefaultTimeout, getTransaction, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, newTransactionStatus, prepareForCommit, prepareSynchronization, prepareTransactionStatus, registerAfterCompletionWithExistingTransaction, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setValidateExistingTransaction, shouldCommitOnGlobalRollbackOnly, suspend, triggerBeforeCommit, triggerBeforeCompletion, useSavepointForNestedTransaction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.transaction.SynchronousTransactionManager

commit, getTransaction, rollback

Methods inherited from interface io.micronaut.transaction.TransactionOperations

execute, executeRead, executeWrite

Constructor Detail

HibernateTransactionManager

public HibernateTransactionManager(org.hibernate.SessionFactory sessionFactory,
                                   @Parameter
                                   javax.sql.DataSource dataSource,
                                   @Nullable
                                   org.hibernate.Interceptor entityInterceptor)

Create a new HibernateTransactionManager instance.

Parameters:

sessionFactory - the SessionFactory to manage transactions for

dataSource - The data source associated with the session factory

entityInterceptor - The configured entity interceptor

Method Detail

getSessionFactory

@NonNull
public org.hibernate.SessionFactory getSessionFactory()

Returns:

Return the SessionFactory that this instance should manage transactions for.

getDataSource

@Nullable
public javax.sql.DataSource getDataSource()

Returns:

Return the JDBC DataSource that this instance manages transactions for.

setPrepareConnection

public void setPrepareConnection(boolean prepareConnection)

Set whether to prepare the underlying JDBC Connection of a transactional Hibernate Session, that is, whether to apply a transaction-specific isolation level and/or the transaction's read-only flag to the underlying JDBC Connection.

Default is "true". If you turn this flag off, the transaction manager will not support per-transaction isolation levels anymore. It will not call Connection.setReadOnly(true) for read-only transactions anymore either. If this flag is turned off, no cleanup of a JDBC Connection is required after a transaction, since no Connection settings will get modified.

Parameters:

prepareConnection - Whether to prepare the connection

See Also:

Connection.setTransactionIsolation(int), Connection.setReadOnly(boolean)

setAllowResultAccessAfterCompletion

public void setAllowResultAccessAfterCompletion(boolean allowResultAccessAfterCompletion)

Set whether to allow result access after completion, typically via Hibernate's ScrollableResults mechanism.

Default is "false". Turning this flag on enforces over-commit holdability on the underlying JDBC Connection (if "prepareConnection" is on) and skips the disconnect-on-completion step.

Parameters:

allowResultAccessAfterCompletion - Whether to allow result access after completion

See Also:

Connection.setHoldability(int), ResultSet.HOLD_CURSORS_OVER_COMMIT, disconnectOnCompletion(Session)

setHibernateManagedSession

public void setHibernateManagedSession(boolean hibernateManagedSession)

Set whether to operate on a Hibernate-managed Session, that is, whether to obtain the Session through Hibernate's SessionFactory.getCurrentSession() instead of SessionFactory.openSession() (with a TransactionSynchronizationManager check preceding it).

Default is "false", i.e. using a Spring-managed Session: taking the current thread-bound Session if available (e.g. in an Open-Session-in-View scenario), creating a new Session for the current transaction otherwise.

Switch this flag to "true" in order to enforce use of a Hibernate-managed Session. Note that this requires SessionFactory.getCurrentSession() to always return a proper Session when called for a Spring-managed transaction; transaction begin will fail if the getCurrentSession() call fails.

This mode will typically be used in combination with a custom Hibernate CurrentSessionContext implementation that stores Sessions in a place other than Spring's TransactionSynchronizationManager. It may also be used in combination with Spring's Open-Session-in-View support (using Spring's default MicronautSessionContext), in which case it subtly differs from the Spring-managed Session mode: The pre-bound Session will not receive a clear() call (on rollback) or a disconnect() call (on transaction completion) in such a scenario; this is rather left up to a custom CurrentSessionContext implementation (if desired).

Parameters:

hibernateManagedSession - True if hibernate managed sessions should be used

getEntityInterceptor

@Nullable
public org.hibernate.Interceptor getEntityInterceptor()

Returns:

Return the current Hibernate entity interceptor, or null if none. Resolves an entity interceptor bean name via the bean factory, if necessary.

getResourceFactory

public javax.persistence.EntityManagerFactory getResourceFactory()

Description copied from interface: ResourceTransactionManager

Return the resource factory that this transaction manager operates on, e.g. a JDBC DataSource or a JMS ConnectionFactory.

This target resource factory is usually used as resource key for TransactionSynchronizationManager's resource bindings per thread.

Specified by:

getResourceFactory in interface ResourceTransactionManager<javax.persistence.EntityManagerFactory,java.sql.Connection>

Returns:

the target resource factory (never null)

See Also:

TransactionSynchronizationManager.bindResource(java.lang.Object, java.lang.Object), TransactionSynchronizationManager.getResource(java.lang.Object)

getConnection

protected java.sql.Connection getConnection(java.lang.Object transaction)

Description copied from class: AbstractSynchronousTransactionManager

The connection for the given transaction object.

Specified by:

getConnection in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - The transaction

Returns:

The connection.

doGetTransaction

protected java.lang.Object doGetTransaction()

Description copied from class: AbstractSynchronousTransactionManager

Return a transaction object for the current transaction state.

The returned object will usually be specific to the concrete transaction manager implementation, carrying corresponding transaction state in a modifiable fashion. This object will be passed into the other template methods (e.g. doBegin and doCommit), either directly or as part of a DefaultTransactionStatus instance.

The returned object should contain information about any existing transaction, that is, a transaction that has already started before the current getTransaction call on the transaction manager. Consequently, a doGetTransaction implementation will usually look for an existing transaction and store corresponding state in the returned transaction object.

Specified by:

doGetTransaction in class AbstractSynchronousTransactionManager<java.sql.Connection>

Returns:

the current transaction object

See Also:

AbstractSynchronousTransactionManager.doBegin(java.lang.Object, io.micronaut.transaction.TransactionDefinition), AbstractSynchronousTransactionManager.doCommit(io.micronaut.transaction.support.DefaultTransactionStatus), AbstractSynchronousTransactionManager.doRollback(io.micronaut.transaction.support.DefaultTransactionStatus), DefaultTransactionStatus.getTransaction()

isExistingTransaction

protected boolean isExistingTransaction(java.lang.Object transaction)

Description copied from class: AbstractSynchronousTransactionManager

Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).

The result will be evaluated according to the specified propagation behavior for the new transaction. An existing transaction might get suspended (in case of PROPAGATION_REQUIRES_NEW), or the new transaction might participate in the existing one (in case of PROPAGATION_REQUIRED).

The default implementation returns false, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.

Overrides:

isExistingTransaction in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - transaction object returned by doGetTransaction

Returns:

if there is an existing transaction

See Also:

AbstractSynchronousTransactionManager.doGetTransaction()

doBegin

protected void doBegin(java.lang.Object transaction,
                       TransactionDefinition definition)

Description copied from class: AbstractSynchronousTransactionManager

Begin a new transaction with semantics according to the given transaction definition. Does not have to care about applying the propagation behavior, as this has already been handled by this abstract manager.

This method gets called when the transaction manager has decided to actually start a new transaction. Either there wasn't any transaction before, or the previous transaction has been suspended.

A special scenario is a nested transaction without savepoint: If useSavepointForNestedTransaction() returns "false", this method will be called to start a nested transaction when necessary. In such a context, there will be an active transaction: The implementation of this method has to detect this and start an appropriate nested transaction.

Specified by:

doBegin in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - transaction object returned by doGetTransaction

definition - a TransactionDefinition instance, describing propagation behavior, isolation level, read-only flag, timeout, and transaction name

doSuspend

protected java.lang.Object doSuspend(java.lang.Object transaction)

Description copied from class: AbstractSynchronousTransactionManager

Suspend the resources of the current transaction. Transaction synchronization will already have been suspended.

The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.

Overrides:

doSuspend in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - transaction object returned by doGetTransaction

Returns:

an object that holds suspended resources (will be kept unexamined for passing it into doResume)

See Also:

AbstractSynchronousTransactionManager.doResume(java.lang.Object, java.lang.Object)

doResume

protected void doResume(@Nullable
                        java.lang.Object transaction,
                        java.lang.Object suspendedResources)

Description copied from class: AbstractSynchronousTransactionManager

Resume the resources of the current transaction. Transaction synchronization will be resumed afterwards.

The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.

Overrides:

doResume in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - transaction object returned by doGetTransaction

suspendedResources - the object that holds suspended resources, as returned by doSuspend

See Also:

AbstractSynchronousTransactionManager.doSuspend(java.lang.Object)

doCommit

protected void doCommit(DefaultTransactionStatus status)

Description copied from class: AbstractSynchronousTransactionManager

Perform an actual commit of the given transaction.

An implementation does not need to check the "new transaction" flag or the rollback-only flag; this will already have been handled before. Usually, a straight commit will be performed on the transaction object contained in the passed-in status.

Specified by:

doCommit in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

status - the status representation of the transaction

See Also:

DefaultTransactionStatus.getTransaction()

doRollback

protected void doRollback(DefaultTransactionStatus status)

Description copied from class: AbstractSynchronousTransactionManager

Perform an actual rollback of the given transaction.

An implementation does not need to check the "new transaction" flag; this will already have been handled before. Usually, a straight rollback will be performed on the transaction object contained in the passed-in status.

Specified by:

doRollback in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

status - the status representation of the transaction

See Also:

DefaultTransactionStatus.getTransaction()

doSetRollbackOnly

protected void doSetRollbackOnly(DefaultTransactionStatus status)

Description copied from class: AbstractSynchronousTransactionManager

Set the given transaction rollback-only. Only called on rollback if the current transaction participates in an existing one.

The default implementation throws an IllegalTransactionStateException, assuming that participating in existing transactions is generally not supported. Subclasses are of course encouraged to provide such support.

Overrides:

doSetRollbackOnly in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

status - the status representation of the transaction

doCleanupAfterCompletion

protected void doCleanupAfterCompletion(java.lang.Object transaction)

Description copied from class: AbstractSynchronousTransactionManager

Cleanup resources after transaction completion.

Called after doCommit and doRollback execution, on any outcome. The default implementation does nothing.

Should not throw any exceptions but just issue warnings on errors.

Overrides:

doCleanupAfterCompletion in class AbstractSynchronousTransactionManager<java.sql.Connection>

Parameters:

transaction - transaction object returned by doGetTransaction

disconnectOnCompletion

protected void disconnectOnCompletion(org.hibernate.Session session)

Disconnect a pre-existing Hibernate Session on transaction completion, returning its database connection but preserving its entity state.

The default implementation simply calls Session.disconnect(). Subclasses may override this with a no-op or with fine-tuned disconnection logic.

Parameters:

session - the Hibernate Session to disconnect

See Also:

Session.disconnect()

isSameConnectionForEntireSession

protected boolean isSameConnectionForEntireSession(org.hibernate.Session session)

Return whether the given Hibernate Session will always hold the same JDBC Connection. This is used to check whether the transaction manager can safely prepare and clean up the JDBC Connection used for a transaction.

The default implementation checks the Session's connection release mode to be "on_close".

Parameters:

session - the Hibernate Session to check

Returns:

Whether the same connection is needed for the whole session

See Also:

ConnectionReleaseMode.ON_CLOSE

isPhysicallyConnected

protected boolean isPhysicallyConnected(org.hibernate.Session session)

Determine whether the given Session is (still) physically connected to the database, that is, holds an active JDBC Connection internally.

Parameters:

session - the Hibernate Session to check

Returns:

Is the session physically connected

See Also:

isSameConnectionForEntireSession(Session)

getConnection

@NonNull
public java.sql.Connection getConnection()

Description copied from interface: TransactionOperations

Obtains the connection for the current transaction.

Specified by:

getConnection in interface TransactionOperations<java.sql.Connection>

Returns:

The connection