org.springframework.jdbc.support.SQLStateSQLExceptionTranslator.java Source code

Introduction

Here is the source code for org.springframework.jdbc.support.SQLStateSQLExceptionTranslator.java

Source

/*
 * Copyright 2002-2006 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 java.sql.SQLException;
import java.util.HashSet;
import java.util.Set;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.dao.DataAccessException;
import org.springframework.dao.DataIntegrityViolationException;
import org.springframework.jdbc.BadSqlGrammarException;
import org.springframework.jdbc.UncategorizedSQLException;

/**
 * Implementation of SQLExceptionTranslator that analyzes the SQL state
 * in the SQLException.
 *
 * <p>Not able to diagnose all problems, but is portable between databases and
 * does need require special initialization (no database vendor detection etc).
 * For more precise translation, consider SQLErrorCodeSQLExceptionTranslator.
 *
 * @author Rod Johnson
 * @author Juergen Hoeller
 * @see java.sql.SQLException#getSQLState()
 * @see SQLErrorCodeSQLExceptionTranslator
 */
public class SQLStateSQLExceptionTranslator implements SQLExceptionTranslator {

    /** Set of String 2-digit codes that indicate bad SQL */
    private static final Set BAD_SQL_CODES = new HashSet(4);

    /** Set of String 2-digit codes that indicate RDBMS integrity violation */
    private static final Set INTEGRITY_VIOLATION_CODES = new HashSet(4);

    // Populate reference data.
    static {
        BAD_SQL_CODES.add("07");
        BAD_SQL_CODES.add("42");
        BAD_SQL_CODES.add("65"); // Oracle throws on unknown identifier
        BAD_SQL_CODES.add("S0"); // MySQL uses this - from ODBC error codes?

        INTEGRITY_VIOLATION_CODES.add("22"); // Integrity constraint violation
        INTEGRITY_VIOLATION_CODES.add("23"); // Integrity constraint violation
        INTEGRITY_VIOLATION_CODES.add("27"); // Triggered data change violation
        INTEGRITY_VIOLATION_CODES.add("44"); // With check violation
    }

    protected final Log logger = LogFactory.getLog(getClass());

    public DataAccessException translate(String task, String sql, SQLException sqlEx) {
        if (task == null) {
            task = "";
        }
        if (sql == null) {
            sql = "";
        }

        String sqlState = sqlEx.getSQLState();
        // Some JDBC drivers nest the actual exception from a batched update: need to get the nested one.
        if (sqlState == null) {
            SQLException nestedEx = sqlEx.getNextException();
            if (nestedEx != null) {
                sqlState = nestedEx.getSQLState();
            }
        }
        if (sqlState != null && sqlState.length() >= 2) {
            String classCode = sqlState.substring(0, 2);
            if (BAD_SQL_CODES.contains(classCode)) {
                return new BadSqlGrammarException(task, sql, sqlEx);
            } else if (INTEGRITY_VIOLATION_CODES.contains(classCode)) {
                return new DataIntegrityViolationException(buildMessage(task, sql, sqlEx), sqlEx);
            }
        }

        // We couldn't identify it more precisely.
        return new UncategorizedSQLException(task, sql, sqlEx);
    }

    /**
     * Build a message String for the given SQLException.
     * Called when creating an instance of a generic DataAccessException class.
     * @param task readable text describing the task being attempted
     * @param sql SQL query or update that caused the problem. May be <code>null</code>.
     * @param sqlEx the offending SQLException
     * @return the message String to use
     */
    protected String buildMessage(String task, String sql, SQLException sqlEx) {
        return task + "; SQL [" + sql + "]; " + sqlEx.getMessage();
    }

}