Class HibernateTransactionManager
- All Implemented Interfaces:
Serializable
,org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanFactoryAware
,org.springframework.beans.factory.InitializingBean
,org.springframework.transaction.PlatformTransactionManager
,org.springframework.transaction.support.ResourceTransactionManager
,org.springframework.transaction.TransactionManager
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 DataSourceTransactionManager
(i.e. DataSourceUtils.getConnection(javax.sql.DataSource)
or going through a
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(javax.sql.DataSource)
).
The given DataSource should obviously match the one used by the given SessionFactory.
JTA (usually through 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 AbstractPlatformTransactionManager.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
- See Also:
-
setSessionFactory(org.hibernate.SessionFactory)
setDataSource(javax.sql.DataSource)
SessionFactory.getCurrentSession()
DataSourceUtils.getConnection(javax.sql.DataSource)
DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource)
JdbcTemplate
DataSourceTransactionManager
JtaTransactionManager
- Serialized Form
-
Field Summary
Fields inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager
logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION
-
Constructor Summary
ConstructorDescriptionCreate a new HibernateTransactionManager instance.HibernateTransactionManager
(SessionFactory sessionFactory) Create a new HibernateTransactionManager instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
protected org.springframework.dao.DataAccessException
Convert the given HibernateException to an appropriate exception from theorg.springframework.dao
hierarchy.protected void
disconnectOnCompletion
(Session session) Disconnect a pre-existing Hibernate Session on transaction completion, returning its database connection but preserving its entity state.protected void
protected void
doCleanupAfterCompletion
(Object transaction) protected void
doCommit
(org.springframework.transaction.support.DefaultTransactionStatus status) protected Object
protected void
protected void
doRollback
(org.springframework.transaction.support.DefaultTransactionStatus status) protected void
doSetRollbackOnly
(org.springframework.transaction.support.DefaultTransactionStatus status) protected Object
Return the JDBC DataSource that this instance manages transactions for.Return the current Hibernate entity interceptor, ornull
if none.Return the SessionFactory that this instance should manage transactions for.protected boolean
isExistingTransaction
(Object transaction) protected final SessionFactory
Obtain the SessionFactory for actual use.void
setAllowResultAccessAfterCompletion
(boolean allowResultAccessAfterCompletion) Set whether to allow result access after completion, typically via Hibernate's ScrollableResults mechanism.void
setAutodetectDataSource
(boolean autodetectDataSource) Set whether to autodetect a JDBC DataSource used by the Hibernate SessionFactory, if set via LocalSessionFactoryBean'ssetDataSource
.void
setBeanFactory
(org.springframework.beans.factory.BeanFactory beanFactory) The bean factory just needs to be known for resolving entity interceptor bean names.void
setDataSource
(DataSource dataSource) Set the JDBC DataSource that this instance should manage transactions for.void
setEntityInterceptor
(Interceptor entityInterceptor) Set a Hibernate entity interceptor that allows to inspect and change property values before writing to and reading from the database.void
setEntityInterceptorBeanName
(String entityInterceptorBeanName) 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.void
setHibernateManagedSession
(boolean hibernateManagedSession) Set whether to operate on a Hibernate-managed Session instead of a Spring-managed Session, that is, whether to obtain the Session through Hibernate'sSessionFactory.getCurrentSession()
instead ofSessionFactory.openSession()
(with a SpringTransactionSynchronizationManager
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.void
setSessionFactory
(SessionFactory sessionFactory) Set the SessionFactory that this instance should manage transactions for.void
setSessionInitializer
(Consumer<Session> sessionInitializer) Specify a callback for customizing every HibernateSession
resource created for a new transaction managed by thisHibernateTransactionManager
.Methods inherited from class org.springframework.transaction.support.AbstractPlatformTransactionManager
commit, determineTimeout, getDefaultTimeout, getTransaction, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, newTransactionStatus, prepareForCommit, prepareSynchronization, prepareTransactionStatus, registerAfterCompletionWithExistingTransaction, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setTransactionSynchronizationName, 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 org.springframework.transaction.PlatformTransactionManager
commit, getTransaction, rollback
-
Constructor Details
-
HibernateTransactionManager
public HibernateTransactionManager()Create a new HibernateTransactionManager instance. A SessionFactory has to be set to be able to use it. -
HibernateTransactionManager
Create a new HibernateTransactionManager instance.- Parameters:
sessionFactory
- the SessionFactory to manage transactions for
-
-
Method Details
-
setSessionFactory
Set the SessionFactory that this instance should manage transactions for. -
getSessionFactory
Return the SessionFactory that this instance should manage transactions for. -
obtainSessionFactory
Obtain the SessionFactory for actual use.- Returns:
- the SessionFactory (never
null
) - Throws:
IllegalStateException
- in case of no SessionFactory set- Since:
- 5.0
-
setDataSource
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.
NOTE: For scenarios with many transactions that just read data from Hibernate's cache (and do not actually access the database), consider using a
LazyConnectionDataSourceProxy
for the actual target DataSource. Alternatively, consider switching"prepareConnection"
tofalse
. In both cases, this transaction manager will not eagerly acquire a JDBC Connection for each Hibernate Session anymore (as of Spring 5.1).- See Also:
-
setAutodetectDataSource(boolean)
TransactionAwareDataSourceProxy
LazyConnectionDataSourceProxy
JdbcTemplate
-
getDataSource
Return the JDBC DataSource that this instance manages transactions for. -
setAutodetectDataSource
public void setAutodetectDataSource(boolean autodetectDataSource) Set whether to autodetect a JDBC DataSource used by the Hibernate SessionFactory, if set via LocalSessionFactoryBean'ssetDataSource
. 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.
- See Also:
-
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. -
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. -
setHibernateManagedSession
public void setHibernateManagedSession(boolean hibernateManagedSession) Set whether to operate on a Hibernate-managed Session instead of a Spring-managed Session, that is, whether to obtain the Session through Hibernate'sSessionFactory.getCurrentSession()
instead ofSessionFactory.openSession()
(with a SpringTransactionSynchronizationManager
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 thegetCurrentSession()
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 defaultSpringSessionContext
), in which case it subtly differs from the Spring-managed Session mode: The pre-bound Session will not receive aclear()
call (on rollback) or adisconnect()
call (on transaction completion) in such a scenario; this is rather left up to a custom CurrentSessionContext implementation (if desired). -
setSessionInitializer
Specify a callback for customizing every HibernateSession
resource created for a new transaction managed by thisHibernateTransactionManager
.This enables convenient customizations for application purposes, e.g. setting Hibernate filters.
- Since:
- 5.3
- See Also:
-
setEntityInterceptorBeanName
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.
- Parameters:
entityInterceptorBeanName
- the name of the entity interceptor in the bean factory- See Also:
-
setEntityInterceptor
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.
-
getEntityInterceptor
@Nullable public Interceptor getEntityInterceptor() throws IllegalStateException, org.springframework.beans.BeansExceptionReturn the current Hibernate entity interceptor, ornull
if none. Resolves an entity interceptor bean name via the bean factory, if necessary.- Throws:
IllegalStateException
- if bean name specified but no bean factory setorg.springframework.beans.BeansException
- if bean name resolution via the bean factory failed- See Also:
-
setBeanFactory
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) 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.- Specified by:
setBeanFactory
in interfaceorg.springframework.beans.factory.BeanFactoryAware
- See Also:
-
afterPropertiesSet
public void afterPropertiesSet()- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
-
getResourceFactory
- Specified by:
getResourceFactory
in interfaceorg.springframework.transaction.support.ResourceTransactionManager
-
doGetTransaction
- Specified by:
doGetTransaction
in classorg.springframework.transaction.support.AbstractPlatformTransactionManager
-
isExistingTransaction
- Overrides:
isExistingTransaction
in classorg.springframework.transaction.support.AbstractPlatformTransactionManager
-
doBegin
protected void doBegin(Object transaction, org.springframework.transaction.TransactionDefinition definition) - Specified by:
doBegin
in classorg.springframework.transaction.support.AbstractPlatformTransactionManager
-
doSuspend
- Overrides:
doSuspend
in classorg.springframework.transaction.support.AbstractPlatformTransactionManager
-
doResume
- Overrides:
doResume
in classorg.springframework.transaction.support.AbstractPlatformTransactionManager
-
doCommit
protected void doCommit(org.springframework.transaction.support.DefaultTransactionStatus status) - Specified by:
doCommit
in classorg.springframework.transaction.support.AbstractPlatformTransactionManager
-
doRollback
protected void doRollback(org.springframework.transaction.support.DefaultTransactionStatus status) - Specified by:
doRollback
in classorg.springframework.transaction.support.AbstractPlatformTransactionManager
-
doSetRollbackOnly
protected void doSetRollbackOnly(org.springframework.transaction.support.DefaultTransactionStatus status) - Overrides:
doSetRollbackOnly
in classorg.springframework.transaction.support.AbstractPlatformTransactionManager
-
doCleanupAfterCompletion
- Overrides:
doCleanupAfterCompletion
in classorg.springframework.transaction.support.AbstractPlatformTransactionManager
-
disconnectOnCompletion
Disconnect a pre-existing Hibernate Session on transaction completion, returning its database connection but preserving its entity state.The default implementation calls the equivalent of
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:
-
convertHibernateAccessException
protected org.springframework.dao.DataAccessException convertHibernateAccessException(HibernateException ex) Convert the given HibernateException to an appropriate exception from theorg.springframework.dao
hierarchy.Will automatically apply a specified SQLExceptionTranslator to a Hibernate JDBCException, else rely on Hibernate's default translation.
- Parameters:
ex
- the HibernateException that occurred- Returns:
- a corresponding DataAccessException
- See Also:
-