HibernateInterceptor

Class Overview

This interceptor binds a new Hibernate Session to the thread before a method call, closing and removing it afterwards in case of any method outcome. If there already is a pre-bound Session (e.g. from HibernateTransactionManager, or from a surrounding Hibernate-intercepted method), the interceptor simply participates in it.

Application code must retrieve a Hibernate Session via the SessionFactoryUtils.getSession method or - preferably - Hibernate's own SessionFactory.getCurrentSession() method, to be able to detect a thread-bound Session. Typically, the code will look like as follows:

 public void doSomeDataAccessAction() {
   Session session = this.sessionFactory.getCurrentSession();
   ...
   // No need to close the Session or translate exceptions!
 }

Note that this interceptor automatically translates HibernateExceptions, via delegating to the SessionFactoryUtils.convertHibernateAccessException method that converts them to exceptions that are compatible with the org.springframework.dao exception hierarchy (like HibernateTemplate does). This can be turned off if the raw exceptions are preferred.

This class can be considered a declarative alternative to HibernateTemplate's callback approach. The advantages are:

• no anonymous classes necessary for callback implementations;
• the possibility to throw any application exceptions from within data access code.

The drawback is the dependency on interceptor configuration. However, note that this interceptor is usually not necessary in scenarios where the data access code always executes within transactions. A transaction will always have a thread-bound Session in the first place, so adding this interceptor to the configuration just adds value when fine-tuning Session settings like the flush mode - or when relying on exception translation.

Summary

[Expand] Inherited Constants

From class org.springframework.orm.hibernate3.HibernateAccessor int FLUSH_ALWAYS Flushing before every query statement is rarely necessary. int FLUSH_AUTO Automatic flushing is the default mode for a Hibernate Session. int FLUSH_COMMIT Flushing at commit only is intended for units of work where no intermediate flushing is desired, not even for find operations that might involve already modified instances. int FLUSH_EAGER Eager flushing leads to immediate synchronization with the database, even if in a transaction. int FLUSH_NEVER Never flush is a good strategy for read-only units of work.

[Expand] Inherited Fields
From class org.springframework.orm.hibernate3.HibernateAccessor protected final Log logger Logger available to subclasses

Public Constructors
	HibernateInterceptor()

Public Methods
Object	invoke(MethodInvocation methodInvocation)
void	setExceptionConversionEnabled(boolean exceptionConversionEnabled) Set whether to convert any HibernateException raised to a Spring DataAccessException, compatible with the org.springframework.dao exception hierarchy.

Protected Methods
Session	getSession() Return a Session for use by this interceptor.

[Expand] Inherited Methods
From class org.springframework.orm.hibernate3.HibernateAccessor void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware). FlushMode applyFlushMode(Session session, boolean existingTransaction) Apply the flush mode that's been specified for this accessor to the given Session. DataAccessException convertHibernateAccessException(HibernateException ex) Convert the given HibernateException to an appropriate exception from the org.springframework.dao hierarchy. DataAccessException convertJdbcAccessException(SQLException ex) Convert the given SQLException to an appropriate exception from the org.springframework.dao hierarchy. DataAccessException convertJdbcAccessException(JDBCException ex, SQLExceptionTranslator translator) Convert the given Hibernate JDBCException to an appropriate exception from the org.springframework.dao hierarchy, using the given SQLExceptionTranslator. void disableFilters(Session session) Disable the specified filters on the given Session. void enableFilters(Session session) Enable the specified filters on the given Session. void flushIfNecessary(Session session, boolean existingTransaction) Flush the given Hibernate Session if necessary. synchronized SQLExceptionTranslator getDefaultJdbcExceptionTranslator() Obtain a default SQLExceptionTranslator, lazily creating it if necessary. Interceptor getEntityInterceptor() Return the current Hibernate entity interceptor, or null if none. String[] getFilterNames() Return the names of Hibernate filters to be activated, if any. int getFlushMode() Return if a flush should be forced after executing the callback code. SQLExceptionTranslator getJdbcExceptionTranslator() Return the JDBC exception translator for this instance, if any. SessionFactory getSessionFactory() Return the Hibernate SessionFactory that should be used to create Hibernate Sessions. void setBeanFactory(BeanFactory beanFactory) The bean factory just needs to be known for resolving entity interceptor bean names. 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 setFilterName(String filter) Set the name of a Hibernate filter to be activated for all Sessions that this accessor works with. void setFilterNames(String[] filterNames) Set one or more names of Hibernate filters to be activated for all Sessions that this accessor works with. void setFlushMode(int flushMode) Set the flush behavior to one of the constants in this class. void setFlushModeName(String constantName) Set the flush behavior by the name of the respective constant in this class, e.g. void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator) Set the JDBC exception translator for this instance. void setSessionFactory(SessionFactory sessionFactory) Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.factory.BeanFactoryAware abstract void setBeanFactory(BeanFactory beanFactory) Callback that supplies the owning factory to a bean instance.
From interface org.springframework.beans.factory.InitializingBean abstract void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).