类 SQLErrorCodesFactory

字段详细资料

• SQL_ERROR_CODE_OVERRIDE_PATH

  public static final String SQL_ERROR_CODE_OVERRIDE_PATH

  The name of custom SQL error codes file, loading from the root of the class path (e.g. from the "/WEB-INF/classes" directory).

  另请参阅:

  常量字段值

• SQL_ERROR_CODE_DEFAULT_PATH

  public static final String SQL_ERROR_CODE_DEFAULT_PATH

  The name of default SQL error code files, loading from the class path.

  另请参阅:

  常量字段值

构造器详细资料

• SQLErrorCodesFactory

  protected SQLErrorCodesFactory()

  Create a new instance of the SQLErrorCodesFactory class.

  Not public to enforce Singleton design pattern. Would be private except to allow testing via overriding the loadResource(String) method.

  Do not subclass in application code.

  另请参阅:

  loadResource(String)

方法详细资料

• getInstance

  public static SQLErrorCodesFactory getInstance()

  Return the singleton instance.

• loadResource

  @Nullable
  protected Resource loadResource​(String path)

  Load the given resource from the class path.

  Not to be overridden by application developers, who should obtain instances of this class from the static getInstance() method.

  Protected for testability.

  参数:

  path - resource path; either a custom path or one of either SQL_ERROR_CODE_DEFAULT_PATH or SQL_ERROR_CODE_OVERRIDE_PATH.

  返回:

  the resource, or null if the resource wasn't found

  另请参阅:

  getInstance()

• getErrorCodes

  public SQLErrorCodes getErrorCodes​(String databaseName)

  Return the SQLErrorCodes instance for the given database.

  No need for a database meta-data lookup.

  参数:

  databaseName - the database name (must not be null)

  返回:

  the SQLErrorCodes instance for the given database (never null; potentially empty)

  抛出:

  IllegalArgumentException - if the supplied database name is null

• getErrorCodes

  public SQLErrorCodes getErrorCodes​(DataSource dataSource)

  Return SQLErrorCodes for the given DataSource, evaluating "databaseProductName" from the DatabaseMetaData, or an empty error codes instance if no SQLErrorCodes were found.

  参数:

  dataSource - the DataSource identifying the database

  返回:

  the corresponding SQLErrorCodes object (never null; potentially empty)

  另请参阅:

  DatabaseMetaData.getDatabaseProductName()

• resolveErrorCodes

  @Nullable
  public SQLErrorCodes resolveErrorCodes​(DataSource dataSource)

  Return SQLErrorCodes for the given DataSource, evaluating "databaseProductName" from the DatabaseMetaData, or null if case of a JDBC meta-data access problem.

  参数:

  dataSource - the DataSource identifying the database

  返回:

  the corresponding SQLErrorCodes object, or null in case of a JDBC meta-data access problem

  从以下版本开始:

  5.2.9

  另请参阅:

  DatabaseMetaData.getDatabaseProductName()

• registerDatabase

  public SQLErrorCodes registerDatabase​(DataSource dataSource,
                                        String databaseName)

  Associate the specified database name with the given DataSource.

  参数:

  dataSource - the DataSource identifying the database

  databaseName - the corresponding database name as stated in the error codes definition file (must not be null)

  返回:

  the corresponding SQLErrorCodes object (never null)

  另请参阅:

  unregisterDatabase(DataSource)

• unregisterDatabase

  @Nullable
  public SQLErrorCodes unregisterDatabase​(DataSource dataSource)

  Clear the cache for the specified DataSource, if registered.

  参数:

  dataSource - the DataSource identifying the database

  返回:

  the corresponding SQLErrorCodes object that got removed, or null if not registered

  从以下版本开始:

  4.3.5

  另请参阅:

  registerDatabase(DataSource, String)