Class DB2DataStoreHelper
- All Implemented Interfaces:
DataStoreHelper
- Direct Known Subclasses:
DB2AS400DataStoreHelper,DB2UniversalDataStoreHelper
-
Field Summary
Fields inherited from interface com.ibm.websphere.rsadapter.DataStoreHelper
CLOUDSCAPE_HELPER, CLOUDSCAPE_NETWORK_SERVER_HELPER, CONNECTJDBC_HELPER, CUSTOM_HELPER, DATADIRECT_HELPER, DB2_390_HELPER, DB2_390_LOCAL_HELPER, DB2_400_HELPER, DB2_HELPER, DB2_UNIVERSAL_HELPER, DERBY_HELPER, DERBY_NETWORK_SERVER_HELPER, FIRST_TIME_CALLED, GENERIC_HELPER, INFORMIX_HELPER, INFORMIX_JCC_HELPER, MSSQL_HELPER, ORACLE_10G_HELPER, ORACLE_11G_HELPER, ORACLE_HELPER, POTENTIAL_DEADLOCK, POTENTIAL_LOST_UPDATE, PROXY_DS_HELPER, SEQUELINK_HELPER, SUBJECT, SYBASE_HELPER, SYBASE11_HELPER, TX_REPEATABLE_READ_FORUPDATE, TX_SERIALIZABLE_FORUPDATE, UNDEFINED_HELPER, UNDEFINED_ISOLATOIN_LEVEL, UPDATE_ON_READONLY -
Constructor Summary
ConstructorsConstructorDescriptionDB2DataStoreHelper(Properties props) ThisDB2DataStoreHelperconstructor creates a newDB2DataStoreHelperbased on theDataStoreHelperproperties provided. -
Method Summary
Modifier and TypeMethodDescriptionvoiddoConnectionSetup(Connection conn) This method configures a connection before first use.voidThis method cleans up a statement before the statement is returned to the statement cache.final ClassThis method locates thecom.ibm.websphere.ce.cm.PortableSQLExceptionsubclass corresponding to the specifiedSQLException, as defined by theDB2DataStoreHelper,GenericDataStoreHelper, and user-definedSQLExceptionmaps.intgetIsolationLevel(AccessIntent intent) This method determines the transaction isolation level to use as default for the database backend.intgetLockType(AccessIntent intent) This method is unused in Liberty.This method is used to obtain thejava.io.PrintWriterto use for logging when database logging is enabled (for example:WAS.database=all=enabled).This method provides a plug-in point for providing meaningful logging information for anXAException.final voidsetUserDefinedMap(Map newmap) This method configures a user-definedSQLExceptionmap that supersedes defaultSQLExceptionmappings for theDataStoreHelper.final StringshowLockInfo(Properties props) This method returns DB2 lock information.Methods inherited from class com.ibm.websphere.rsadapter.GenericDataStoreHelper
calcPartitionNumber, doConnectionCleanup, doConnectionCleanupPerCloseConnection, doConnectionCleanupWithValidCheck, doConnectionSetupPerGetConnection, doConnectionSetupPerTransaction, getMetaData, getPasswordForUseWithTrustedContextWithAuthentication, getResultSetConcurrency, getResultSetType, hasLostUpdateOrDeadLockOccurred, isBatchUpdateSupportedWithAccessIntent, isConnectionError, isDuplicateKey, isTransientConnectionError, isUnsupported, mapException, modifyXAFlag, setConfig
-
Constructor Details
-
DB2DataStoreHelper
ThisDB2DataStoreHelperconstructor creates a newDB2DataStoreHelperbased on theDataStoreHelperproperties provided. All implementations inheriting from a data store helper must supply this same list of properties to their super class by invoking the constructor of their super class with the list of properties.- Parameters:
props-DataStoreHelperproperties.
-
-
Method Details
-
doConnectionSetup
This method configures a connection before first use. This method is invoked only when a new connection to the database is created. It is not invoked when connections are reused from the connection pool.
This class will set a variable db2ZOS to
FALSEas default value. This method sets toTRUEif the backend system is zOS.GenericDataStoreHelperdoes not perform any connection setup.- Specified by:
doConnectionSetupin interfaceDataStoreHelper- Overrides:
doConnectionSetupin classGenericDataStoreHelper- Parameters:
conn- the connection to set up.- Throws:
SQLException- if connection setup cannot be completed successfully.
-
doStatementCleanup
This method cleans up a statement before the statement is returned to the statement cache. This method is called only for statements being cached. It is called when at least one of the following statement properties has changed,
- cursorName
- fetchDirection
- maxFieldSize
- maxRows
- queryTimeout
DB2DataStoreHelperresets all of the statement properties listed above except for thecursorNameproperty.The following operations do not need to be included in the statement cleanup since they are automatically performed by WebSphere when caching statements:
setFetchSize(0)clearParameters()clearWarnings()
A helper class implementing this method can choose to do additional cleanup for the statement. However, this must never include closing the statement, since the statement is intended to be cached.
- Specified by:
doStatementCleanupin interfaceDataStoreHelper- Overrides:
doStatementCleanupin classGenericDataStoreHelper- Parameters:
stmt- the PreparedStatement.- Throws:
SQLException- if an error occurs cleaning up the statement.
-
findMappingClass
This method locates the
com.ibm.websphere.ce.cm.PortableSQLExceptionsubclass corresponding to the specifiedSQLException, as defined by theDB2DataStoreHelper,GenericDataStoreHelper, and user-definedSQLExceptionmaps. Precedence and related details ofSQLExceptionmapping are described on theDataStoreHelper.setUserDefinedMapmethod.Overriding this method is one of three options you have for modifying
SQLExceptionmapping. The other two options are overriding themapExceptionmethod and invoking thesetUserDefinedMapmethod to add a user-definedSQLExceptionmap.- Overrides:
findMappingClassin classGenericDataStoreHelper- Parameters:
e- TheSQLExceptionfor which to locate acom.ibm.websphere.ce.cm.PortableSQLExceptionsubclass.- Returns:
- The
com.ibm.websphere.ce.cm.PortableSQLExceptionsubclass matching theSQLException, or null if no match was found. - See Also:
-
getIsolationLevel
This method determines the transaction isolation level to use as default for the database backend. The default transaction isolation level forDB2DataStoreHelperisConnection.TRANSACTION_REPEATABLE_READ.- Specified by:
getIsolationLevelin interfaceDataStoreHelper- Overrides:
getIsolationLevelin classGenericDataStoreHelper- Parameters:
intent- always null in Liberty.- Returns:
- A transaction isolation level appropriate for the specified database.
- Throws:
javax.resource.ResourceException- If a transaction isolation level cannot be determined.
-
showLockInfo
This method returns DB2 lock information. It is unused in Liberty. The
propsparameter can include the following properties:- db2Install - DB2 bin directory
- outputFile - the output file for storing the lock information. If this property is not specifed, no output is generated and null is returned.
- workingDir - a directory with write permission for the method caller where temporary files can be created. If this property is not specified, the current directory is used.
- databaseName - the DB2 database name for which to collect lock information. If this property is not specified, the value defaults to "SAMPLE".
- Overrides:
showLockInfoin classGenericDataStoreHelper- Parameters:
props- properties containing information needed to connect to the database.- Returns:
- the lock information.
- Throws:
Exception- if an error occurs while collecting the lock information.
-
setUserDefinedMap
This method configures a user-defined
SQLExceptionmap that supersedes defaultSQLExceptionmappings for theDataStoreHelper. TheDataStoreHelperimplementations provided by the application server useSQLExceptionmaps to detect fatal connection errors, as well as other specific types of connection errors. A customDataStoreHelpercan alter the default mappings by invoking this method. Do not invoke this method from a customDataStoreHelperif you also configureidentifyExceptionfor adataSource. When you configureidentifyException, the application server invokes this method to overlay the default error mappings with the error mappings that are specified in the custom property. Do not invoke this method directly from application code.Example usage of the
setUserDefinedMapmethod:public MyCustomDataStoreHelper() { ... java.util.HashMap MyErrorMap = new java.util.HashMap(2); myErrorMap.put(-801, MyDuplicateKeyException.class); myErrorMap.put(-1015, MyStaleConnectionException.class); setUserDefinedMap(myErrorMap); ... }User-defined exception mapping takes priority over all other exception mapping done by a
DataStoreHelper.For example, assume the following exception mappings are defined:
User-defined mappings SQL State S1000: UserDefinedException Default mappings Error Code 23505: DuplicateKeyException SQL State S1000: StaleConnectionException
Given the above mappings, if a
SQLExceptionis received with SQL State S1000 and Error Code 23505, theDataStoreHelperimplementations map the exception toUserDefinedException.Additionally, mapping done by the
DataStoreHelpers does not include mapping by chained exceptions when no match is found for the original exception.- Specified by:
setUserDefinedMapin interfaceDataStoreHelper- Overrides:
setUserDefinedMapin classGenericDataStoreHelper- Parameters:
newmap- a mapping ofSQLExceptionSQL States and Error Codes tocom.ibm.websphere.ce.cm.PortableSQLExceptionsubclasses. The key for the Map must be aString(representing the SQL State) or anInteger(representing the Error Code). The value for the Map must be a subclass ofcom.ibm.websphere.ce.cm.PortableSQLException. User-defined subclasses are permitted, but are required to declare a public constructor accepting aSQLExceptionas the single parameter. You can also useVoid.classfor the value, in which case any existing mapping for the specified SQL State or Error Code is removed.
-
getPrintWriter
This method is used to obtain thejava.io.PrintWriterto use for logging when database logging is enabled (for example:WAS.database=all=enabled). By default, null is returned and ajava.io.PrintWriterinstance created is used. You can override this method to return a differentjava.io.PrintWriterinstance instead of the default.- Specified by:
getPrintWriterin interfaceDataStoreHelper- Overrides:
getPrintWriterin classGenericDataStoreHelper- Returns:
java.io.PrintWriter.
-
getLockType
This method is unused in Liberty.- Specified by:
getLockTypein interfaceDataStoreHelper- Overrides:
getLockTypein classGenericDataStoreHelper
-
getXAExceptionContents
This method provides a plug-in point for providing meaningful logging information for anXAException. The information can include details of the original exception that caused theXAException, if applicable. This method is used to obtain trace information forXAExceptions to include in trace.- Specified by:
getXAExceptionContentsin interfaceDataStoreHelper- Overrides:
getXAExceptionContentsin classGenericDataStoreHelper- Parameters:
x- theXAException.- Returns:
- detailed information about the
XAException, for inclusion in trace.
-