spring-framework / org.springframework.orm.hibernate5 / HibernateTransactionManager

HibernateTransactionManager

open class HibernateTransactionManager : AbstractPlatformTransactionManager, ResourceTransactionManager, BeanFactoryAware, InitializingBean

org.springframework.transaction.PlatformTransactionManager 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 SpringSessionContext.

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 org.springframework.jdbc.datasource.DataSourceTransactionManager (i.e. org.springframework.jdbc.datasource.DataSourceUtils#getConnection or going through a org.springframework.jdbc.datasource.TransactionAwareDataSourceProxy).

Note: To be able to register a DataSource's Connection for plain JDBC code, this instance needs to be aware of the DataSource (#setDataSource). The given DataSource should obviously match the one used by the given SessionFactory.

JTA (usually through org.springframework.transaction.jta.JtaTransactionManager) is necessary for accessing multiple transactional resources within the same transaction. The DataSource that Hibernate uses needs to be JTA-enabled in such a scenario (see container setup).

This transaction manager supports nested transactions via JDBC 3.0 Savepoints. The #setNestedTransactionAllowed "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.

Author
Juergen Hoeller

Since
4.2

See Also
#setSessionFactory #setDataSource SessionFactory#getCurrentSession()DataSourceUtils#getConnection DataSourceUtils#releaseConnectionorg.springframework.jdbc.core.JdbcTemplateorg.springframework.jdbc.datasource.DataSourceTransactionManagerorg.springframework.transaction.jta.JtaTransactionManager

Constructors

<init>

HibernateTransactionManager()

Create a new HibernateTransactionManager instance. A SessionFactory has to be set to be able to use it.

HibernateTransactionManager(sessionFactory: SessionFactory)

Create a new HibernateTransactionManager instance.

Functions

afterPropertiesSet	`open fun afterPropertiesSet(): Unit`
getDataSource	`open fun getDataSource(): DataSource` Return the JDBC DataSource that this instance manages transactions for.
getEntityInterceptor	`open fun getEntityInterceptor(): Interceptor` Return the current Hibernate entity interceptor, or `null` if none. Resolves an entity interceptor bean name via the bean factory, if necessary.
getResourceFactory	`open fun getResourceFactory(): Any`
getSessionFactory	`open fun getSessionFactory(): SessionFactory` Return the SessionFactory that this instance should manage transactions for.
setAllowResultAccessAfterCompletion	`open fun setAllowResultAccessAfterCompletion(allowResultAccessAfterCompletion: Boolean): Unit` 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.
setAutodetectDataSource	`open fun setAutodetectDataSource(autodetectDataSource: Boolean): Unit` Set whether to autodetect a JDBC DataSource used by the Hibernate SessionFactory, if set via LocalSessionFactoryBean's `setDataSource`. Default is "true". Can be turned off to deliberately ignore an available DataSource, in order to not expose Hibernate transactions as JDBC transactions for that DataSource.
setBeanFactory	`open fun setBeanFactory(beanFactory: BeanFactory): Unit` The bean factory just needs to be known for resolving entity interceptor bean names. It does not need to be set for any other mode of operation.
setDataSource	`open fun setDataSource(dataSource: DataSource): Unit` Set the JDBC DataSource that this instance should manage transactions for. The DataSource should match the one used by the Hibernate SessionFactory: for example, you could specify the same JNDI DataSource for both. If the SessionFactory was configured with LocalDataSourceConnectionProvider, i.e. by Spring's LocalSessionFactoryBean with a specified "dataSource", the DataSource will be auto-detected: You can still explicitly specify the DataSource, but you don't need to in this case. A transactional JDBC Connection for this DataSource will be provided to application code accessing this DataSource directly via DataSourceUtils or JdbcTemplate. The Connection will be taken from the Hibernate Session. The DataSource specified here should be the target DataSource to manage transactions for, not a TransactionAwareDataSourceProxy. Only data access code may work with TransactionAwareDataSourceProxy, while the transaction manager needs to work on the underlying target DataSource. If there's nevertheless a TransactionAwareDataSourceProxy passed in, it will be unwrapped to extract its target DataSource.
setEntityInterceptor	`open fun setEntityInterceptor(entityInterceptor: Interceptor): Unit` Set a Hibernate entity interceptor that allows to inspect and change property values before writing to and reading from the database. Will get applied to any new Session created by this transaction manager. Such an interceptor can either be set at the SessionFactory level, i.e. on LocalSessionFactoryBean, or at the Session level, i.e. on HibernateTransactionManager.
setEntityInterceptorBeanName	`open fun setEntityInterceptorBeanName(entityInterceptorBeanName: String): Unit` Set the bean name of a Hibernate entity interceptor that allows to inspect and change property values before writing to and reading from the database. Will get applied to any new Session created by this transaction manager. Requires the bean factory to be known, to be able to resolve the bean name to an interceptor instance on session creation. Typically used for prototype interceptors, i.e. a new interceptor instance per session. Can also be used for shared interceptor instances, but it is recommended to set the interceptor reference directly in such a scenario.
setHibernateManagedSession	`open fun setHibernateManagedSession(hibernateManagedSession: Boolean): Unit` Set whether to operate on a Hibernate-managed Session instead of a Spring-managed Session, that is, whether to obtain the Session through Hibernate's `SessionFactory#getCurrentSession()` instead of `SessionFactory#openSession()` (with a Spring 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 org.hibernate.context.spi.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 SpringSessionContext), 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).
setPrepareConnection	`open fun setPrepareConnection(prepareConnection: Boolean): Unit` 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.
setSessionFactory	`open fun setSessionFactory(sessionFactory: SessionFactory): Unit` Set the SessionFactory that this instance should manage transactions for.