| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.springframework.jdbc.support.SQLErrorCodesFactory
public class SQLErrorCodesFactory
Factory for creating SQLErrorCodes based on the
 "databaseProductName" taken from the DatabaseMetaData.
 
Returns SQLErrorCodes populated with vendor codes
 defined in a configuration file named "sql-error-codes.xml".
 Reads the default file in this package if not overridden by a file in
 the root of the class path (for example in the "/WEB-INF/classes" directory).
DatabaseMetaData.getDatabaseProductName()| Field Summary | |
|---|---|
| static String | SQL_ERROR_CODE_DEFAULT_PATHThe name of default SQL error code files, loading from the class path. | 
| static String | SQL_ERROR_CODE_OVERRIDE_PATHThe name of custom SQL error codes file, loading from the root of the class path (e.g. from the "/WEB-INF/classes" directory). | 
| Constructor Summary | |
|---|---|
| protected  | SQLErrorCodesFactory()Create a new instance of the SQLErrorCodesFactoryclass. | 
| Method Summary | |
|---|---|
|  SQLErrorCodes | getErrorCodes(DataSource dataSource)Return SQLErrorCodesfor the givenDataSource,
 evaluating "databaseProductName" from theDatabaseMetaData, or an empty error codes
 instance if noSQLErrorCodeswere found. | 
|  SQLErrorCodes | getErrorCodes(String dbName)Return the SQLErrorCodesinstance for the given database. | 
| static SQLErrorCodesFactory | getInstance()Return the singleton instance. | 
| protected  Resource | loadResource(String path)Load the given resource from the class path. | 
|  SQLErrorCodes | registerDatabase(DataSource dataSource,
                 String dbName)Associate the specified database name with the given DataSource. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
public static final String SQL_ERROR_CODE_OVERRIDE_PATH
public static final String SQL_ERROR_CODE_DEFAULT_PATH
| Constructor Detail | 
|---|
protected SQLErrorCodesFactory()
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)| Method Detail | 
|---|
public static SQLErrorCodesFactory getInstance()
protected Resource loadResource(String 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.
null if the resource wasn't foundgetInstance()public SQLErrorCodes getErrorCodes(String dbName)
SQLErrorCodes instance for the given database.
 No need for a database metadata lookup.
dbName - the database name (must not be null)
SQLErrorCodes instance for the given database
IllegalArgumentException - if the supplied database name is nullpublic SQLErrorCodes getErrorCodes(DataSource dataSource)
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
SQLErrorCodes objectDatabaseMetaData.getDatabaseProductName()
public SQLErrorCodes registerDatabase(DataSource dataSource,
                                      String dbName)
DataSource.
dataSource - the DataSource identifying the databasedbName - the corresponding database name as stated in the error codes
 definition file (must not be null)
SQLErrorCodes object| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||