org.springframework.orm.hibernate
Class SessionFactoryUtils

java.lang.Object
  org.springframework.orm.hibernate.SessionFactoryUtils

public abstract class SessionFactoryUtils
extends Object

Helper class featuring methods for Hibernate Session handling, allowing for reuse of Hibernate Session instances within transactions. Also provides support for exception translation.

Supports synchronization with both Spring-managed JTA transactions (i.e. JtaTransactionManager) and non-Spring JTA transactions (i.e. plain JTA or EJB CMT). See the getSession version with all parameters for details.

Used internally by HibernateTemplate, HibernateInterceptor, and HibernateTransactionManager. Can also be used directly in application code, e.g. in combination with HibernateInterceptor.

Note: Spring's Hibernate support in this package requires Hibernate 2.1. Dedicated Hibernate3 support can be found in a separate package: org.springframework.orm.hibernate3.

Since:

02.05.2003

Author:

Juergen Hoeller

See Also:

HibernateTemplate, HibernateInterceptor, HibernateTransactionManager, JtaTransactionManager

Field Summary

static int

SESSION_SYNCHRONIZATION_ORDER Order value for TransactionSynchronization objects that clean up Hibernate Sessions.

Constructor Summary

SessionFactoryUtils()

Method Summary

static void	applyTransactionTimeout(net.sf.hibernate.Criteria criteria, net.sf.hibernate.SessionFactory sessionFactory) Apply the current transaction timeout, if any, to the given Hibernate Criteria object.
static void	applyTransactionTimeout(net.sf.hibernate.Query query, net.sf.hibernate.SessionFactory sessionFactory) Apply the current transaction timeout, if any, to the given Hibernate Query object.
static void	closeSession(net.sf.hibernate.Session session) Perform actual closing of the Hibernate Session, catching and logging any cleanup exceptions thrown.
static DataAccessException	convertHibernateAccessException(net.sf.hibernate.HibernateException ex) Convert the given HibernateException to an appropriate exception from the org.springframework.dao hierarchy.
static DataSource	getDataSource(net.sf.hibernate.SessionFactory sessionFactory) Determine the DataSource of the given SessionFactory.
static TransactionManager	getJtaTransactionManager(net.sf.hibernate.SessionFactory sessionFactory, net.sf.hibernate.Session session) Try to retrieve the JTA TransactionManager from the given SessionFactory and/or Session.
static net.sf.hibernate.Session	getNewSession(net.sf.hibernate.SessionFactory sessionFactory) Get a new Hibernate Session from the given SessionFactory.
static net.sf.hibernate.Session	getNewSession(net.sf.hibernate.SessionFactory sessionFactory, net.sf.hibernate.Interceptor entityInterceptor) Get a new Hibernate Session from the given SessionFactory.
static net.sf.hibernate.Session	getSession(net.sf.hibernate.SessionFactory sessionFactory, boolean allowCreate) Get a Hibernate Session for the given SessionFactory.
static net.sf.hibernate.Session	getSession(net.sf.hibernate.SessionFactory sessionFactory, net.sf.hibernate.Interceptor entityInterceptor, SQLExceptionTranslator jdbcExceptionTranslator) Get a Hibernate Session for the given SessionFactory.
static void	initDeferredClose(net.sf.hibernate.SessionFactory sessionFactory) Initialize deferred close for the current thread and the given SessionFactory.
static boolean	isDeferredCloseActive(net.sf.hibernate.SessionFactory sessionFactory) Return if deferred close is active for the current thread and the given SessionFactory.
static boolean	isSessionTransactional(net.sf.hibernate.Session session, net.sf.hibernate.SessionFactory sessionFactory) Return whether the given Hibernate Session is transactional, that is, bound to the current thread by Spring's transaction facilities.
static SQLExceptionTranslator	newJdbcExceptionTranslator(net.sf.hibernate.SessionFactory sessionFactory) Create an appropriate SQLExceptionTranslator for the given SessionFactory.
static void	processDeferredClose(net.sf.hibernate.SessionFactory sessionFactory) Process Sessions that have been registered for deferred close for the given SessionFactory.
static void	releaseSession(net.sf.hibernate.Session session, net.sf.hibernate.SessionFactory sessionFactory) Close the given Session, created via the given factory, if it is not managed externally (i.e. not bound to the thread).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SESSION_SYNCHRONIZATION_ORDER

public static final int SESSION_SYNCHRONIZATION_ORDER

Order value for TransactionSynchronization objects that clean up Hibernate Sessions. Return DataSourceUtils.CONNECTION_SYNCHRONIZATION_ORDER - 100 to execute Session cleanup before JDBC Connection cleanup, if any.

See Also:

DataSourceUtils.CONNECTION_SYNCHRONIZATION_ORDER, Constant Field Values

Constructor Detail

SessionFactoryUtils

public SessionFactoryUtils()

Method Detail

getDataSource

public static DataSource getDataSource(net.sf.hibernate.SessionFactory sessionFactory)

Determine the DataSource of the given SessionFactory.

Parameters:

sessionFactory - the SessionFactory to check

Returns:

the DataSource, or null if none found

See Also:

SessionFactoryImplementor.getConnectionProvider(), LocalDataSourceConnectionProvider

newJdbcExceptionTranslator

public static SQLExceptionTranslator newJdbcExceptionTranslator(net.sf.hibernate.SessionFactory sessionFactory)

Create an appropriate SQLExceptionTranslator for the given SessionFactory. If a DataSource is found, a SQLErrorCodeSQLExceptionTranslator for the DataSource is created; else, a SQLStateSQLExceptionTranslator as fallback.

Parameters:

sessionFactory - the SessionFactory to create the translator for

Returns:

the SQLExceptionTranslator

See Also:

getDataSource(net.sf.hibernate.SessionFactory), SQLErrorCodeSQLExceptionTranslator, SQLStateSQLExceptionTranslator

getJtaTransactionManager

public static TransactionManager getJtaTransactionManager(net.sf.hibernate.SessionFactory sessionFactory,
                                                          net.sf.hibernate.Session session)

Try to retrieve the JTA TransactionManager from the given SessionFactory and/or Session. Check the passed-in SessionFactory for implementing SessionFactoryImplementor (the usual case), falling back to the SessionFactory reference that the Session itself carries (for example, when using Hibernate's JCA Connector, i.e. JCASessionFactoryImpl).

Parameters:

sessionFactory - Hibernate SessionFactory

session - Hibernate Session (can also be null)

Returns:

the JTA TransactionManager, if any

See Also:

TransactionManager, SessionFactoryImplementor.getTransactionManager(), Session.getSessionFactory(), net.sf.hibernate.impl.SessionFactoryImpl, net.sf.hibernate.jca.JCASessionFactoryImpl

getSession

public static net.sf.hibernate.Session getSession(net.sf.hibernate.SessionFactory sessionFactory,
                                                  boolean allowCreate)
                                           throws DataAccessResourceFailureException,
                                                  IllegalStateException

Get a Hibernate Session for the given SessionFactory. Is aware of and will return any existing corresponding Session bound to the current thread, for example when using HibernateTransactionManager. Will create a new Session otherwise, if "allowCreate" is true.

This is the getSession method used by typical data access code, in combination with releaseSession called when done with the Session. Note that HibernateTemplate allows to write data access code without caring about such resource handling.

Supports synchronization with both Spring-managed JTA transactions (i.e. JtaTransactionManager) and non-Spring JTA transactions (i.e. plain JTA or EJB CMT). See the getSession version with all parameters for details.

Parameters:

sessionFactory - Hibernate SessionFactory to create the session with

allowCreate - if a non-transactional Session should be created when no transactional Session can be found for the current thread

Returns:

the Hibernate Session

Throws:

DataAccessResourceFailureException - if the Session couldn't be created

IllegalStateException - if no thread-bound Session found and "allowCreate" is false

See Also:

releaseSession(net.sf.hibernate.Session, net.sf.hibernate.SessionFactory), HibernateTemplate

getSession

public static net.sf.hibernate.Session getSession(net.sf.hibernate.SessionFactory sessionFactory,
                                                  net.sf.hibernate.Interceptor entityInterceptor,
                                                  SQLExceptionTranslator jdbcExceptionTranslator)
                                           throws DataAccessResourceFailureException

Get a Hibernate Session for the given SessionFactory. Is aware of and will return any existing corresponding Session bound to the current thread, for example when using HibernateTransactionManager. Will always create a new Session otherwise.

Supports synchronization with Spring-managed JTA transactions (i.e. JtaTransactionManager) via TransactionSynchronizationManager, to allow for transaction-scoped Hibernate Sessions and proper transactional handling of the JVM-level cache.

Supports synchronization with non-Spring JTA transactions (i.e. plain JTA or EJB CMT) via TransactionSynchronizationManager, to allow for transaction-scoped Hibernate Sessions without JtaTransactionManager. This only applies when a JTA TransactionManagerLookup is specified in the Hibernate configuration.

Supports setting a Session-level Hibernate entity interceptor that allows to inspect and change property values before writing to and reading from the database. Such an interceptor can also be set at the SessionFactory level (i.e. on LocalSessionFactoryBean), on HibernateTransactionManager, or on HibernateInterceptor/HibernateTemplate.

Parameters:

sessionFactory - Hibernate SessionFactory to create the session with

entityInterceptor - Hibernate entity interceptor, or null if none

jdbcExceptionTranslator - SQLExceptionTranslator to use for flushing the Session on transaction synchronization (can be null; only used when actually registering a transaction synchronization)

Returns:

the Hibernate Session

Throws:

DataAccessResourceFailureException - if the Session couldn't be created

See Also:

LocalSessionFactoryBean.setEntityInterceptor(net.sf.hibernate.Interceptor), HibernateAccessor.setEntityInterceptor(net.sf.hibernate.Interceptor), HibernateAccessor.setEntityInterceptor(net.sf.hibernate.Interceptor), HibernateTransactionManager, JtaTransactionManager, TransactionSynchronizationManager

getNewSession

public static net.sf.hibernate.Session getNewSession(net.sf.hibernate.SessionFactory sessionFactory)

Get a new Hibernate Session from the given SessionFactory. Will return a new Session even if there already is a pre-bound Session for the given SessionFactory.

Within a transaction, this method will create a new Session that shares the transaction's JDBC Connection. More specifically, it will use the same JDBC Connection as the pre-bound Hibernate Session.

Parameters:

sessionFactory - Hibernate SessionFactory to create the session with

Returns:

the new Session

getNewSession

public static net.sf.hibernate.Session getNewSession(net.sf.hibernate.SessionFactory sessionFactory,
                                                     net.sf.hibernate.Interceptor entityInterceptor)

Get a new Hibernate Session from the given SessionFactory. Will return a new Session even if there already is a pre-bound Session for the given SessionFactory.

Within a transaction, this method will create a new Session that shares the transaction's JDBC Connection. More specifically, it will use the same JDBC Connection as the pre-bound Hibernate Session.

Parameters:

sessionFactory - Hibernate SessionFactory to create the session with

entityInterceptor - Hibernate entity interceptor, or null if none

Returns:

the new Session

isSessionTransactional

public static boolean isSessionTransactional(net.sf.hibernate.Session session,
                                             net.sf.hibernate.SessionFactory sessionFactory)

Return whether the given Hibernate Session is transactional, that is, bound to the current thread by Spring's transaction facilities.

Parameters:

session - the Hibernate Session to check

sessionFactory - Hibernate SessionFactory that the Session was created with (can be null)

Returns:

whether the Session is transactional

applyTransactionTimeout

public static void applyTransactionTimeout(net.sf.hibernate.Query query,
                                           net.sf.hibernate.SessionFactory sessionFactory)

Apply the current transaction timeout, if any, to the given Hibernate Query object.

Parameters:

query - the Hibernate Query object

sessionFactory - Hibernate SessionFactory that the Query was created for (can be null)

See Also:

Query.setTimeout(int)

applyTransactionTimeout

public static void applyTransactionTimeout(net.sf.hibernate.Criteria criteria,
                                           net.sf.hibernate.SessionFactory sessionFactory)

Apply the current transaction timeout, if any, to the given Hibernate Criteria object.

Parameters:

criteria - the Hibernate Criteria object

sessionFactory - Hibernate SessionFactory that the Criteria was created for

See Also:

Criteria.setTimeout(int)

convertHibernateAccessException

public static DataAccessException convertHibernateAccessException(net.sf.hibernate.HibernateException ex)

Convert the given HibernateException to an appropriate exception from the org.springframework.dao hierarchy. Note that it is advisable to handle JDBCException specifically by using a SQLExceptionTranslator for the underlying SQLException.

Parameters:

ex - HibernateException that occured

Returns:

the corresponding DataAccessException instance

See Also:

HibernateAccessor.convertHibernateAccessException(net.sf.hibernate.HibernateException), HibernateAccessor.convertJdbcAccessException(net.sf.hibernate.JDBCException), HibernateTransactionManager.convertHibernateAccessException(net.sf.hibernate.HibernateException), HibernateTransactionManager.convertJdbcAccessException(net.sf.hibernate.JDBCException), JDBCException.getSQLException(), SQLExceptionTranslator

isDeferredCloseActive

public static boolean isDeferredCloseActive(net.sf.hibernate.SessionFactory sessionFactory)

Return if deferred close is active for the current thread and the given SessionFactory.

Parameters:

sessionFactory - the Hibernate SessionFactory to check

initDeferredClose

public static void initDeferredClose(net.sf.hibernate.SessionFactory sessionFactory)

Initialize deferred close for the current thread and the given SessionFactory. Sessions will not be actually closed on close calls then, but rather at a processDeferredClose call at a finishing point (like request completion).

Used by OpenSessionInViewFilter and OpenSessionInViewInterceptor when not configured for a single session.

Parameters:

sessionFactory - Hibernate SessionFactory

See Also:

processDeferredClose(net.sf.hibernate.SessionFactory), releaseSession(net.sf.hibernate.Session, net.sf.hibernate.SessionFactory), OpenSessionInViewFilter.setSingleSession(boolean), OpenSessionInViewInterceptor.setSingleSession(boolean)

processDeferredClose

public static void processDeferredClose(net.sf.hibernate.SessionFactory sessionFactory)

Process Sessions that have been registered for deferred close for the given SessionFactory.

Parameters:

sessionFactory - Hibernate SessionFactory

See Also:

initDeferredClose(net.sf.hibernate.SessionFactory), releaseSession(net.sf.hibernate.Session, net.sf.hibernate.SessionFactory)

releaseSession

public static void releaseSession(net.sf.hibernate.Session session,
                                  net.sf.hibernate.SessionFactory sessionFactory)

Close the given Session, created via the given factory, if it is not managed externally (i.e. not bound to the thread).

Parameters:

session - the Hibernate Session to close (may be null)

sessionFactory - Hibernate SessionFactory that the Session was created with (can be null)

closeSession

public static void closeSession(net.sf.hibernate.Session session)

Perform actual closing of the Hibernate Session, catching and logging any cleanup exceptions thrown.

Parameters:

session - the Hibernate Session to close (may be null)

See Also:

Session.close()