org.springframework.orm.hibernate3
Class HibernateExceptionTranslator

java.lang.Object
  extended by org.springframework.orm.hibernate3.HibernateExceptionTranslator
All Implemented Interfaces:
PersistenceExceptionTranslator

public class HibernateExceptionTranslator
extends Object
implements PersistenceExceptionTranslator

PersistenceExceptionTranslator capable of translating HibernateException instances to Spring's DataAccessException hierarchy.

When configuring the Spring container via XML, note that this translator is automatically used internally by SessionFactoryBean types. When configuring the container with @Configuration classes, a @Bean of this type must be registered manually.

Since:
3.1
Author:
Chris Beams
See Also:
SessionFactoryBuilder, PersistenceExceptionTranslationPostProcessor, SessionFactoryUtils.convertHibernateAccessException(HibernateException), SQLExceptionTranslator

Constructor Summary
HibernateExceptionTranslator()
           
 
Method Summary
protected  DataAccessException convertHibernateAccessException(org.hibernate.HibernateException ex)
          Convert the given HibernateException to an appropriate exception from the org.springframework.dao hierarchy.
 void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator)
          Set the JDBC exception translator for the SessionFactory, exposed via the PersistenceExceptionTranslator interface.
 DataAccessException translateExceptionIfPossible(RuntimeException ex)
          Translate the given runtime exception thrown by a persistence framework to a corresponding exception from Spring's generic DataAccessException hierarchy, if possible.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HibernateExceptionTranslator

public HibernateExceptionTranslator()
Method Detail

translateExceptionIfPossible

public DataAccessException translateExceptionIfPossible(RuntimeException ex)
Description copied from interface: PersistenceExceptionTranslator
Translate the given runtime exception thrown by a persistence framework to a corresponding exception from Spring's generic DataAccessException hierarchy, if possible.

Do not translate exceptions that are not understand by this translator: for example, if coming from another persistence framework, or resulting from user code and unrelated to persistence.

Of particular importance is the correct translation to DataIntegrityViolationException, for example on constraint violation. Implementations may use Spring JDBC's sophisticated exception translation to provide further information in the event of SQLException as a root cause.

Specified by:
translateExceptionIfPossible in interface PersistenceExceptionTranslator
Parameters:
ex - a RuntimeException thrown
Returns:
the corresponding DataAccessException (or null if the exception could not be translated, as in this case it may result from user code rather than an actual persistence problem)
See Also:
DataIntegrityViolationException, SQLExceptionTranslator

convertHibernateAccessException

protected DataAccessException convertHibernateAccessException(org.hibernate.HibernateException ex)
Convert the given HibernateException to an appropriate exception from the org.springframework.dao hierarchy.

Will automatically apply a specified SQLExceptionTranslator to a Hibernate JDBCException, else rely on Hibernate's default translation.

Parameters:
ex - HibernateException that occured
Returns:
a corresponding DataAccessException
See Also:
SessionFactoryUtils.convertHibernateAccessException(org.hibernate.HibernateException), setJdbcExceptionTranslator(org.springframework.jdbc.support.SQLExceptionTranslator)

setJdbcExceptionTranslator

public void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator)
Set the JDBC exception translator for the SessionFactory, exposed via the PersistenceExceptionTranslator interface.

Applied to any SQLException root cause of a Hibernate JDBCException, overriding Hibernate's default SQLException translation (which is based on Hibernate's Dialect for a specific target database).

Parameters:
jdbcExceptionTranslator - the exception translator
See Also:
SQLException, JDBCException, SQLErrorCodeSQLExceptionTranslator, SQLStateSQLExceptionTranslator, PersistenceExceptionTranslator