Open Source Repository

Home /spring/spring-jdbc-3.0.5 | Repository Home


org/springframework/jdbc/support/SQLErrorCodes.java
/*
 * 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.util.StringUtils;
import org.springframework.dao.InvalidDataAccessResourceUsageException;

/**
 * JavaBean for holding JDBC error codes for a particular database.
 * Instances of this class are normally loaded through a bean factory.
 *
 <p>Used by Spring's {@link SQLErrorCodeSQLExceptionTranslator}.
 * The file "sql-error-codes.xml" in this package contains default
 <code>SQLErrorCodes</code> instances for various databases.
 *
 @author Thomas Risberg
 @author Juergen Hoeller
 @see SQLErrorCodesFactory
 @see SQLErrorCodeSQLExceptionTranslator
 */
public class SQLErrorCodes {

  private String[] databaseProductNames;

  private boolean useSqlStateForTranslation = false;

  private SQLExceptionTranslator customSqlExceptionTranslator = null;

  private String[] badSqlGrammarCodes = new String[0];

  private String[] invalidResultSetAccessCodes = new String[0];

  private String[] duplicateKeyCodes = new String[0];

  private String[] dataIntegrityViolationCodes = new String[0];

  private String[] permissionDeniedCodes = new String[0];

  private String[] dataAccessResourceFailureCodes = new String[0];

  private String[] transientDataAccessResourceCodes = new String[0];

  private String[] cannotAcquireLockCodes = new String[0];

  private String[] deadlockLoserCodes = new String[0];

  private String[] cannotSerializeTransactionCodes = new String[0];

  private CustomSQLErrorCodesTranslation[] customTranslations;


  /**
   * Set this property if the database name contains spaces,
   * in which case we can not use the bean name for lookup.
   */
  public void setDatabaseProductName(String databaseProductName) {
    this.databaseProductNames = new String[] {databaseProductName};
  }

  public String getDatabaseProductName() {
    return (this.databaseProductNames != null && this.databaseProductNames.length > ?
        this.databaseProductNames[0null);
  }

  /**
   * Set this property to specify multiple database names that contains spaces,
   * in which case we can not use bean names for lookup.
   */
  public void setDatabaseProductNames(String[] databaseProductNames) {
    this.databaseProductNames = databaseProductNames;
  }

  public String[] getDatabaseProductNames() {
    return this.databaseProductNames;
  }

  /**
   * Set this property to true for databases that do not provide an error code
   * but that do provide SQL State (this includes PostgreSQL).
   */
  public void setUseSqlStateForTranslation(boolean useStateCodeForTranslation) {
    this.useSqlStateForTranslation = useStateCodeForTranslation;
  }

  public boolean isUseSqlStateForTranslation() {
    return this.useSqlStateForTranslation;
  }

  public SQLExceptionTranslator getCustomSqlExceptionTranslator() {
    return customSqlExceptionTranslator;
  }

  public void setCustomSqlExceptionTranslatorClass(Class customSqlExceptionTranslatorClass) {
    if (customSqlExceptionTranslatorClass != null) {
      try {
        this.customSqlExceptionTranslator =
            (SQLExceptionTranslatorcustomSqlExceptionTranslatorClass.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);
  }

  public String[] getBadSqlGrammarCodes() {
    return this.badSqlGrammarCodes;
  }

  public void setInvalidResultSetAccessCodes(String[] invalidResultSetAccessCodes) {
    this.invalidResultSetAccessCodes = StringUtils.sortStringArray(invalidResultSetAccessCodes);
  }

  public String[] getInvalidResultSetAccessCodes() {
    return this.invalidResultSetAccessCodes;
  }

  public String[] getDuplicateKeyCodes() {
    return duplicateKeyCodes;
  }

  public void setDuplicateKeyCodes(String[] duplicateKeyCodes) {
    this.duplicateKeyCodes = duplicateKeyCodes;
  }

  public void setDataIntegrityViolationCodes(String[] dataIntegrityViolationCodes) {
    this.dataIntegrityViolationCodes = StringUtils.sortStringArray(dataIntegrityViolationCodes);
  }

  public String[] getDataIntegrityViolationCodes() {
    return this.dataIntegrityViolationCodes;
  }

  public void setPermissionDeniedCodes(String[] permissionDeniedCodes) {
    this.permissionDeniedCodes = StringUtils.sortStringArray(permissionDeniedCodes);
  }

  public String[] getPermissionDeniedCodes() {
    return this.permissionDeniedCodes;
  }

  public void setDataAccessResourceFailureCodes(String[] dataAccessResourceFailureCodes) {
    this.dataAccessResourceFailureCodes = StringUtils.sortStringArray(dataAccessResourceFailureCodes);
  }

  public String[] getDataAccessResourceFailureCodes() {
    return this.dataAccessResourceFailureCodes;
  }

  public void setTransientDataAccessResourceCodes(String[] transientDataAccessResourceCodes) {
    this.transientDataAccessResourceCodes = StringUtils.sortStringArray(transientDataAccessResourceCodes);
  }

  public String[] getTransientDataAccessResourceCodes() {
    return this.transientDataAccessResourceCodes;
  }

  public void setCannotAcquireLockCodes(String[] cannotAcquireLockCodes) {
    this.cannotAcquireLockCodes = StringUtils.sortStringArray(cannotAcquireLockCodes);
  }

  public String[] getCannotAcquireLockCodes() {
    return this.cannotAcquireLockCodes;
  }

  public void setDeadlockLoserCodes(String[] deadlockLoserCodes) {
    this.deadlockLoserCodes = StringUtils.sortStringArray(deadlockLoserCodes);
  }

  public String[] getDeadlockLoserCodes() {
    return this.deadlockLoserCodes;
  }

  public void setCannotSerializeTransactionCodes(String[] cannotSerializeTransactionCodes) {
    this.cannotSerializeTransactionCodes = StringUtils.sortStringArray(cannotSerializeTransactionCodes);
  }
  
  public String[] getCannotSerializeTransactionCodes() {
    return this.cannotSerializeTransactionCodes;
  }

  public void setCustomTranslations(CustomSQLErrorCodesTranslation[] customTranslations) {
    this.customTranslations = customTranslations;
  }

  public CustomSQLErrorCodesTranslation[] getCustomTranslations() {
    return this.customTranslations;
  }

}