public class HibernateTransactionManager
extends org.springframework.transaction.support.AbstractPlatformTransactionManager
implements org.springframework.transaction.support.ResourceTransactionManager, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.InitializingBean
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. SessionFactoryUtils
and HibernateTemplate
are aware of thread-bound Sessions and participate
in such transactions automatically. Using either of those or going through
SessionFactory.getCurrentSession()
is required for Hibernate
access code that needs to support this transaction handling mechanism.
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. To achieve this, configure both to the same JNDI DataSource,
or preferably create the SessionFactory with LocalSessionFactoryBean
and
a local DataSource (which will be autodetected by this transaction manager).
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). Normally, JTA setup for Hibernate is
somewhat container-specific due to the JTA TransactionManager lookup, required
for proper transactional handling of the SessionFactory-level read-write cache.
Fortunately, there is an easier way with Spring: SessionFactoryUtils
(and thus HibernateTemplate
) registers synchronizations with Spring's
TransactionSynchronizationManager
(as used by JtaTransactionManager
),
for proper after-completion callbacks. Therefore, as long as Spring's
JtaTransactionManager drives the JTA transactions, Hibernate does not require
any special configuration for proper JTA participation. Note that there are
special restrictions with EJB CMT and restrictive JTA subsystems: See
JtaTransactionManager
's javadoc for details.
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.
Requires Hibernate 3.6.x, as of Spring 4.0.
setSessionFactory(org.hibernate.SessionFactory)
,
setDataSource(javax.sql.DataSource)
,
LocalSessionFactoryBean
,
SessionFactoryUtils.getSession(org.hibernate.SessionFactory, boolean)
,
SessionFactoryUtils.applyTransactionTimeout(org.hibernate.Query, org.hibernate.SessionFactory)
,
SessionFactoryUtils.releaseSession(org.hibernate.Session, org.hibernate.SessionFactory)
,
HibernateTemplate
,
SessionFactory.getCurrentSession()
,
DataSourceUtils.getConnection(javax.sql.DataSource)
,
DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource)
,
DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource)
,
org.springframework.jdbc.core.JdbcTemplate
,
DataSourceTransactionManager
,
JtaTransactionManager
,
Serialized FormConstructor and Description |
---|
HibernateTransactionManager()
Create a new HibernateTransactionManager instance.
|
HibernateTransactionManager(SessionFactory sessionFactory)
Create a new HibernateTransactionManager instance.
|
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet() |
protected org.springframework.dao.DataAccessException |
convertHibernateAccessException(HibernateException ex)
Convert the given HibernateException to an appropriate exception
from the
org.springframework.dao hierarchy. |
protected org.springframework.dao.DataAccessException |
convertJdbcAccessException(JDBCException ex,
org.springframework.jdbc.support.SQLExceptionTranslator translator)
Convert the given Hibernate JDBCException to an appropriate exception
from the
org.springframework.dao hierarchy, using the
given SQLExceptionTranslator. |
protected void |
doBegin(Object transaction,
org.springframework.transaction.TransactionDefinition definition) |
protected void |
doCleanupAfterCompletion(Object transaction) |
protected void |
doCommit(org.springframework.transaction.support.DefaultTransactionStatus status) |
protected Object |
doGetTransaction() |
protected void |
doResume(Object transaction,
Object suspendedResources) |
protected void |
doRollback(org.springframework.transaction.support.DefaultTransactionStatus status) |
protected void |
doSetRollbackOnly(org.springframework.transaction.support.DefaultTransactionStatus status) |
protected Object |
doSuspend(Object transaction) |
DataSource |
getDataSource()
Return the JDBC DataSource that this instance manages transactions for.
|
protected org.springframework.jdbc.support.SQLExceptionTranslator |
getDefaultJdbcExceptionTranslator()
Obtain a default SQLExceptionTranslator, lazily creating it if necessary.
|
Interceptor |
getEntityInterceptor()
Return the current Hibernate entity interceptor, or
null if none. |
org.springframework.jdbc.support.SQLExceptionTranslator |
getJdbcExceptionTranslator()
Return the JDBC exception translator for this transaction manager, if any.
|
Object |
getResourceFactory() |
SessionFactory |
getSessionFactory()
Return the SessionFactory that this instance should manage transactions for.
|
protected boolean |
isExistingTransaction(Object transaction) |
protected boolean |
isSameConnectionForEntireSession(Session session)
Return whether the given Hibernate Session will always hold the same
JDBC Connection.
|
protected void |
prepareForCommit(org.springframework.transaction.support.DefaultTransactionStatus status) |
void |
setAutodetectDataSource(boolean autodetectDataSource)
Set whether to autodetect a JDBC DataSource used by the Hibernate SessionFactory,
if set via LocalSessionFactoryBean's
setDataSource . |
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 |
setEarlyFlushBeforeCommit(boolean earlyFlushBeforeCommit)
Set whether to perform an early flush before proceeding with a commit.
|
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's
SessionFactory.getCurrentSession()
instead of SessionFactory.openSession() (with a Spring
TransactionSynchronizationManager
check preceding it). |
void |
setJdbcExceptionTranslator(org.springframework.jdbc.support.SQLExceptionTranslator jdbcExceptionTranslator)
Set the JDBC exception translator for this transaction manager.
|
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.
|
commit, determineTimeout, getDefaultTimeout, getTransaction, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, newTransactionStatus, prepareSynchronization, prepareTransactionStatus, registerAfterCompletionWithExistingTransaction, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setTransactionSynchronizationName, setValidateExistingTransaction, shouldCommitOnGlobalRollbackOnly, suspend, triggerBeforeCommit, triggerBeforeCompletion, useSavepointForNestedTransaction
public HibernateTransactionManager()
public HibernateTransactionManager(SessionFactory sessionFactory)
sessionFactory
- SessionFactory to manage transactions forpublic void setSessionFactory(SessionFactory sessionFactory)
public SessionFactory getSessionFactory()
public void setDataSource(DataSource dataSource)
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.
setAutodetectDataSource(boolean)
,
LocalDataSourceConnectionProvider
,
AbstractSessionFactoryBean.setDataSource(javax.sql.DataSource)
,
TransactionAwareDataSourceProxy
,
DataSourceUtils
,
org.springframework.jdbc.core.JdbcTemplate
public DataSource getDataSource()
public void setAutodetectDataSource(boolean autodetectDataSource)
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.
public void setPrepareConnection(boolean prepareConnection)
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.
public void setHibernateManagedSession(boolean hibernateManagedSession)
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
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).
public void setEarlyFlushBeforeCommit(boolean earlyFlushBeforeCommit)
Default is "false", performing an implicit flush as part of the actual commit step. Switch this to "true" in order to enforce an explicit early flush right before the actual commit step.
An early flush happens before the before-commit synchronization phase,
making flushed state visible to beforeCommit
callbacks of registered
TransactionSynchronization
objects. Such explicit flush behavior is consistent with Spring-driven
flushing in a JTA transaction environment, so may also get enforced for
consistency with JTA transaction behavior.
public void setEntityInterceptorBeanName(String entityInterceptorBeanName)
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.
entityInterceptorBeanName
- the name of the entity interceptor in
the bean factorysetBeanFactory(org.springframework.beans.factory.BeanFactory)
,
setEntityInterceptor(org.hibernate.Interceptor)
public void setEntityInterceptor(Interceptor entityInterceptor)
Such an interceptor can either be set at the SessionFactory level, i.e. on LocalSessionFactoryBean, or at the Session level, i.e. on HibernateTemplate, HibernateInterceptor, and HibernateTransactionManager. It's preferable to set it on LocalSessionFactoryBean or HibernateTransactionManager to avoid repeated configuration and guarantee consistent behavior in transactions.
public Interceptor getEntityInterceptor() throws IllegalStateException, org.springframework.beans.BeansException
null
if none.
Resolves an entity interceptor bean name via the bean factory,
if necessary.IllegalStateException
- if bean name specified but no bean factory setorg.springframework.beans.BeansException
- if bean name resolution via the bean factory failedsetEntityInterceptor(org.hibernate.Interceptor)
,
setEntityInterceptorBeanName(java.lang.String)
,
setBeanFactory(org.springframework.beans.factory.BeanFactory)
public void setJdbcExceptionTranslator(org.springframework.jdbc.support.SQLExceptionTranslator jdbcExceptionTranslator)
Applied to any SQLException root cause of a Hibernate JDBCException that is thrown on flush, overriding Hibernate's default SQLException translation (which is based on Hibernate's Dialect for a specific target database).
jdbcExceptionTranslator
- the exception translatorSQLException
,
JDBCException
,
SQLErrorCodeSQLExceptionTranslator
,
SQLStateSQLExceptionTranslator
public org.springframework.jdbc.support.SQLExceptionTranslator getJdbcExceptionTranslator()
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
setBeanFactory
in interface org.springframework.beans.factory.BeanFactoryAware
setEntityInterceptorBeanName(java.lang.String)
public void afterPropertiesSet()
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
public Object getResourceFactory()
getResourceFactory
in interface org.springframework.transaction.support.ResourceTransactionManager
protected Object doGetTransaction()
doGetTransaction
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected boolean isExistingTransaction(Object transaction)
isExistingTransaction
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doBegin(Object transaction, org.springframework.transaction.TransactionDefinition definition)
doBegin
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected Object doSuspend(Object transaction)
doSuspend
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doResume(Object transaction, Object suspendedResources)
doResume
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void prepareForCommit(org.springframework.transaction.support.DefaultTransactionStatus status)
prepareForCommit
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doCommit(org.springframework.transaction.support.DefaultTransactionStatus status)
doCommit
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doRollback(org.springframework.transaction.support.DefaultTransactionStatus status)
doRollback
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doSetRollbackOnly(org.springframework.transaction.support.DefaultTransactionStatus status)
doSetRollbackOnly
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected void doCleanupAfterCompletion(Object transaction)
doCleanupAfterCompletion
in class org.springframework.transaction.support.AbstractPlatformTransactionManager
protected boolean isSameConnectionForEntireSession(Session session)
Default implementation checks the Session's connection release mode
to be "on_close". Unfortunately, this requires casting to SessionImpl,
as of Hibernate 3.1. If that cast doesn't work, we'll simply assume
we're safe and return true
.
session
- the Hibernate Session to checkSessionImpl.getConnectionReleaseMode()
,
ConnectionReleaseMode.ON_CLOSE
protected org.springframework.dao.DataAccessException convertHibernateAccessException(HibernateException ex)
org.springframework.dao
hierarchy.
Will automatically apply a specified SQLExceptionTranslator to a Hibernate JDBCException, else rely on Hibernate's default translation.
ex
- HibernateException that occurredSessionFactoryUtils.convertHibernateAccessException(org.hibernate.HibernateException)
,
setJdbcExceptionTranslator(org.springframework.jdbc.support.SQLExceptionTranslator)
protected org.springframework.dao.DataAccessException convertJdbcAccessException(JDBCException ex, org.springframework.jdbc.support.SQLExceptionTranslator translator)
org.springframework.dao
hierarchy, using the
given SQLExceptionTranslator.ex
- Hibernate JDBCException that occurredtranslator
- the SQLExceptionTranslator to useprotected org.springframework.jdbc.support.SQLExceptionTranslator getDefaultJdbcExceptionTranslator()
Creates a default
SQLErrorCodeSQLExceptionTranslator
for the SessionFactory's underlying DataSource.