org.springframework.orm.hibernate
Class HibernateAccessor

java.lang.Object
  extended byorg.springframework.orm.hibernate.HibernateAccessor
All Implemented Interfaces:
InitializingBean
Direct Known Subclasses:
HibernateInterceptor, HibernateTemplate, OpenSessionInViewInterceptor

public abstract class HibernateAccessor
extends java.lang.Object
implements InitializingBean

Base class for HibernateTemplate and HibernateInterceptor, defining common properties like flushing behavior.

Not intended to be used directly. See HibernateTemplate and HibernateInterceptor.

Since:
29.07.2003
Author:
Juergen Hoeller
See Also:
HibernateTemplate, HibernateInterceptor, setFlushMode(int)

Field Summary
static int FLUSH_AUTO
          Automatic flushing is the default mode for a Hibernate session.
static int FLUSH_EAGER
          Eager flushing leads to immediate synchronization with the database, even if in a transaction.
static int FLUSH_NEVER
          Never flush is a good strategy for read-only units of work.
protected  org.apache.commons.logging.Log logger
           
 
Constructor Summary
HibernateAccessor()
           
 
Method Summary
 void afterPropertiesSet()
          Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
 DataAccessException convertHibernateAccessException(net.sf.hibernate.HibernateException ex)
          Convert the given HibernateException to an appropriate exception from the org.springframework.dao hierarchy.
protected  DataAccessException convertJdbcAccessException(java.sql.SQLException ex)
          Convert the given SQLException to an appropriate exception from the org.springframework.dao hierarchy.
 void flushIfNecessary(net.sf.hibernate.Session session, boolean existingTransaction)
          Flush the given Hibernate session if necessary.
 net.sf.hibernate.Interceptor getEntityInterceptor()
          Return the current Hibernate entity interceptor, or null if none.
 int getFlushMode()
          Return if a flush should be forced after executing the callback code.
 SQLExceptionTranslator getJdbcExceptionTranslator()
          Return the JDBC exception translator for this instance.
 net.sf.hibernate.SessionFactory getSessionFactory()
          Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.
 void setEntityInterceptor(net.sf.hibernate.Interceptor entityInterceptor)
          Set a Hibernate entity interceptor that allows to inspect and change property values before writing to and reading from the database.
 void setFlushMode(int flushMode)
          Set the flush behavior to one of the constants in this class.
 void setFlushModeName(java.lang.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(net.sf.hibernate.SessionFactory sessionFactory)
          Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FLUSH_NEVER

public static final int FLUSH_NEVER
Never flush is a good strategy for read-only units of work. Hibernate will not track and look for changes in this case, avoiding any overhead of modification detection.

See Also:
setFlushMode(int), Constant Field Values

FLUSH_AUTO

public static final int FLUSH_AUTO
Automatic flushing is the default mode for a Hibernate session. A session will get flushed on transaction commit or session closing, and on certain find operations that might involve already modified instances, but not after each unit of work like with eager flushing.

See Also:
setFlushMode(int), Constant Field Values

FLUSH_EAGER

public static final int FLUSH_EAGER
Eager flushing leads to immediate synchronization with the database, even if in a transaction. This causes inconsistencies to show up and throw a respective exception immediately, and JDBC access code that participates in the same transaction will see the changes as the database is already aware of them then. But the drawbacks are:

See Also:
setFlushMode(int), Constant Field Values

logger

protected final org.apache.commons.logging.Log logger
Constructor Detail

HibernateAccessor

public HibernateAccessor()
Method Detail

setSessionFactory

public void setSessionFactory(net.sf.hibernate.SessionFactory sessionFactory)
Set the Hibernate SessionFactory that should be used to create Hibernate Sessions.


getSessionFactory

public net.sf.hibernate.SessionFactory getSessionFactory()
Return the Hibernate SessionFactory that should be used to create Hibernate Sessions.


setEntityInterceptor

public void setEntityInterceptor(net.sf.hibernate.Interceptor entityInterceptor)
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 object.

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.

See Also:
LocalSessionFactoryBean.setEntityInterceptor(net.sf.hibernate.Interceptor), HibernateTransactionManager.setEntityInterceptor(net.sf.hibernate.Interceptor)

getEntityInterceptor

public net.sf.hibernate.Interceptor getEntityInterceptor()
Return the current Hibernate entity interceptor, or null if none.


setJdbcExceptionTranslator

public void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator)
Set the JDBC exception translator for this instance. Applied to SQLExceptions thrown by callback code, be it direct SQLExceptions or wrapped HibernateJDBCExceptions.

The default exception translator evaluates the exception's SQLState.

Parameters:
jdbcExceptionTranslator - exception translator
See Also:
SQLStateSQLExceptionTranslator, SQLErrorCodeSQLExceptionTranslator

getJdbcExceptionTranslator

public SQLExceptionTranslator getJdbcExceptionTranslator()
Return the JDBC exception translator for this instance.


setFlushModeName

public void setFlushModeName(java.lang.String constantName)
Set the flush behavior by the name of the respective constant in this class, e.g. "FLUSH_AUTO". Default is FLUSH_AUTO. Will get applied to any new Session created by this object.

Parameters:
constantName - name of the constant
See Also:
setFlushMode(int), FLUSH_AUTO

setFlushMode

public void setFlushMode(int flushMode)
Set the flush behavior to one of the constants in this class. Default is FLUSH_AUTO. Will get applied to any new Session created by this object.

See Also:
setFlushModeName(java.lang.String), FLUSH_AUTO

getFlushMode

public int getFlushMode()
Return if a flush should be forced after executing the callback code.


afterPropertiesSet

public void afterPropertiesSet()
Description copied from interface: InitializingBean
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

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.

Specified by:
afterPropertiesSet in interface InitializingBean

flushIfNecessary

public void flushIfNecessary(net.sf.hibernate.Session session,
                             boolean existingTransaction)
                      throws net.sf.hibernate.HibernateException
Flush the given Hibernate session if necessary.

Parameters:
session - the current Hibernate session
existingTransaction - if executing within an existing transaction
Throws:
net.sf.hibernate.HibernateException - in case of Hibernate flushing errors

convertHibernateAccessException

public DataAccessException convertHibernateAccessException(net.sf.hibernate.HibernateException ex)
Convert the given HibernateException to an appropriate exception from the org.springframework.dao hierarchy. Will automatically detect wrapped SQLExceptions and convert them accordingly.

The default implementation delegates to SessionFactoryUtils and convertJdbcAccessException. Can be overridden in subclasses.

Parameters:
ex - HibernateException that occured
Returns:
the corresponding DataAccessException instance
See Also:
convertJdbcAccessException(java.sql.SQLException), SessionFactoryUtils.convertHibernateAccessException(net.sf.hibernate.HibernateException)

convertJdbcAccessException

protected DataAccessException convertJdbcAccessException(java.sql.SQLException ex)
Convert the given SQLException to an appropriate exception from the org.springframework.dao hierarchy. Uses a JDBC exception translater if set, and a generic HibernateJdbcException else. Can be overridden in subclasses.

Note that SQLException can just occur here when callback code performs direct JDBC access via Session.connection().

Parameters:
ex - SQLException that occured
Returns:
the corresponding DataAccessException instance
See Also:
setJdbcExceptionTranslator(org.springframework.jdbc.support.SQLExceptionTranslator)


Copyright (C) 2003-2004 The Spring Framework Project.