From 392247d6746eb8bd83d2ea38f5126c11b49bbe5f Mon Sep 17 00:00:00 2001 From: Juergen Hoeller Date: Wed, 21 Dec 2011 15:27:53 +0100 Subject: [PATCH] Hibernate 4 LocalSessionFactoryBean implements PersistenceExceptionTranslator interface as well (SPR-8952); consistent extending of HibernateExceptionTranslator for Hibernate 3 as well as Hibernate 4 --- .../AbstractSessionFactoryBean.java | 64 +------------------ .../HibernateExceptionTranslator.java | 48 +++++++------- .../HibernateExceptionTranslator.java | 8 ++- .../hibernate4/LocalSessionFactoryBean.java | 4 +- 4 files changed, 38 insertions(+), 86 deletions(-) diff --git a/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/AbstractSessionFactoryBean.java b/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/AbstractSessionFactoryBean.java index 135538e795..9d712c3aa0 100644 --- a/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/AbstractSessionFactoryBean.java +++ b/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/AbstractSessionFactoryBean.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2010 the original author or authors. + * Copyright 2002-2011 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,15 +21,11 @@ import javax.sql.DataSource; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.hibernate.HibernateException; -import org.hibernate.JDBCException; import org.hibernate.SessionFactory; import org.springframework.beans.factory.DisposableBean; import org.springframework.beans.factory.FactoryBean; import org.springframework.beans.factory.InitializingBean; -import org.springframework.dao.DataAccessException; -import org.springframework.dao.support.PersistenceExceptionTranslator; -import org.springframework.jdbc.support.SQLExceptionTranslator; /** * Abstract {@link org.springframework.beans.factory.FactoryBean} that creates @@ -54,8 +50,8 @@ import org.springframework.jdbc.support.SQLExceptionTranslator; * @see org.hibernate.SessionFactory#getCurrentSession() * @see org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor */ -public abstract class AbstractSessionFactoryBean - implements FactoryBean, InitializingBean, DisposableBean, PersistenceExceptionTranslator { +public abstract class AbstractSessionFactoryBean extends HibernateExceptionTranslator + implements FactoryBean, InitializingBean, DisposableBean { /** Logger available to subclasses */ protected final Log logger = LogFactory.getLog(getClass()); @@ -66,8 +62,6 @@ public abstract class AbstractSessionFactoryBean private boolean exposeTransactionAwareSessionFactory = true; - private SQLExceptionTranslator jdbcExceptionTranslator; - private SessionFactory sessionFactory; @@ -184,23 +178,6 @@ public abstract class AbstractSessionFactoryBean return this.exposeTransactionAwareSessionFactory; } - /** - * 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). - * @param jdbcExceptionTranslator the exception translator - * @see java.sql.SQLException - * @see org.hibernate.JDBCException - * @see org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator - * @see org.springframework.jdbc.support.SQLStateSQLExceptionTranslator - * @see org.springframework.dao.support.PersistenceExceptionTranslator - */ - public void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator) { - this.jdbcExceptionTranslator = jdbcExceptionTranslator; - } - /** * Build and expose the SessionFactory. @@ -269,41 +246,6 @@ public abstract class AbstractSessionFactoryBean } - /** - * Implementation of the PersistenceExceptionTranslator interface, - * as autodetected by Spring's PersistenceExceptionTranslationPostProcessor. - *

Converts the exception if it is a HibernateException; - * else returns null to indicate an unknown exception. - * @see org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor - * @see #convertHibernateAccessException - */ - public DataAccessException translateExceptionIfPossible(RuntimeException ex) { - if (ex instanceof HibernateException) { - return convertHibernateAccessException((HibernateException) ex); - } - return null; - } - - /** - * 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. - * @param ex HibernateException that occured - * @return a corresponding DataAccessException - * @see SessionFactoryUtils#convertHibernateAccessException - * @see #setJdbcExceptionTranslator - */ - protected DataAccessException convertHibernateAccessException(HibernateException ex) { - if (this.jdbcExceptionTranslator != null && ex instanceof JDBCException) { - JDBCException jdbcEx = (JDBCException) ex; - return this.jdbcExceptionTranslator.translate( - "Hibernate operation: " + jdbcEx.getMessage(), jdbcEx.getSQL(), jdbcEx.getSQLException()); - } - return SessionFactoryUtils.convertHibernateAccessException(ex); - } - - /** * Build the underlying Hibernate SessionFactory. * @return the raw SessionFactory (potentially to be wrapped with a diff --git a/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/HibernateExceptionTranslator.java b/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/HibernateExceptionTranslator.java index 8eddeb38c3..60e298cccf 100644 --- a/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/HibernateExceptionTranslator.java +++ b/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/HibernateExceptionTranslator.java @@ -18,6 +18,7 @@ package org.springframework.orm.hibernate3; import org.hibernate.HibernateException; import org.hibernate.JDBCException; + import org.springframework.dao.DataAccessException; import org.springframework.dao.support.PersistenceExceptionTranslator; import org.springframework.jdbc.support.SQLExceptionTranslator; @@ -26,14 +27,15 @@ import org.springframework.jdbc.support.SQLExceptionTranslator; * {@link PersistenceExceptionTranslator} capable of translating {@link HibernateException} * instances to Spring's {@link DataAccessException} hierarchy. * - *

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

Extended by {@link LocalSessionFactoryBean}, so there is no need to declare this + * translator in addition to a {@code LocalSessionFactoryBean}. + * + *

When configuring the container with {@code @Configuration} classes, a {@code @Bean} + * of this type must be registered manually. * + * @author Juergen Hoeller * @author Chris Beams * @since 3.1 - * @see SessionFactoryBuilder * @see org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor * @see SessionFactoryUtils#convertHibernateAccessException(HibernateException) * @see SQLExceptionTranslator @@ -42,6 +44,25 @@ public class HibernateExceptionTranslator implements PersistenceExceptionTransla private 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). + * @param jdbcExceptionTranslator the exception translator + * @see java.sql.SQLException + * @see org.hibernate.JDBCException + * @see org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator + * @see org.springframework.jdbc.support.SQLStateSQLExceptionTranslator + * @see org.springframework.dao.support.PersistenceExceptionTranslator + */ + public void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator) { + this.jdbcExceptionTranslator = jdbcExceptionTranslator; + } + + public DataAccessException translateExceptionIfPossible(RuntimeException ex) { if (ex instanceof HibernateException) { return convertHibernateAccessException((HibernateException) ex); @@ -68,21 +89,4 @@ public class HibernateExceptionTranslator implements PersistenceExceptionTransla return SessionFactoryUtils.convertHibernateAccessException(ex); } - /** - * 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). - * @param jdbcExceptionTranslator the exception translator - * @see java.sql.SQLException - * @see org.hibernate.JDBCException - * @see org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator - * @see org.springframework.jdbc.support.SQLStateSQLExceptionTranslator - * @see org.springframework.dao.support.PersistenceExceptionTranslator - */ - public void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator) { - this.jdbcExceptionTranslator = jdbcExceptionTranslator; - } - } diff --git a/org.springframework.orm/src/main/java/org/springframework/orm/hibernate4/HibernateExceptionTranslator.java b/org.springframework.orm/src/main/java/org/springframework/orm/hibernate4/HibernateExceptionTranslator.java index 8b02579360..ab263ae3c4 100644 --- a/org.springframework.orm/src/main/java/org/springframework/orm/hibernate4/HibernateExceptionTranslator.java +++ b/org.springframework.orm/src/main/java/org/springframework/orm/hibernate4/HibernateExceptionTranslator.java @@ -23,7 +23,13 @@ import org.springframework.dao.support.PersistenceExceptionTranslator; /** * {@link PersistenceExceptionTranslator} capable of translating {@link HibernateException} - * instances to Spring's {@link org.springframework.dao.DataAccessException} hierarchy. + * instances to Spring's {@link DataAccessException} hierarchy. + * + *

Extended by {@link LocalSessionFactoryBean}, so there is no need to declare this + * translator in addition to a {@code LocalSessionFactoryBean}. + * + *

When configuring the container with {@code @Configuration} classes, a {@code @Bean} + * of this type must be registered manually. * * @author Juergen Hoeller * @since 3.1 diff --git a/org.springframework.orm/src/main/java/org/springframework/orm/hibernate4/LocalSessionFactoryBean.java b/org.springframework.orm/src/main/java/org/springframework/orm/hibernate4/LocalSessionFactoryBean.java index 5af9396b3d..50e161d8f8 100644 --- a/org.springframework.orm/src/main/java/org/springframework/orm/hibernate4/LocalSessionFactoryBean.java +++ b/org.springframework.orm/src/main/java/org/springframework/orm/hibernate4/LocalSessionFactoryBean.java @@ -53,8 +53,8 @@ import org.springframework.core.io.support.ResourcePatternUtils; * @see #setDataSource * @see #setPackagesToScan */ -public class LocalSessionFactoryBean implements FactoryBean, ResourceLoaderAware, - InitializingBean, DisposableBean { +public class LocalSessionFactoryBean extends HibernateExceptionTranslator + implements FactoryBean, ResourceLoaderAware, InitializingBean, DisposableBean { private DataSource dataSource;