Custom "jdbcExceptionTranslator" on HibernateJpaDialect

Also available on LocalSessionFactoryBean through HibernateExceptionTranslator, as with our former Hibernate 3 support.

Issue: SPR-17015

Author: jhoeller

spring-orm/src/main/java/org/springframework/orm/hibernate5/HibernateExceptionTranslator.java

@@ -19,9 +19,11 @@
 import javax.persistence.PersistenceException;
 
 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;
 import org.springframework.lang.Nullable;
 import org.springframework.orm.jpa.EntityManagerFactoryUtils;
 
@@ -44,6 +46,26 @@
  */
 public class HibernateExceptionTranslator implements PersistenceExceptionTranslator {
 
+	@Nullable
+	private SQLExceptionTranslator jdbcExceptionTranslator;
+
+
+	/**
+	 * Set the JDBC exception translator for Hibernate exception translation purposes.
+	 * <p>Applied to any detected {@link java.sql.SQLException} root cause of a Hibernate
+	 * {@link JDBCException}, overriding Hibernate's own {@code SQLException} translation
+	 * (which is based on a Hibernate Dialect for a specific target database).
+	 * @since 5.1
+	 * @see java.sql.SQLException
+	 * @see org.hibernate.JDBCException
+	 * @see org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator
+	 * @see org.springframework.jdbc.support.SQLStateSQLExceptionTranslator
+	 */
+	public void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator) {
+		this.jdbcExceptionTranslator = jdbcExceptionTranslator;
+	}
+
+
 	@Override
 	@Nullable
 	public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
@@ -62,11 +84,21 @@ public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
 	/**
 	 * Convert the given HibernateException to an appropriate exception from the
 	 * {@code org.springframework.dao} hierarchy.
+	 * <p>Will automatically apply a specified SQLExceptionTranslator to a
+	 * Hibernate JDBCException, otherwise rely on Hibernate's default translation.
 	 * @param ex the HibernateException that occurred
 	 * @return a corresponding DataAccessException
 	 * @see SessionFactoryUtils#convertHibernateAccessException
 	 */
 	protected DataAccessException convertHibernateAccessException(HibernateException ex) {
+		if (this.jdbcExceptionTranslator != null && ex instanceof JDBCException) {
+			JDBCException jdbcEx = (JDBCException) ex;
+			DataAccessException dae = this.jdbcExceptionTranslator.translate(
+					"Hibernate operation: " + jdbcEx.getMessage(), jdbcEx.getSQL(), jdbcEx.getSQLException());
+			if (dae != null) {
+				throw dae;
+			}
+		}
 		return SessionFactoryUtils.convertHibernateAccessException(ex);
 	}
 

spring-orm/src/main/java/org/springframework/orm/jpa/vendor/HibernateJpaDialect.java

@@ -25,6 +25,7 @@
 import org.apache.commons.logging.LogFactory;
 import org.hibernate.FlushMode;
 import org.hibernate.HibernateException;
+import org.hibernate.JDBCException;
 import org.hibernate.NonUniqueObjectException;
 import org.hibernate.NonUniqueResultException;
 import org.hibernate.ObjectDeletedException;
@@ -58,6 +59,7 @@
 import org.springframework.dao.PessimisticLockingFailureException;
 import org.springframework.jdbc.datasource.ConnectionHandle;
 import org.springframework.jdbc.datasource.DataSourceUtils;
+import org.springframework.jdbc.support.SQLExceptionTranslator;
 import org.springframework.lang.Nullable;
 import org.springframework.orm.ObjectOptimisticLockingFailureException;
 import org.springframework.orm.ObjectRetrievalFailureException;
@@ -108,6 +110,9 @@ public class HibernateJpaDialect extends DefaultJpaDialect {
 
 	boolean prepareConnection = true;
 
+	@Nullable
+	private SQLExceptionTranslator jdbcExceptionTranslator;
+
 
 	/**
 	 * Set whether to prepare the underlying JDBC Connection of a transactional
@@ -135,6 +140,21 @@ public void setPrepareConnection(boolean prepareConnection) {
 		this.prepareConnection = prepareConnection;
 	}
 
+	/**
+	 * Set the JDBC exception translator for Hibernate exception translation purposes.
+	 * <p>Applied to any detected {@link java.sql.SQLException} root cause of a Hibernate
+	 * {@link JDBCException}, overriding Hibernate's own {@code SQLException} translation
+	 * (which is based on a Hibernate Dialect for a specific target database).
+	 * @since 5.1
+	 * @see java.sql.SQLException
+	 * @see org.hibernate.JDBCException
+	 * @see org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator
+	 * @see org.springframework.jdbc.support.SQLStateSQLExceptionTranslator
+	 */
+	public void setJdbcExceptionTranslator(SQLExceptionTranslator jdbcExceptionTranslator) {
+		this.jdbcExceptionTranslator = jdbcExceptionTranslator;
+	}
+
 
 	@Override
 	public Object beginTransaction(EntityManager entityManager, TransactionDefinition definition)
@@ -244,6 +264,15 @@ public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
 	 * @return the corresponding DataAccessException instance
 	 */
 	protected DataAccessException convertHibernateAccessException(HibernateException ex) {
+		if (this.jdbcExceptionTranslator != null && ex instanceof JDBCException) {
+			JDBCException jdbcEx = (JDBCException) ex;
+			DataAccessException dae = this.jdbcExceptionTranslator.translate(
+					"Hibernate operation: " + jdbcEx.getMessage(), jdbcEx.getSQL(), jdbcEx.getSQLException());
+			if (dae != null) {
+				throw dae;
+			}
+		}
+
 		if (ex instanceof JDBCConnectionException) {
 			return new DataAccessResourceFailureException(ex.getMessage(), ex);
 		}