Class GenericDataStoreHelper
- All Implemented Interfaces:
DataStoreHelper
- Direct Known Subclasses:
DataDirectDataStoreHelper,DB2DataStoreHelper,DerbyDataStoreHelper,InformixDataStoreHelper,MicrosoftSQLServerDataStoreHelper,MSSQLDataStoreHelper,OracleDataStoreHelper,SybaseDataStoreHelper
GenericDataStoreHelper is a general DataStoreHelper
implementation for databases and JDBC drivers fully compliant with SQL-99, X/OPEN, and
JDBC. If you need to plug in additional DataStoreHelper functionality,
you must either inherit from GenericDataStoreHelper or a subclass
of GenericDataStoreHelper.
Note: This class and its methods can not be called or referenced directly by user applications.
SQLException mappings specific to the GenericDataStoreHelper
are the following:
| Error Code | SQL State | PortableSQLException subclass |
|---|---|---|
| 23505 | DuplicateKeyException.class | |
| 55032 | StaleConnectionException.class | |
| 08001 | StaleConnectionException.class | |
| 08003 | StaleConnectionException.class | |
| 40003 | StaleConnectionException.class | |
| S1000 | StaleConnectionException.class | |
| 08006 | StaleConnectionException.class | |
| 08S01 | StaleConnectionException.class |
-
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
ConstructorsConstructorDescriptionGenericDataStoreHelper(Properties props) ThisGenericDataStoreHelperconstructor creates a newGenericDataStoreHelperbased on theDataStoreHelperproperties provided. -
Method Summary
Modifier and TypeMethodDescriptionshortcalcPartitionNumber(String fullTableName, Properties propPartKeys) This method is unused in LibertybooleanThis method is used to clean up a connection before it is returned to the connection pool for later reuse.booleandoConnectionCleanupPerCloseConnection(Connection conn, boolean isCMP, Object props) This method is invoked immediately after a connection handle is closed by the application or implicitly by the application server runtime.booleanThis method is unused in Liberty.voiddoConnectionSetup(Connection conn) This method configures a connection before first use.booleandoConnectionSetupPerGetConnection(Connection conn, boolean isCMP, Object props) This method is invoked before a connection handle is provided to the application.voiddoConnectionSetupPerTransaction(Subject sub, String user, Connection conn, boolean reauthRequired, Object properties) This method is invoked each time a connection comes out of the connection pool and only before transactions begin on that connection.voidThis method cleans up a statement before the statement is returned to the statement cache.This method locates thecom.ibm.websphere.ce.cm.PortableSQLExceptionsubclass corresponding to the specifiedSQLException, as defined by theGenericDataStoreHelperSQLExceptionmap and user-definedSQLExceptionmap.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 returns theDataStoreHelperMetaDataobject associated with thisDataStoreHelper.getPasswordForUseWithTrustedContextWithAuthentication(String identityname, String realm) 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).intgetResultSetConcurrency(AccessIntent intent) This method is unused in Liberty.intgetResultSetType(AccessIntent intent) This method is unused in Liberty.This method provides a plug-in point for providing meaningful logging information for anXAException.hasLostUpdateOrDeadLockOccurred(int isoLevel, boolean loadedForUpdate) This method is unused in Liberty.booleanisBatchUpdateSupportedWithAccessIntent(AccessIntent accessIntent) This method is unused in LibertybooleanThis method determines whether aSQLExceptionindicates a fatal connection error based on the exception map for this data store helper.booleanisDuplicateKey(SQLException sqlX) Liberty does not invoke this method.booleanThis method is unused in Liberty.booleanReturns true if the exception indicates an unsupported operation.The application server uses this API to replace java.sql.SQLExceptions with the exceptions defined in the map if the data source's error detection model is configured to exception mapping.intmodifyXAFlag(int xaflag) This method is used only when thebranch-coupling="LOOSE"resource reference extension is specified.final voidFor internal use only.voidsetUserDefinedMap(Map newmap) This method configures a user-definedSQLExceptionmap that supersedes the defaultSQLExceptionmappings for theDataStoreHelper.showLockInfo(Properties props) This method returns database lock information.
-
Constructor Details
-
GenericDataStoreHelper
ThisGenericDataStoreHelperconstructor creates a newGenericDataStoreHelperbased 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
-
getMetaData
This method returns theDataStoreHelperMetaDataobject associated with thisDataStoreHelper.- Specified by:
getMetaDatain interfaceDataStoreHelper- Returns:
DataStoreHelperMetaData
-
isDuplicateKey
Liberty does not invoke this method.
- Specified by:
isDuplicateKeyin interfaceDataStoreHelper- Parameters:
sqlX- the error.- Returns:
- true if the error indicates a duplicate key violation, otherwise false.
-
getIsolationLevel
This method determines the transaction isolation level to use as default for the database backend.For generic databases and JDBC drivers,
java.sql.Connection.TRANSACTION_READ_COMMITTEDis returned under all circumstances.- Specified by:
getIsolationLevelin interfaceDataStoreHelper- 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.
-
getResultSetType
This method is unused in Liberty.- Specified by:
getResultSetTypein interfaceDataStoreHelper- Throws:
javax.resource.ResourceException
-
getResultSetConcurrency
This method is unused in Liberty.- Specified by:
getResultSetConcurrencyin interfaceDataStoreHelper- Throws:
javax.resource.ResourceException
-
isConnectionError
This method determines whether aSQLExceptionindicates a fatal connection error based on the exception map for this data store helper. You need to override this method if you provide custom exceptions that inherit from StaleConnectionException or StaleStatementException.- Specified by:
isConnectionErrorin interfaceDataStoreHelper- Parameters:
ex- theSQLExceptionto check.- Returns:
- true if the exception indicates a fatal connection error, otherwise false.
-
hasLostUpdateOrDeadLockOccurred
This method is unused in Liberty.- Specified by:
hasLostUpdateOrDeadLockOccurredin interfaceDataStoreHelper
-
findMappingClass
This method locates the
com.ibm.websphere.ce.cm.PortableSQLExceptionsubclass corresponding to the specifiedSQLException, as defined by theGenericDataStoreHelperSQLExceptionmap and user-definedSQLExceptionmap. Precedence and related details ofSQLExceptionmapping are described on theDataStoreHelper.setUserDefinedMapmethod.Overriding this method is one of three options for modifying
SQLExceptionmapping. The other two options are overriding themapExceptionmethod and invoking thesetUserDefinedMapmethod to add a user-definedSQLExceptionmap.- 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.
-
mapException
The application server uses this API to replace java.sql.SQLExceptions with the exceptions defined in the map if the data source's error detection model is configured to exception mapping. If configured to exception checking, then the application server consults the map to help determine the cause of the error, but does not replace the exception.
This method maps the specified SQLException to a correspondingcom.ibm.websphere.ce.cm.PortableSQLExceptionsubclass. If no correspondingcom.ibm.websphere.ce.cm.PortableSQLExceptionsubclass is found, theSQLExceptionis returned unchanged.- Specified by:
mapExceptionin interfaceDataStoreHelper- Parameters:
e- aSQLException.- Returns:
- a
com.ibm.websphere.ce.cm.PortableSQLExceptionsubclass corresponding to the specifiedSQLException, or the unchangedSQLExceptionif no match is found.
-
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.
GenericDataStoreHelperdoes not perform any connection setup.- Specified by:
doConnectionSetupin interfaceDataStoreHelper- Parameters:
conn- the connection to set up.- Throws:
SQLException- if connection setup cannot be completed successfully.
-
doConnectionCleanup
This method is used to clean up a connection before it is returned to the connection pool for later reuse. Liberty automatically resets all standard connection properties (fields for which getters and setters are defined on
java.sql.Connection). This method may be used to reset other properties proprietary to a specific JDBC driver/database and do whatever else is necessary to prepare the connection for reuse.A
DataStoreHelperis permitted to use the provided connection to create and execute statements for the purpose of cleaning up the connection. Any statements created within thedoConnectionCleanupmethod must be explicitly closed within thedoConnectionCleanupmethod. ThedoConnectionCleanupmethod must never close the connection being cleaned up.If any standard connection properties are modified in this method, a value of true must be returned, indicating that at least one standard connection property was modified. A value of false is returned only if no standard connection properties were modified.
GenericDataStoreHelperdoes not perform any connection cleanup.- Specified by:
doConnectionCleanupin interfaceDataStoreHelper- Parameters:
conn- the connection to attempt to cleanup.- Returns:
- true if any standard connection property was modified, otherwise false.
- Throws:
SQLException- If an error occurs while cleaning up the connection.
-
doConnectionCleanupWithValidCheck
Description copied from interface:DataStoreHelperThis method is unused in Liberty.- Specified by:
doConnectionCleanupWithValidCheckin interfaceDataStoreHelper- Throws:
SQLException
-
doStatementCleanup
This method cleans up a statement before the statement is returned to the statement cache. This method is called only for statements that are cached. It is called only if at least one of the following statement properties has changed:
- cursorName
- fetchDirection
- maxFieldSize
- maxRows
- queryTimeout
GenericDataStoreHelperresets all of the properties listed above.The following operations do not need to be included in the statement cleanup since they are automatically performed when caching statements,
setFetchSize(0)clearParameters()clearWarnings()
A helper class implementing this method may choose to do additional cleanup for the statement. However, this should never include closing the statement, since the statement is intended to be cached.
- Specified by:
doStatementCleanupin interfaceDataStoreHelper- Parameters:
stmt- the PreparedStatement.- Throws:
SQLException- if an error occurs cleaning up the statement.
-
showLockInfo
This method returns database lock information. It is unused in Liberty.- 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 the defaultSQLExceptionmappings for theDataStoreHelper. TheDataStoreHelperimplementations that are provided by the application server useSQLExceptionmaps to detect connection errors that can end connections, as well as other specific types of 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(new Integer(-801), MyDuplicateKeyException.class); myErrorMap.put(new Integer(-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 WebSphere
DataStoreHelpers does not include mapping by chained exceptions when no match is found for the original exception.- Specified by:
setUserDefinedMapin interfaceDataStoreHelper- 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.Void.classmay also be used for the value, in which case any existing mapping for the specified SQL State or Error Code is removed.
-
getLockType
This method is unused in Liberty.- Specified by:
getLockTypein interfaceDataStoreHelper
-
calcPartitionNumber
public short calcPartitionNumber(String fullTableName, Properties propPartKeys) throws javax.resource.ResourceException This method is unused in Liberty- Specified by:
calcPartitionNumberin interfaceDataStoreHelper- Throws:
javax.resource.ResourceException
-
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 is used. You can override this method to return a differentjava.io.PrintWriterinstance instead of the default.- Specified by:
getPrintWriterin interfaceDataStoreHelper- Returns:
java.io.PrintWriter.
-
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- Parameters:
x- theXAException.- Returns:
- detailed information about the
XAException, for inclusion in trace.
-
modifyXAFlag
public int modifyXAFlag(int xaflag) This method is used only when the
branch-coupling="LOOSE"resource reference extension is specified. This method modifies the given XA start flag. Some databases, such as Oracle, require a proprietary flag, such asOracleXAResource.ORATRANSLOOSE.GenericDataStoreHelpermakes no modifications to the XA start flag.- Specified by:
modifyXAFlagin interfaceDataStoreHelper- Parameters:
xaflag- The XA start flag to modify.- Returns:
- The modified XA start flag.
-
isBatchUpdateSupportedWithAccessIntent
This method is unused in Liberty- Specified by:
isBatchUpdateSupportedWithAccessIntentin interfaceDataStoreHelper
-
doConnectionSetupPerTransaction
public void doConnectionSetupPerTransaction(Subject sub, String user, Connection conn, boolean reauthRequired, Object properties) throws SQLException Description copied from interface:DataStoreHelperThis method is invoked each time a connection comes out of the connection pool and only before transactions begin on that connection. This method is different from thedoConnectionSetup()method which is only called when a physical connection is first created.
Note that this method must not be used to change any of thejava.sql.Connectionproperties.
Note also that users might need to implement the doConnectionCleanup() method to reset thejava.sql.Connectionto the original state prior to callingdoConnectionSetupPerTransaction
Note also thejava.util.Propertiesparameter which contains a propertyDataStoreHelper.FIRST_TIME_CALLED. TheDataStoreHelper.FIRST_TIME_CALLEDis set to true when thedoConnectionSetupPerTransactionis called by for the first time for any connection. TheDataStoreHelper.FIRST_TIME_CALLEDis set to false thereafter.- Specified by:
doConnectionSetupPerTransactionin interfaceDataStoreHelper- Parameters:
sub- javax.security.auth.Subject for the newly requested connection. This value is null unlessres-authis set to container.user- java.lang.String user name of the newly requested connection. This value is specified only if the subject is null.conn- java.sql.ConnectionreauthRequired- boolean that indicates whether reauthentication is required on the passed connection to get the connection in sync with the subject or user name:- FALSE: connection is in sync with the passed subject or user name.
- TRUE: conneciton is not in sync with the passed subject or user name. In this case, users are required to provide reauthentication implementation for the connection.
properties-java.util.Properties- Throws:
SQLException- if connection throws an exception.
-
doConnectionSetupPerGetConnection
public boolean doConnectionSetupPerGetConnection(Connection conn, boolean isCMP, Object props) throws SQLException Description copied from interface:DataStoreHelperThis method is invoked before a connection handle is provided to the application. This method is called when the connection handle provided is the only handle for the associated ManagedConnection. Thus, if connection sharing occurs, this method will not be called when additional connection handles are provided to the application for the same ManagedConnection. If connection handle usage follows a get/use/close pattern, such that the ManagedConnection has only 1 active connection handle outstanding at a time, then this method will be invoked for each getConnection call made by the application.
This method may be overridden to provide code to set up a connection before its use by the application. This is particularly useful when applications don't have direct access to connections.
Note that The get/use/close pattern must be used by the application if this method is overridden.- Specified by:
doConnectionSetupPerGetConnectionin interfaceDataStoreHelper- Parameters:
conn- java.sql.Connection the underlying database physical connectionisCMP- always false in Liberty.props- Map<String,Object> containing additional properties. The keyDataStoreHelper.SUBJECTmaps to thejavax.security.auth.Subjectif a Subject is available.- Returns:
- boolean false indicates no connection setup is performed by this method, true otherwise. Default is false as its a no-op.
- Throws:
SQLException
-
doConnectionCleanupPerCloseConnection
public boolean doConnectionCleanupPerCloseConnection(Connection conn, boolean isCMP, Object props) throws SQLException Description copied from interface:DataStoreHelperThis method is invoked immediately after a connection handle is closed by the application or implicitly by the application server runtime. If you override thedoConnectionSetupPerGetConnectionmethod to perform connection setup, then you must override this method to undo all connection setup done in thedoConnectionSetupPerGetConnectionmethod.
This method is called when the connection handle closed is the last active handle for the associated ManagedConnection. Thus, if connection sharing occurs, this method will not be called when additional connection handles are active for the same ManagedConnection. If connection handle usage follows a get/use/close pattern, such that the ManagedConnection has only 1 connection handle outstanding at a time, then this method will be invoked for each Connection.close call made by the application. If the end of a transaction (commit or rollback) occurs before Connection.close is called, then the connection handle is dissociated from the ManagedConnection and this method is not invoked.
Note that the get/use/close pattern must be used by the application when this method is overridden.- Specified by:
doConnectionCleanupPerCloseConnectionin interfaceDataStoreHelper- Parameters:
conn- java.sql.Connection the underlying database physical connectionisCMP- always false in Liberty.props- java.lang.Object this is not used and is a place holder for future changes.- Returns:
- boolean false indicates no connection cleanup is performed by this method, true otherwise. Default is false as its a no-op.
- Throws:
SQLException
-
getPasswordForUseWithTrustedContextWithAuthentication
public String getPasswordForUseWithTrustedContextWithAuthentication(String identityname, String realm) throws SQLException Description copied from interface:DataStoreHelperThis method is unused in Liberty.- Specified by:
getPasswordForUseWithTrustedContextWithAuthenticationin interfaceDataStoreHelper- Throws:
SQLException
-
isTransientConnectionError
Description copied from interface:DataStoreHelperThis method is unused in Liberty.- Specified by:
isTransientConnectionErrorin interfaceDataStoreHelper
-
setConfig
For internal use only.- Parameters:
config-
-
isUnsupported
Description copied from interface:DataStoreHelperReturns true if the exception indicates an unsupported operation.- Specified by:
isUnsupportedin interfaceDataStoreHelper- Parameters:
x- the exception.- Returns:
- true if the exception indicates an unsupported operation.
-