public class HibernateTransactionManager extends AbstractPlatformTransactionManager implements ResourceTransactionManager, InitializingBean
PlatformTransactionManagerimplementation 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
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
or going through a
Note: To be able to register a DataSource's Connection for plain JDBC code,
this instance needs to be aware of the DataSource (
The given DataSource should obviously match the one used by the given SessionFactory.
JTA (usually through
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).
On JDBC 3.0, this transaction manager supports nested transactions via JDBC 3.0
flag defaults to "false", though, as nested transactions will just apply to the
JDBC Connection, not to the Hibernate Session and its cached objects. 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.
JtaTransactionManager, Serialized Form
|Constructor and Description|
Create a new HibernateTransactionManager instance.
Create a new HibernateTransactionManager instance.
|Modifier and Type||Method and Description|
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
Convert the given HibernateException to an appropriate exception from the
Begin a new transaction with semantics according to the given transaction definition.
Cleanup resources after transaction completion.
Perform an actual commit of the given transaction.
Return a transaction object for the current transaction state.
Resume the resources of the current transaction.
Perform an actual rollback of the given transaction.
Set the given transaction rollback-only.
Suspend the resources of the current transaction.
Return the JDBC DataSource that this instance manages transactions for.
Return the resource factory that this transaction manager operates on, e.g.
Return the SessionFactory that this instance should manage transactions for.
Check if the given transaction object indicates an existing transaction (that is, a transaction which has already started).
Return whether the given Hibernate Session will always hold the same JDBC Connection.
Set whether to autodetect a JDBC DataSource used by the Hibernate SessionFactory, if set via SessionFactoryBuilder's
Set the JDBC DataSource that this instance should manage transactions for.
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.
Set the SessionFactory that this instance should manage transactions for.
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public HibernateTransactionManager(SessionFactory sessionFactory)
sessionFactory- SessionFactory to manage transactions for
public void setSessionFactory(SessionFactory sessionFactory)
public SessionFactory getSessionFactory()
public void setDataSource(DataSource dataSource)
If the SessionFactory was configured with LocalDataSourceConnectionProvider, i.e. by Spring's SessionFactoryBuilder with a specified "dataSource", the DataSource will be auto-detected: You can still explictly 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.
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
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.openSession()(with a Spring
TransactionSynchronizationManagercheck 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
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
clear() call (on rollback) or a
call (on transaction completion) in such a scenario; this is rather left up
to a custom CurrentSessionContext implementation (if desired).
public void afterPropertiesSet()
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
public Object getResourceFactory()
This target resource factory is usually used as resource key for
TransactionSynchronizationManager's resource bindings per thread.
protected Object doGetTransaction()
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
getTransaction call on the transaction manager.
doGetTransaction implementation will usually
look for an existing transaction and store corresponding state in the
returned transaction object.
protected boolean isExistingTransaction(Object transaction)
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.
transaction- transaction object returned by doGetTransaction
protected void doBegin(Object transaction, TransactionDefinition definition)
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.
The default implementation throws a TransactionSuspensionNotSupportedException, assuming that transaction suspension is generally not supported.
transaction- transaction object returned by
transaction- transaction object returned by
suspendedResources- the object that holds suspended resources, as returned by doSuspend
protected void doCommit(DefaultTransactionStatus status)
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.
protected void doRollback(DefaultTransactionStatus status)
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.
protected void doSetRollbackOnly(DefaultTransactionStatus status)
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.
protected void doCleanupAfterCompletion(Object transaction)
on any outcome. The default implementation does nothing.
Should not throw any exceptions but just issue warnings on errors.
protected boolean isSameConnectionForEntireSession(Session session)
The default implementation checks the Session's connection release mode to be "on_close".
protected DataAccessException convertHibernateAccessException(HibernateException ex)
Will automatically apply a specified SQLExceptionTranslator to a Hibernate JDBCException, else rely on Hibernate's default translation.
ex- HibernateException that occured