|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The DataStoreHelper
interface allows users to plug in datastore-specific
functionality required by the Relational
Resource Adapter runtime. WebSphere provides a DataStoreHelper
implementation
for each supported JDBC provider. In addition, WebSphere provides a
GenericDataStoreHelper
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 DataStoreHelper
implementations are
required to inherit from the
GenericDataStoreHelper
class, as WebSphere does not support direct
implementation of the DataStoreHelper
interface.
New releases of WebSphere might involve changes to the DataStoreHelper
interface. These changes are picked up automatically by custom
helpers only if they inherit from GenericDataStoreHelper
. Custom helpers
that do not inherit from GenericDataStoreHelper
might encounter compile
problems and runtime errors.
GenericDataStoreHelper
Field Summary | |
---|---|
static int |
CLOUDSCAPE_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
CLOUDSCAPE_NETWORK_SERVER_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
CONNECTJDBC_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
CUSTOM_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
DATADIRECT_HELPER
Deprecated. Please use the Connect JDBC DataStoreHelper instead. |
static int |
DB2_390_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
DB2_390_LOCAL_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
DB2_400_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
DB2_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
DB2_UNIVERSAL_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
GENERIC_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
INFORMIX_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
MSSQL_HELPER
Deprecated. Please use the Connect JDBC DataStoreHelper instead. |
static int |
ORACLE_HELPER
This constant is used to identify the type of DataStoreHelper . |
static java.lang.String |
POTENTIAL_DEADLOCK
A deadlock is possible. |
static java.lang.String |
POTENTIAL_LOST_UPDATE
A lost update is possible. |
static int |
SEQUELINK_HELPER
Deprecated. Please use the Connect JDBC DataStoreHelper instead. |
static int |
SYBASE_HELPER
This constant is used to identify the type of DataStoreHelper . |
static int |
SYBASE11_HELPER
This constant is used to identify the type of DataStoreHelper . |
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 java.lang.String |
UPDATE_ON_READONLY
An update is being attempted, but a read-only AccessIntent was specified. |
static int |
WSCONNECTJDBC_HELPER
This constant is used to identify the type of DataStoreHelper . |
Method Summary | |
---|---|
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. |
void |
doConnectionSetup(java.sql.Connection conn)
This method configures a connection before first use. |
void |
doStatementCleanup(java.sql.PreparedStatement stmt)
This method cleans up a statement before the statement is placed in the statement cache. |
int |
getIsolationLevel(com.ibm.websphere.appprofile.accessintent.AccessIntent intent)
This method determines the transaction isolation level based on the specified AccessIntent . |
int |
getLockType(com.ibm.websphere.appprofile.accessintent.AccessIntent intent)
This method returns a lock type constant based on the update hint value of the specified AccessIntent. |
DataStoreHelperMetaData |
getMetaData()
This method returns the DataStoreHelperMetaData object associated
with this DataStoreHelper . |
java.io.PrintWriter |
getPrintWriter()
This method is used to obtain the java.io.PrintWriter to use for logging
when database logging is enabled (for example: WAS.database=all=enabled ). |
int |
getResultSetConcurrency(com.ibm.websphere.appprofile.accessintent.AccessIntent intent)
This method determines the result set concurrency based on the specified AccessIntent . |
int |
getResultSetType(com.ibm.websphere.appprofile.accessintent.AccessIntent intent)
This method determines the result set type based on the specified AccessIntent . |
java.lang.String |
getXAExceptionContents(javax.transaction.xa.XAException xae)
This method provides a plug-in point for providing meaningful logging information for an XAException . |
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(com.ibm.websphere.appprofile.accessintent.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 a SQLException indicates a
fatal connection error. |
com.ibm.ws.rsadapter.exceptions.DataStoreAdapterException |
mapException(com.ibm.ws.rsadapter.exceptions.DataStoreAdapterException e)
Deprecated. |
java.sql.SQLException |
mapException(java.sql.SQLException e)
This method maps the specified SQLException to a corresponding
com.ibm.websphere.ce.cm.PortableSQLException subclass. |
int |
modifyXAFlag(int xaflag)
This method is used only when the transactionBranchesLooselyCoupled
custom DataSource property is set to true. |
void |
processGenericCredentials(javax.resource.spi.security.GenericCredential credential)
This method processes Generic Credentials authentication for a specific database. |
java.lang.String |
processSQL(java.lang.String sqlString,
int isolevel)
Deprecated. : please don't implement this method. |
java.lang.String |
processSQL(java.lang.String sqlString,
int isolevel,
boolean addForUpdate,
boolean addExtendedforUpdateSyntax)
Deprecated. please don't implement this method. |
void |
setUserDefinedMap(java.util.Map newmap)
This method configures a user-defined SQLException map that supersedes
default SQLException mappings for the DataStoreHelper . |
Field Detail |
public static final java.lang.String POTENTIAL_LOST_UPDATE
public static final java.lang.String UPDATE_ON_READONLY
public static final java.lang.String POTENTIAL_DEADLOCK
public static final java.lang.String TX_REPEATABLE_READ_FORUPDATE
public static final java.lang.String TX_SERIALIZABLE_FORUPDATE
public static final int CUSTOM_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int CLOUDSCAPE_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int DB2_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int DB2_400_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int DB2_390_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int DB2_UNIVERSAL_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int GENERIC_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int CONNECTJDBC_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int WSCONNECTJDBC_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int SYBASE_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int SYBASE11_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int ORACLE_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int INFORMIX_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int DB2_390_LOCAL_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int CLOUDSCAPE_NETWORK_SERVER_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int DATADIRECT_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int SEQUELINK_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
public static final int MSSQL_HELPER
DataStoreHelper
.
The DataStoreHelperMetaData
HelperType property is configured to the
DataStoreHelper
type constant of the corresponding
DataStoreHelper
subclass.
For example, setHelperType(DataStoreHelper.DB2_HELPER)
is configured when
constructing the DB2DataStoreHelper
. When you define a custom
DataStoreHelper
, configure the DataStoreHelperMetaData
HelperType to CUSTOM_HELPER
. To do this, invoke the
following method on the DataStoreHelperMetaData
from the custom
DataStoreHelper
constructor:
setHelperType(DataStoreHelper.CUSTOM_HELPER);
Method Detail |
public java.sql.SQLException mapException(java.sql.SQLException e)
SQLException
to a corresponding
com.ibm.websphere.ce.cm.PortableSQLException
subclass.
If no corresponding com.ibm.websphere.ce.cm.PortableSQLException
subclass
is found, the SQLException
is returned unchanged.
e
- a SQLException
.
com.ibm.websphere.ce.cm.PortableSQLException
subclass
corresponding to the specified SQLException
, or the unchanged
SQLException
if no match is found.SQLException
,
PortableSQLException
public com.ibm.ws.rsadapter.exceptions.DataStoreAdapterException mapException(com.ibm.ws.rsadapter.exceptions.DataStoreAdapterException e)
This method maps the SQLException
contained in the input
DataStoreAdapterException
to a matching WebSphere
PortableSQLException
subclass.
public java.lang.String hasLostUpdateOrDeadLockOccurred(int isoLevel, boolean loadedForUpdate)
pre-conditions
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.
public void processGenericCredentials(javax.resource.spi.security.GenericCredential credential) throws javax.resource.ResourceException
credential
- The generic credential that is used to get the user name and password from the
java.sql.Connection.
javax.resource.ResourceException
- Any errors while processing the generic credential authentication
will result in throwing this exception. The original SQLException or native Exception
is chained to this Exception.public int getIsolationLevel(com.ibm.websphere.appprofile.accessintent.AccessIntent intent) throws javax.resource.ResourceException
AccessIntent
.
If the AccessIntent
parameter is null, a default value that is appropriate
for the database backend should be returned.
WebSphere's default transaction isolation levels are:
java.sql.Connection.TRANSACTION_READ_COMMITTED
java.sql.Connection.TRANSACTION_REPEATABLE_READ
intent
- An AccessIntent
AccessIntent
.
javax.resource.ResourceException
- If a transaction isolation level cannot be determined
from the AccessIntent
.AccessIntent
,
Connection
public int getResultSetType(com.ibm.websphere.appprofile.accessintent.AccessIntent intent) throws javax.resource.ResourceException
AccessIntent
.
If the AccessIntent
parameter is null, the a default value of
java.sql.ResultSet.FETCH_FORWARD
must be returned.
Currently all DataStoreHelper
subclasses provided by WebSphere return
java.sql.ResultSet.FETCH_FORWARD
.
intent
- An AccessIntent
.
java.sql.ResultSet
.
javax.resource.ResourceException
- If a result set type cannot be determined from
the AccessIntent
.AccessIntent
,
ResultSet
public int getResultSetConcurrency(com.ibm.websphere.appprofile.accessintent.AccessIntent intent) throws javax.resource.ResourceException
AccessIntent
.
If the AccessIntent
parameter is null, a default value of
java.sql.ResultSet.CONCUR_READ_ONLY
must be returned.
intent
- An AccessIntent
.
java.sql.ResultSet
.
javax.resource.ResourceException
- If a result set concurrency cannot be determined
from the AccessIntent
.AccessIntent
,
ResultSet
public 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.
Some examples of where this method is useful are the following:
LOCK MODE
is configured
according to the informixLockModeWait
property.
The following actions are prohibited in this method:
java.sql.Connection
API. This includes TransactionIsolationLevel,
AutoCommit, Catalog, ReadOnly, TypeMap, and Holdability.
conn
- the connection to set up.
java.sql.SQLException
- if connection setup cannot be completed successfully.public boolean isConnectionError(java.sql.SQLException ex)
SQLException
indicates a
fatal connection error.
ex
- the SQLException
to check.
SQLException
public 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 the doConnectionCleanup
method must be explicitly closed
within the doConnectionCleanup
method. The
doConnectionCleanup
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.
conn
- the connection to attempt to cleanup.
java.sql.SQLException
- If an error occurs while cleaning up the connection.Connection
public 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,
The GenericDataStoreHelper implementation for this method resets all six 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.
stmt
- the PreparedStatement.
java.sql.SQLException
- if an error occurs cleaning up the statement.public DataStoreHelperMetaData getMetaData()
DataStoreHelperMetaData
object associated
with this DataStoreHelper
.
DataStoreHelperMetaData
public int getLockType(com.ibm.websphere.appprofile.accessintent.AccessIntent intent)
SELECT
statement.
intent
- An AccessIntent
com.ibm.websphere.rsadaper.WSInteractionSpec
:
LOCKTYPE_SELECT
LOCKTYPE_SELECT_FOR_UPDATE
LOCKTYPE_SELECT_FOR_UPDATE_WITH_RS
LOCKTYPE_SELECT_FOR_UPDATE_WITH_RR
public void setUserDefinedMap(java.util.Map newmap)
This method configures a user-defined SQLException
map that supersedes
default SQLException
mappings for the DataStoreHelper
. The
DataStoreHelper
implementations provided by WebSphere use
SQLException
maps to detect fatal connection errors, as well as other
specific types of connection errors. A custom DataStoreHelper
can alter
the default mappings by invoking this method. Invoke this method only from
DataStoreHelper
classes subclassing this class. Do not invoke
this method directly from application code. Internal WebSphere code does
not invoke this method.
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 WebSphere DataStoreHelper
implementations
map the exception to UserDefinedException
,
whereas the WAS 4.0 DataSource map the exception to DuplicateKeyException
.
Additionally, mapping done by the WebSphere DataStoreHelper
s does not
include mapping by chained exceptions when no match is found for the original exception.
newmap
- a mapping of SQLException
SQL States and Error Codes to
com.ibm.websphere.ce.cm.PortableSQLException
subclasses.
The key for the Map must be a String
(representing the SQL State) or
an Integer
(representing the Error Code). The value for the Map must
be a subclass of com.ibm.websphere.ce.cm.PortableSQLException
.
User-defined subclasses are permitted, but are required to declare a public
constructor accepting a SQLException
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.SQLException
,
PortableSQLException
public short calcPartitionNumber(java.lang.String fullTableName, java.util.Properties propPartKeys) throws javax.resource.ResourceException
fullTableName
- - the fully qualified table name.propPartKeys
- - the partition key properties
javax.resource.ResourceException
- any exception that occurs during the calculation of a partition key will result in a
ResourceExceptionpublic java.io.PrintWriter getPrintWriter()
java.io.PrintWriter
to use for logging
when database logging is enabled (for example: WAS.database=all=enabled
).
By default, null is returned and a java.io.PrintWriter
instance created
by WebSphere is used. You can override this method to return a different
java.io.PrintWriter
instance instead of the default.
java.io.PrintWriter
.public java.lang.String getXAExceptionContents(javax.transaction.xa.XAException xae)
XAException
. The information can include details of the original
exception that caused the XAException
, if applicable.
WebSphere uses this method to obtain trace information for
XAException
s to include in WebSphere trace.
xae
- the XAException
.
XAException
, for inclusion in
a WebSphere trace.XAException
public 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 as
OracleXAResource.ORATRANSLOOSE
.
Among the DataStoreHelper
subclasses provided by WebSphere,
this method is a no-op for every backend except for Oracle.
xaflag
- The XA start flag to modify.
XAResource
public boolean isBatchUpdateSupportedWithAccessIntent(com.ibm.websphere.appprofile.accessintent.AccessIntent accessIntent)
accessIntent
- AccessIntent
AccessIntent
public java.lang.String processSQL(java.lang.String sqlString, int isolevel)
sqlString
- the sql string to be modifiedisolevel
- The isolation level of the connection
public java.lang.String processSQL(java.lang.String sqlString, int isolevel, boolean addForUpdate, boolean addExtendedforUpdateSyntax)
sqlString
- String: SQLString to be modifiedisolevel
- int: Isolation level, which is used in the case of the db2/390 to determine what the added syntax should beaddForUpdate
- boolean: if true means the equivalent syntax of "FOR UPDATE" to the sqlString will be added
if forUpdate is true, i am guaranteed that the there is no "for update" in the string alreadyaddExtendedforUpdateSyntax
- boolean: if true means the extended-for-update syntax (if applicable) will be added.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |