added the option of providing a database specific custom SQLExceptionTranslator to provide customized translation for any SQLException before the error codes translation happens (SPR-4899 backport)

Author: trisberg

src/org/springframework/jdbc/support/SQLErrorCodeSQLExceptionTranslator.java

@@ -187,6 +187,17 @@ protected DataAccessException doTranslate(String task, String sql, SQLException
 			return dex;
 		}
 
+		// Next, try the custom SQLException translator, if available.
+		if (this.sqlErrorCodes != null) {
+			SQLExceptionTranslator customTranslator = this.sqlErrorCodes.getCustomSqlExceptionTranslator();
+			if (customTranslator != null) {
+				DataAccessException customDex = customTranslator.translate(task, sql, sqlEx);
+				if (customDex != null) {
+					return customDex;
+				}
+			}
+		}
+
 		// Check SQLErrorCodes with corresponding error code, if available.
 		if (this.sqlErrorCodes != null) {
 			String errorCode = null;

src/org/springframework/jdbc/support/SQLErrorCodes.java

@@ -38,6 +38,8 @@ public class SQLErrorCodes {
 
 	private boolean useSqlStateForTranslation = false;
 
+	private SQLExceptionTranslator customSqlExceptionTranslator = null;
+
 	private String[] badSqlGrammarCodes = new String[0];
 
 	private String[] invalidResultSetAccessCodes = new String[0];
@@ -97,6 +99,27 @@ public boolean isUseSqlStateForTranslation() {
 		return this.useSqlStateForTranslation;
 	}
 
+	public SQLExceptionTranslator getCustomSqlExceptionTranslator() {
+		return customSqlExceptionTranslator;
+	}
+
+	public void setCustomSqlExceptionTranslatorClass(Class customSqlExceptionTranslatorClass) {
+		if (customSqlExceptionTranslatorClass != null) {
+			try {
+				this.customSqlExceptionTranslator =
+						(SQLExceptionTranslator) customSqlExceptionTranslatorClass.newInstance();
+			}
+			catch (InstantiationException e) {
+				throw new InvalidDataAccessResourceUsageException(
+						"Unable to instantiate " + customSqlExceptionTranslatorClass.getName(), e);
+			}
+			catch (IllegalAccessException e) {
+				throw new InvalidDataAccessResourceUsageException(
+						"Unable to instantiate " + customSqlExceptionTranslatorClass.getName(), e);
+			}
+		}
+	}
+
 	public void setBadSqlGrammarCodes(String[] badSqlGrammarCodes) {
 		this.badSqlGrammarCodes = StringUtils.sortStringArray(badSqlGrammarCodes);
 	}

test/org/springframework/jdbc/support/CustomSqlExceptionTranslator.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2002-2009 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.jdbc.support;
+
+import org.springframework.dao.DataAccessException;
+import org.springframework.dao.TransientDataAccessResourceException;
+
+import java.sql.SQLException;
+
+/**
+ * Custom SQLException translation for testing.
+ *
+ * @author Thomas Risberg
+ */
+public class CustomSqlExceptionTranslator implements SQLExceptionTranslator {
+	public DataAccessException translate(String task, String sql, SQLException ex) {
+		if (ex.getErrorCode() == 2) {
+			return new TransientDataAccessResourceException("Custom", ex);
+		}
+		return null;
+	}
+}

test/org/springframework/jdbc/support/SQLExceptionCustomTranslatorTests.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2002-2008 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.jdbc.support;
+
+import org.springframework.dao.DataAccessException;
+import org.springframework.dao.TransientDataAccessResourceException;
+import org.springframework.jdbc.BadSqlGrammarException;
+
+import java.sql.SQLException;
+
+import junit.framework.TestCase;
+
+/**
+ * Class to test custom SQLException translation.
+ *
+ * @author Thomas Risberg
+ */
+public class SQLExceptionCustomTranslatorTests extends TestCase {
+
+	private static SQLErrorCodes ERROR_CODES = new SQLErrorCodes();
+
+	static {
+		ERROR_CODES.setBadSqlGrammarCodes(new String[] { "1" });
+		ERROR_CODES.setDataAccessResourceFailureCodes(new String[] { "2" });
+		ERROR_CODES.setCustomSqlExceptionTranslatorClass(CustomSqlExceptionTranslator.class);
+	}
+
+
+	public void testCustomErrorCodeTranslation() {
+
+		SQLExceptionTranslator sext = new SQLErrorCodeSQLExceptionTranslator(ERROR_CODES);
+
+		SQLException dataIntegrityViolationEx = SQLExceptionSubclassFactory.newSQLDataException("", "", 1);
+		DataAccessException daeex = sext.translate("task", "SQL", dataIntegrityViolationEx);
+		assertEquals(dataIntegrityViolationEx, daeex.getCause());
+		assertTrue(daeex instanceof BadSqlGrammarException);
+
+		SQLException dataAccessResourceEx = SQLExceptionSubclassFactory.newSQLDataException("", "", 2);
+		DataAccessException darex = sext.translate("task", "SQL", dataAccessResourceEx);
+		assertEquals(dataIntegrityViolationEx, daeex.getCause());
+		assertTrue(darex instanceof TransientDataAccessResourceException);
+
+	}
+
+}