Interface DataStoreHelper
-
- All Known Implementing Classes:
- CloudscapeDataStoreHelper, CloudscapeNetworkServerDataStoreHelper, ConnectJDBCDataStoreHelper, com.ibm.websphere.rsadapter.DataDirectDataStoreHelper, DB2390DataStoreHelper, DB2390LocalDataStoreHelper, DB2AS400DataStoreHelper, DB2DataStoreHelper, DB2UniversalDataStoreHelper, DerbyDataStoreHelper, DerbyNetworkServerDataStoreHelper, GenericDataStoreHelper, InformixDataStoreHelper, InformixJccDataStoreHelper, MicrosoftSQLServerDataStoreHelper, Oracle10gDataStoreHelper, Oracle11gDataStoreHelper, OracleDataStoreHelper, ProxyDSDataStoreHelper, Sybase11DataStoreHelper, SybaseDataStoreHelper
public interface DataStoreHelper
The
DataStoreHelper
interface allows users to plug in datastore-specific functionality required by the Relational Resource Adapter runtime. WebSphere provides aDataStoreHelper
implementation for each supported JDBC provider. In addition, WebSphere provides aGenericDataStoreHelper
class, which can be subclassed to add the functionality necessary for the Relational Resource Adapter to interoperate with SQL99 compliant JDBC drivers not officially supported by WebSphere.Custom
Note: This interface can not be referenced directly by user applications.DataStoreHelper
implementations are required to inherit from theGenericDataStoreHelper
class, as WebSphere does not support direct implementation of theDataStoreHelper
interface. New releases of WebSphere might involve changes to theDataStoreHelper
interface. These changes are picked up automatically by custom helpers only if they inherit fromGenericDataStoreHelper
. Custom helpers that do not inherit fromGenericDataStoreHelper
might encounter compile problems and runtime errors.- Since:
- WAS 5.0
- Version:
- 1.31.10.2
- See Also:
GenericDataStoreHelper
-
-
Field Summary
Fields Modifier and Type Field and Description static int
CLOUDSCAPE_HELPER
Deprecated.DataStoreHelper.DERBY_HELPER should be used instead.static int
CLOUDSCAPE_NETWORK_SERVER_HELPER
Deprecated.DataStoreHelper.DERBY_NETWORK_SERVER_HELPER should be used instead.static int
CONNECTJDBC_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
CUSTOM_HELPER
Deprecated.static int
DATADIRECT_HELPER
Deprecated.Please use CONNECTJDBC_HELPER or MSSQL_HELPER instead.static int
DB2_390_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
DB2_390_LOCAL_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
DB2_400_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
DB2_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
DB2_UNIVERSAL_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
DERBY_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
DERBY_NETWORK_SERVER_HELPER
This constant is used to identify the type ofDataStoreHelper
.static java.lang.String
FIRST_TIME_CALLED
This string constant is to be used as a property name in the properties passed on theDataStoreHelper.doConnectionSetupPerTransaction()
.static int
GENERIC_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
INFORMIX_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
INFORMIX_JCC_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
MSSQL_HELPER
This constant is used to identify the type ofDataStoreHelper
as the Microsoft SQL Server JDBC Driver.static int
ORACLE_10G_HELPER
Deprecated.This constant will be removed in a later release. Please use ORACLE_11G_HELPER instead.static int
ORACLE_11G_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
ORACLE_HELPER
Deprecated.This constant will be removed in a later release. Please use ORACLE_11G_HELPER instead.static java.lang.String
POTENTIAL_DEADLOCK
A deadlock is possible.static java.lang.String
POTENTIAL_LOST_UPDATE
A lost update is possible.static int
PROXY_DS_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
SEQUELINK_HELPER
Deprecated.Please use CONNECTJDBC_HELPER or MSSQL_HELPER instead.static java.lang.String
SUBJECT
Property key that specifies thejavax.security.auth.Subject
fordoConnectionSetupPerGetConnection
.static int
SYBASE_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
SYBASE11_HELPER
This constant is used to identify the type ofDataStoreHelper
.static java.lang.String
TX_REPEATABLE_READ_FORUPDATE
This string is needed for the extended-for-update support for some databases (e.g.static java.lang.String
TX_SERIALIZABLE_FORUPDATE
This string is needed for the extended-for-update support for some databases (e.g.static int
UNDEFINED_HELPER
This constant is used to identify the type ofDataStoreHelper
.static int
UNDEFINED_ISOLATOIN_LEVEL
static variable holder for undefined isolation levelstatic java.lang.String
UPDATE_ON_READONLY
An update is being attempted, but a read-only AccessIntent was specified.
-
Method Summary
Methods Modifier and Type Method and Description short
calcPartitionNumber(java.lang.String fullTableName, java.util.Properties propPartKeys)
This method allows you to calculate the partition number based on the input table name and partition key properties.boolean
doConnectionCleanup(java.sql.Connection conn)
This method is used to clean up a connection before it is returned to the connection pool for later reuse.boolean
doConnectionCleanupPerCloseConnection(java.sql.Connection conn, boolean isCMP, java.lang.Object props)
This method is invoked by WebSphere Application Server runtime immediately after a connection handle is closed by the application or implicitly by WebSphere Application Server runtime.boolean
doConnectionCleanupWithValidCheck(java.sql.Connection conn)
void
doConnectionSetup(java.sql.Connection conn)
This method configures a connection before first use.boolean
doConnectionSetupPerGetConnection(java.sql.Connection conn, boolean isCMP, java.lang.Object props)
This method is invoked by WebSphere Application Server runtime before a connection handle is provided to the application.void
doConnectionSetupPerTransaction(javax.security.auth.Subject sub, java.lang.String user, java.sql.Connection conn, boolean reauthRequired, java.lang.Object properties)
This method is invoked by WebSphere runtime each time a connection comes out of the connection pool and only before transactions begin on that connection.void
doStatementCleanup(java.sql.PreparedStatement stmt)
This method cleans up a statement before the statement is placed in the statement cache.int
getIsolationLevel(AccessIntent intent)
This method determines the transaction isolation level based on the specifiedAccessIntent
.int
getLockType(AccessIntent intent)
This method returns a lock type constant based on the update hint value of the specified AccessIntent.DataStoreHelperMetaData
getMetaData()
This method returns theDataStoreHelperMetaData
object associated with thisDataStoreHelper
.java.lang.String
getPasswordForUseWithTrustedContextWithAuthentication(java.lang.String identityname, java.lang.String realm)
The application server invokes this method at run time to get the password that the application server will use to establish a trusted connection using the DB2 TrustedContext "with authentication" option or when the application server switches a trusted connection to another identity, and the "with authentication" option is enabled.java.io.PrintWriter
getPrintWriter()
This method is used to obtain thejava.io.PrintWriter
to use for logging when database logging is enabled (for example:WAS.database=all=enabled
).int
getResultSetConcurrency(AccessIntent intent)
This method determines the result set concurrency based on the specifiedAccessIntent
.int
getResultSetType(AccessIntent intent)
This method determines the result set type based on the specifiedAccessIntent
.java.lang.String
getXAExceptionContents(javax.transaction.xa.XAException xae)
This method provides a plug-in point for providing meaningful logging information for anXAException
.java.lang.String
hasLostUpdateOrDeadLockOccurred(int isoLevel, boolean loadedForUpdate)
This method is invoked when storing a CMP EntityBean if pessimistic concurrency control is activated.boolean
isBatchUpdateSupportedWithAccessIntent(AccessIntent accessIntent)
This method is used to determine if CMP Entity Beans can support batch updates with the given AccessIntent.boolean
isConnectionError(java.sql.SQLException ex)
This method determines whether aSQLException
indicates a fatal connection error based on the exception map for this data store helper.boolean
isDuplicateKey(java.sql.SQLException sqlX)
The application server invokes this method to determine whether or not the specified error indicates a duplicate key violation.boolean
isTransientConnectionError(java.sql.SQLException ex)
This method determines whether aSQLException
indicates a transient connection error.java.sql.SQLException
mapException(java.sql.SQLException e)
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.int
modifyXAFlag(int xaflag)
This method is used only when thetransactionBranchesLooselyCoupled
custom DataSource property is set to true.void
setUserDefinedMap(java.util.Map newmap)
This method configures a user-definedSQLException
map that supersedes the defaultSQLException
mappings for theDataStoreHelper
.
-
-
-
Field Detail
-
UNDEFINED_ISOLATOIN_LEVEL
static final int UNDEFINED_ISOLATOIN_LEVEL
static variable holder for undefined isolation level- See Also:
- Constant Field Values
-
POTENTIAL_LOST_UPDATE
static final java.lang.String POTENTIAL_LOST_UPDATE
A lost update is possible. A transaction is attempting an update to a CMP entity bean. If another concurrently executing transaction is updating the same CMP entity bean, the updates of one transaction might overlay the updates of the other transaction.- See Also:
- Constant Field Values
-
UPDATE_ON_READONLY
static final java.lang.String UPDATE_ON_READONLY
An update is being attempted, but a read-only AccessIntent was specified. A transaction is attempting an update to a CMP entity bean and the bean was deployed using read-only AccessIntent.- See Also:
- Constant Field Values
-
POTENTIAL_DEADLOCK
static final java.lang.String POTENTIAL_DEADLOCK
A deadlock is possible. A transaction is attempting an update to a CMP entity bean. The bean is deployed using read-only AccessIntent and either JDBC repeatable read or JDBC serializable isolation level. If another transaction is storing the same CMP entity bean, a database deadlock can occur as a result of promotion of a read/share lock to a write/exclusive lock.- See Also:
- Constant Field Values
-
FIRST_TIME_CALLED
static final java.lang.String FIRST_TIME_CALLED
This string constant is to be used as a property name in the properties passed on theDataStoreHelper.doConnectionSetupPerTransaction()
.
The property is used to specify if thedoConnectionSetupPerTransaction()
is called for the first time, on the underlying physical connection, by WebSphere runtime.- See Also:
- Constant Field Values
-
SUBJECT
static final java.lang.String SUBJECT
Property key that specifies thejavax.security.auth.Subject
fordoConnectionSetupPerGetConnection
.- See Also:
- Constant Field Values
-
TX_REPEATABLE_READ_FORUPDATE
static final java.lang.String TX_REPEATABLE_READ_FORUPDATE
This string is needed for the extended-for-update support for some databases (e.g. DB2 390)- See Also:
- Constant Field Values
-
TX_SERIALIZABLE_FORUPDATE
static final java.lang.String TX_SERIALIZABLE_FORUPDATE
This string is needed for the extended-for-update support for some databases (e.g. DB2 390)- See Also:
- Constant Field Values
-
CLOUDSCAPE_HELPER
static final int CLOUDSCAPE_HELPER
Deprecated. DataStoreHelper.DERBY_HELPER should be used instead.This constant is used to identify theCloudscapeDataStoreHelper
type. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.CLOUDSCAPE_HELPER)
is configured when constructing theCloudscapeDataStoreHelper
.- See Also:
- Constant Field Values
-
CLOUDSCAPE_NETWORK_SERVER_HELPER
static final int CLOUDSCAPE_NETWORK_SERVER_HELPER
Deprecated. DataStoreHelper.DERBY_NETWORK_SERVER_HELPER should be used instead.This constant is used to identify theCloudscapeNetworkServerDataStoreHelper
type. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.CLOUDSCAPE_NETWORK_SERVER_HELPER)
is configured when constructing theCloudscapeNetworkServerDataStoreHelper
.- See Also:
- Constant Field Values
-
CUSTOM_HELPER
static final int CUSTOM_HELPER
Deprecated.This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
ORACLE_HELPER
static final int ORACLE_HELPER
Deprecated. This constant will be removed in a later release. Please use ORACLE_11G_HELPER instead.These constants are kept only for compatibility reasons.- See Also:
- Constant Field Values
-
ORACLE_10G_HELPER
static final int ORACLE_10G_HELPER
Deprecated. This constant will be removed in a later release. Please use ORACLE_11G_HELPER instead.These constants are kept only for compatibility reasons.- See Also:
- Constant Field Values
-
UNDEFINED_HELPER
static final int UNDEFINED_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
DB2_HELPER
static final int DB2_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
DB2_400_HELPER
static final int DB2_400_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
DB2_390_HELPER
static final int DB2_390_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
DB2_UNIVERSAL_HELPER
static final int DB2_UNIVERSAL_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
GENERIC_HELPER
static final int GENERIC_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
CONNECTJDBC_HELPER
static final int CONNECTJDBC_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
SYBASE_HELPER
static final int SYBASE_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
SYBASE11_HELPER
static final int SYBASE11_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
INFORMIX_HELPER
static final int INFORMIX_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
DB2_390_LOCAL_HELPER
static final int DB2_390_LOCAL_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
PROXY_DS_HELPER
static final int PROXY_DS_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
DERBY_NETWORK_SERVER_HELPER
static final int DERBY_NETWORK_SERVER_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
DERBY_HELPER
static final int DERBY_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
INFORMIX_JCC_HELPER
static final int INFORMIX_JCC_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
ORACLE_11G_HELPER
static final int ORACLE_11G_HELPER
This constant is used to identify the type ofDataStoreHelper
. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.DB2_HELPER)
is configured when constructing theDB2DataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
DATADIRECT_HELPER
static final int DATADIRECT_HELPER
Deprecated. Please use CONNECTJDBC_HELPER or MSSQL_HELPER instead.This constant is kept only for compatibility reasons.- See Also:
- Constant Field Values
-
SEQUELINK_HELPER
static final int SEQUELINK_HELPER
Deprecated. Please use CONNECTJDBC_HELPER or MSSQL_HELPER instead.This constant is kept only for compatibility reasons.- See Also:
- Constant Field Values
-
MSSQL_HELPER
static final int MSSQL_HELPER
This constant is used to identify the type ofDataStoreHelper
as the Microsoft SQL Server JDBC Driver. TheDataStoreHelperMetaData
HelperType property is configured to theDataStoreHelper
type constant of the correspondingDataStoreHelper
subclass. For example,setHelperType(DataStoreHelper.MSSQL_HELPER)
is configured when constructing theMicrosoftSQLServerDataStoreHelper
. When you define a customDataStoreHelper
, the HelperType will be set automatically by theDataStoreHelper
implementation class which you extend.- See Also:
- Constant Field Values
-
-
Method Detail
-
isDuplicateKey
boolean isDuplicateKey(java.sql.SQLException sqlX)
The application server invokes this method to determine whether or not the specified error indicates a duplicate key violation. The method is invoked regardless of the data source's error detection model.
- Parameters:
sqlX
- the error.- Returns:
- true if the error indicates a duplicate key violation, otherwise false.
-
mapException
java.sql.SQLException mapException(java.sql.SQLException e)
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 specifiedSQLException
to a correspondingcom.ibm.websphere.ce.cm.PortableSQLException
subclass. If no correspondingcom.ibm.websphere.ce.cm.PortableSQLException
subclass is found, theSQLException
is returned unchanged.- Parameters:
e
- aSQLException
.- Returns:
- a
com.ibm.websphere.ce.cm.PortableSQLException
subclass corresponding to the specifiedSQLException
, or the unchangedSQLException
if no match is found.
-
hasLostUpdateOrDeadLockOccurred
java.lang.String hasLostUpdateOrDeadLockOccurred(int isoLevel, boolean loadedForUpdate)
This method is invoked when storing a CMP EntityBean if pessimistic concurrency control is activated. This method determines whether a potential lost update or deadlock scenario has occurred. If so, this method returns an appropriate message ID. This information is passed on to the bean provider as notification that code changes are needed to avoid potential problems.pre-conditions
- pessimistic concurrency control is being used
- getAutoCommit() on the connection returns false
- Parameters:
isoLevel
- the transaction isolation level used.loadedForUpdate
-true
if the CMP EntityBean was loaded for update (eg. FOR UPDATE keywords used on SELECT), otherwise false.- Returns:
- One of the following
-
getIsolationLevel
int getIsolationLevel(AccessIntent intent) throws javax.resource.ResourceException
This method determines the transaction isolation level based on the specifiedAccessIntent
. If theAccessIntent
parameter is null, a default value that is appropriate for the database backend should be returned.WebSphere's default transaction isolation levels are:
- For Oracle and unsupported databases -
java.sql.Connection.TRANSACTION_READ_COMMITTED
- For all other supported databases -
java.sql.Connection.TRANSACTION_REPEATABLE_READ
- Parameters:
intent
- AnAccessIntent
- Returns:
- A transaction isolation level appropriate for the specified
AccessIntent
. - Throws:
javax.resource.ResourceException
- If a transaction isolation level cannot be determined from theAccessIntent
.
- For Oracle and unsupported databases -
-
getResultSetType
int getResultSetType(AccessIntent intent) throws javax.resource.ResourceException
This method determines the result set type based on the specifiedAccessIntent
. If theAccessIntent
parameter is null, the a default value ofjava.sql.ResultSet.FETCH_FORWARD
must be returned. Currently allDataStoreHelper
subclasses provided by WebSphere returnjava.sql.ResultSet.FETCH_FORWARD
.- Parameters:
intent
- AnAccessIntent
.- Returns:
- A result set type constant defined on
java.sql.ResultSet
. - Throws:
javax.resource.ResourceException
- If a result set type cannot be determined from theAccessIntent
.
-
getResultSetConcurrency
int getResultSetConcurrency(AccessIntent intent) throws javax.resource.ResourceException
This method determines the result set concurrency based on the specifiedAccessIntent
. If theAccessIntent
parameter is null, a default value ofjava.sql.ResultSet.CONCUR_READ_ONLY
must be returned.- Parameters:
intent
- AnAccessIntent
.- Returns:
- A result set concurrency constant defined on
java.sql.ResultSet
. - Throws:
javax.resource.ResourceException
- If a result set concurrency cannot be determined from theAccessIntent
.
-
doConnectionSetup
void doConnectionSetup(java.sql.Connection conn) throws java.sql.SQLException
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.
One example of where this method is useful is the following:
- The Informix JDBC driver requires that the
LOCK MODE
is configured according to theinformixLockModeWait
property.
The following actions are prohibited in this method:
- Changing any standard connection properties found on the
java.sql.Connection
API. This includes TransactionIsolationLevel, AutoCommit, Catalog, ReadOnly, TypeMap, and Holdability. - Closing the connection.
- Parameters:
conn
- the connection to set up.- Throws:
java.sql.SQLException
- if connection setup cannot be completed successfully.
- The Informix JDBC driver requires that the
-
isConnectionError
boolean isConnectionError(java.sql.SQLException ex)
This method determines whether aSQLException
indicates a fatal connection error based on the exception map for this data store helper.The application server uses this API to detect fatal connection errors.
- Parameters:
ex
- theSQLException
to check.- Returns:
- true if the exception indicates a fatal connection error, otherwise false.
-
doConnectionCleanup
boolean doConnectionCleanup(java.sql.Connection conn) throws java.sql.SQLException
This method is used to clean up a connection before it is returned to the connection pool for later reuse. WebSphere automatically resets all standard connection properties (fields for which getters and setters are defined on
java.sql.Connection
). This method can be used to reset other properties proprietary to a specific JDBC driver/database, preparing the connection for reuse.A
DataStoreHelper
is permitted to use the provided connection to create and execute statements for the purpose of cleaning up the connection. Any statements created within thedoConnectionCleanup
method must be explicitly closed within thedoConnectionCleanup
method. ThedoConnectionCleanup
method 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 to WebSphere that at least one standard connection property was modified. A value of false should be returned only if no standard connection properties were modified.
- Parameters:
conn
- the connection to attempt to cleanup.- Returns:
- true if any standard connection property was modified, otherwise false.
- Throws:
java.sql.SQLException
- If an error occurs while cleaning up the connection.
-
doConnectionCleanupWithValidCheck
boolean doConnectionCleanupWithValidCheck(java.sql.Connection conn) throws java.sql.SQLException
- Throws:
java.sql.SQLException
-
doStatementCleanup
void doStatementCleanup(java.sql.PreparedStatement stmt) throws java.sql.SQLException
This method cleans up a statement before the statement is placed in 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
The GenericDataStoreHelper implementation for this method resets all five of the properties listed above.
The following operations do not need to be included in the statement cleanup because 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 should never include closing the statement because the statement is intended to be cached.
- Parameters:
stmt
- the PreparedStatement.- Throws:
java.sql.SQLException
- if an error occurs cleaning up the statement.
-
getMetaData
DataStoreHelperMetaData getMetaData()
This method returns theDataStoreHelperMetaData
object associated with thisDataStoreHelper
.- Returns:
DataStoreHelperMetaData
-
getLockType
int getLockType(AccessIntent intent)
This method returns a lock type constant based on the update hint value of the specified AccessIntent. The lock type is used by the persistence manager to determine which locking hints are used on aSELECT
statement.- Parameters:
intent
- AnAccessIntent
- Returns:
- the lock type constant. Valid values are defined in
com.ibm.websphere.rsadaper.WSInteractionSpec
:LOCKTYPE_SELECT
LOCKTYPE_SELECT_FOR_UPDATE
LOCKTYPE_SELECT_FOR_UPDATE_WITH_RS
LOCKTYPE_SELECT_FOR_UPDATE_WITH_RR
-
setUserDefinedMap
void setUserDefinedMap(java.util.Map newmap)
This method configures a user-defined
SQLException
map that supersedes the defaultSQLException
mappings for theDataStoreHelper
. TheDataStoreHelper
implementations that are provided by the application server useSQLException
maps to detect connection errors that can end connections, as well as other specific types of errors. A customDataStoreHelper
can alter the default mappings by invoking this method. Do not invoke this method from a customDataStoreHelper
if you also configure theuserDefinedErrorMap
data source custom property. When you configure theuserDefinedErrorMap
custom data source property, 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
setUserDefinedMap
method: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
. This differs from the WAS 4.0 DataSource model where mapping by Error Code always takes precedence over mapping by SQL State.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
SQLException
is received with SQL State S1000 and Error Code 23505, the WebSphereDataStoreHelper
implementations map the exception toUserDefinedException
, whereas the WAS 4.0 DataSource map the exception toDuplicateKeyException
.Additionally, mapping done by the WebSphere
DataStoreHelper
s does not include mapping by chained exceptions when no match is found for the original exception.- Parameters:
newmap
- a mapping ofSQLException
SQL States and Error Codes tocom.ibm.websphere.ce.cm.PortableSQLException
subclasses. 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 aSQLException
as the single parameter.Void.class
may also be used for the value, in which case any existing mapping for the specified SQL State or Error Code is removed.
-
calcPartitionNumber
short calcPartitionNumber(java.lang.String fullTableName, java.util.Properties propPartKeys) throws javax.resource.ResourceException
This method allows you to calculate the partition number based on the input table name and partition key properties. This method is reserved for future use and is not currently called by WebSphere.- Parameters:
fullTableName
- - the fully qualified table name.propPartKeys
- - the partition key properties- Returns:
- a partition number.
- Throws:
javax.resource.ResourceException
- any exception that occurs during the calculation of a partition key will result in a ResourceException
-
getPrintWriter
java.io.PrintWriter getPrintWriter()
This method is used to obtain thejava.io.PrintWriter
to use for logging when database logging is enabled (for example:WAS.database=all=enabled
). By default, null is returned and ajava.io.PrintWriter
instance created by WebSphere is used. You can override this method to return a differentjava.io.PrintWriter
instance instead of the default.- Returns:
java.io.PrintWriter
.- Since:
- WAS 5.0.1
-
getXAExceptionContents
java.lang.String getXAExceptionContents(javax.transaction.xa.XAException xae)
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. WebSphere uses this method to obtain trace information forXAException
s to include in WebSphere trace.- Parameters:
xae
- theXAException
.- Returns:
- detailed information about the
XAException
, for inclusion in a WebSphere trace. - Since:
- WAS 5.0.2
-
modifyXAFlag
int modifyXAFlag(int xaflag)
This method is used only when the
transactionBranchesLooselyCoupled
custom DataSource property is set to true. This method modifies the given XA start flag. Some databases, such as Oracle, require a proprietary flag, such asOracleXAResource.ORATRANSLOOSE
.Among the
DataStoreHelper
subclasses provided by WebSphere, this method is a no-op for every backend except for Oracle.- Parameters:
xaflag
- The XA start flag to modify.- Returns:
- The modified XA start flag.
- Since:
- WAS 5.0.1
-
isBatchUpdateSupportedWithAccessIntent
boolean isBatchUpdateSupportedWithAccessIntent(AccessIntent accessIntent)
This method is used to determine if CMP Entity Beans can support batch updates with the given AccessIntent. There are some AccessIntents (for example, WebSphere Optimistic Concurrency Control intent) for which some databases are not always capable of determining the number of updated rows. This prevents CMP Entity Beans from being able to support batch updates. In such cases, this method must return false.- Parameters:
accessIntent
- AccessIntent- Returns:
- boolean true if batching is allowed with the given AccessIntent, otherwise false.
- Since:
- WAS 5.0.2
-
doConnectionSetupPerTransaction
void doConnectionSetupPerTransaction(javax.security.auth.Subject sub, java.lang.String user, java.sql.Connection conn, boolean reauthRequired, java.lang.Object properties) throws java.sql.SQLException
This method is invoked by WebSphere runtime 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.
Implementation of this method is required if the "reauthentication" datasource custom property is set to true or if "enable reauthentication checkbox" is checked. Failure to do so might result in unpredictable behavior.
This method is not only limited to user reauthentication; users can also take advantage of this method in other situations. For example:
- altering the identity for audit purposes
- altering the target schema
java.sql.Connection
properties.
Note also that users might need to implement the doConnectionCleanup() method to reset thejava.sql.Connection
to the original state prior to callingdoConnectionSetupPerTransaction
Note also that WebSphere runtime will passjava.util.Properties
object which contains a propertyDataStoreHelper.FIRST_TIME_CALLED
. TheDataStoreHelper.FIRST_TIME_CALLED
is set to true when thedoConnectionSetupPerTransaction
is called by WebSphere runtime for the first time for any WebSphere connection. TheDataStoreHelper.FIRST_TIME_CALLED
is set to false thereafter.- Parameters:
sub
- javax.security.auth.Subject for the newly requested connection. This value is null unlessres-auth
is 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.lang.Object WebSphere runtime passesjava.util.Properties
when calling this method- Throws:
java.sql.SQLException
- if connection throws an exception.
-
doConnectionSetupPerGetConnection
boolean doConnectionSetupPerGetConnection(java.sql.Connection conn, boolean isCMP, java.lang.Object props) throws java.sql.SQLException
This method is invoked by WebSphere Application Server runtime before a connection handle is provided to the application. This method is called by WebSphere Application Server runtime 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 dealing with CMP, where 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.- Parameters:
conn
- java.sql.Connection the underlying database physical connectionisCMP
- boolean: specifies if the connection is used for a CMP request or another type of request.props
- Map<String,Object> containing additional properties. The keyDataStoreHelper.SUBJECT
maps to thejavax.security.auth.Subject
if 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:
java.sql.SQLException
-
doConnectionCleanupPerCloseConnection
boolean doConnectionCleanupPerCloseConnection(java.sql.Connection conn, boolean isCMP, java.lang.Object props) throws java.sql.SQLException
This method is invoked by WebSphere Application Server runtime immediately after a connection handle is closed by the application or implicitly by WebSphere Application Server runtime. If you override thedoConnectionSetupPerGetConnection
method to perform connection setup, then you must override this method to undo all connection setup done in thedoConnectionSetupPerGetConnection
method.
This method is called by WebSphere Application Server runtime 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.- Parameters:
conn
- java.sql.Connection the underlying database physical connectionisCMP
- boolean: specifies if the connection is used for a CMP request or another type of request.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:
java.sql.SQLException
-
getPasswordForUseWithTrustedContextWithAuthentication
java.lang.String getPasswordForUseWithTrustedContextWithAuthentication(java.lang.String identityname, java.lang.String realm) throws java.sql.SQLException
The application server invokes this method at run time to get the password that the application server will use to establish a trusted connection using the DB2 TrustedContext "with authentication" option or when the application server switches a trusted connection to another identity, and the "with authentication" option is enabled. The password that is returned by this method will not be stored locally in the application server.
Be aware that the application server will call this method to get the password for trusted context usage if the following is true:
- You set the useTrustedContextWithAuthentication data source custom property to true.
- You use the TrustedConnectionMapping login configuration.
- Parameters:
identityname
- String: the identity of the connection to which the application server is switching and for which password is needed.realm
- String: the realm name that is being used that can determine the identity of the user.- Returns:
- String password that will be used when switching trusted context identity to the specified user.
- Throws:
java.sql.SQLException
-
isTransientConnectionError
boolean isTransientConnectionError(java.sql.SQLException ex)
This method determines whether aSQLException
indicates a transient connection error. That means the current SQL operation can be retried on the existing connection, if the method returns true. Currently, implementation of this method is limited to JDBC 4.0 compliant drivers.- Parameters:
ex
- theSQLException
to check.- Returns:
- true if the exception indicates a transient connection error, otherwise false.
- See Also:
SQLException
-
-