Package io.micronaut.transaction.hibernate5

Class HibernateTransactionManager

    • Constructor Detail

      • HibernateTransactionManager

        public HibernateTransactionManager​(@Parameter
                                   org.hibernate.SessionFactory sessionFactory,
                                   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

      • HibernateTransactionManager

        @Inject
public HibernateTransactionManager​(@Parameter
                                   org.hibernate.SessionFactory sessionFactory,
                                   javax.sql.DataSource dataSource,
                                   @Nullable
                                   org.hibernate.Interceptor entityInterceptor,
                                   @Parameter
                                   java.lang.String name)
        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
        name - The data source name

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

      • 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(io.micronaut.transaction.support.SynchronousTransactionState)

      • doBegin

        protected void doBegin​(java.lang.Object transaction,
                       TransactionDefinition definition)
        Description copied from class: AbstractSynchronousStateTransactionManager
        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 AbstractSynchronousStateTransactionManager<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

      • doSetRollbackOnly

        protected void doSetRollbackOnly​(DefaultTransactionStatus status)
        Description copied from class: AbstractSynchronousStateTransactionManager
        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 AbstractSynchronousStateTransactionManager<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