IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.rsadapter
Class Oracle11gDataStoreHelper

java.lang.Object
  extended by com.ibm.websphere.rsadapter.GenericDataStoreHelper
      extended by com.ibm.websphere.rsadapter.OracleDataStoreHelper
          extended by com.ibm.websphere.rsadapter.Oracle10gDataStoreHelper
              extended by com.ibm.websphere.rsadapter.Oracle11gDataStoreHelper
All Implemented Interfaces:
DataStoreHelper

public class Oracle11gDataStoreHelper
extends Oracle10gDataStoreHelper

Oracle11gDataStoreHelper is a DataStoreHelper implementation customized for the Oracle 11g database.

If you have additional requirements on Oracle11g you should consider subclassing this implementation.

Note: This class and its methods can not be called or referenced directly by user applications.

Note: Custom helpers that extend this class can override or call any methods documented for this class. Customer helpers should not bypass methods provided by this class by directly calling methods on the Oracle10gDataStoreHelper or the OracleDataStoreHelper. These classes will be not be inherited by this class in a future release. This class continues to inherit GenericDataStoreHelper and the methods and constants from that class and the DataStoreHelper interface can be overridden or used directly.

When mapping a SQLException, the SQLException mappings from the Oracle11gDataStoreHelper are searched first, and subsequently, if no match is found, the SQLException mappings from the GenericDataStoreHelper are searched.

SQLException mappings specific to the Oracle11gDataStoreHelper are the following:

Error CodeSQL StatePortableSQLException subclass
1DuplicateKeyException.class
20StaleConnectionException.class
28StaleConnectionException.class
1012StaleConnectionException.class
1014StaleConnectionException.class
1033StaleConnectionException.class
1034StaleConnectionException.class
1035StaleConnectionException.class
1089StaleConnectionException.class
1090StaleConnectionException.class
1092StaleConnectionException.class
3113StaleConnectionException.class
3114StaleConnectionException.class
12505StaleConnectionException.class
12541StaleConnectionException.class
12560StaleConnectionException.class
12571StaleConnectionException.class
17002StaleConnectionException.class
17008StaleConnectionException.class
17009StaleConnectionException.class
17410StaleConnectionException.class
17401StaleConnectionException.class
17430StaleConnectionException.class
25408StaleConnectionException.class
24794StaleConnectionException.class
17447StaleConnectionException.class


Field Summary
 
Fields inherited from class com.ibm.websphere.rsadapter.GenericDataStoreHelper
customDefinedWasDefaultIsoLevel, defaultQueryTimeout, EOLN, genErrorMap, resBundle, tranErrorList
 
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
Oracle11gDataStoreHelper(java.util.Properties props)
          This Oracle11gDataStoreHelper constructor creates a new Oracle11gDataStoreHelper based on the DataStoreHelper properties provided.
 
Method Summary
 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 doStatementCleanup(java.sql.PreparedStatement stmt)
          This method cleans up a statement before it is returned to the statement cache.
 java.lang.Class findMappingClass(java.sql.SQLException e)
          This method locates the com.ibm.websphere.ce.cm.PortableSQLException subclass corresponding to the specified SQLException, as defined by the Oracle11gDataStoreHelper, GenericDataStoreHelper, and user-defined SQLException maps.
 int getIsolationLevel(AccessIntent aIntent)
          This method determines the transaction isolation level based on the specified AccessIntent.
 int getLockType(AccessIntent intent)
          This method returns a lock type constant based on the update hint value of the specified AccessIntent.
 int getResultSetConcurrency(AccessIntent intent)
          This method determines the result set concurrency 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(AccessIntent accessIntent)
          This method is used to determine if CMP Entity Beans can support batch updates with the given AccessIntent.
 int modifyXAFlag(int xaflag)
          This method is used only when the transactionBranchesLooselyCoupled custom DataSource property is set to true.
 java.lang.String showLockInfo(java.util.Properties props)
          This method returns lock information for Oracle.
 
Methods inherited from class com.ibm.websphere.rsadapter.GenericDataStoreHelper
calcPartitionNumber, doConnectionCleanupPerCloseConnection, doConnectionSetup, doConnectionSetupPerGetConnection, doConnectionSetupPerTransaction, getMetaData, getPasswordForUseWithTrustedContextWithAuthentication, getPrintWriter, getResultSetType, isConnectionError, isDuplicateKey, isTransientConnectionError, mapException, setUserDefinedMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Oracle11gDataStoreHelper

public Oracle11gDataStoreHelper(java.util.Properties props)

This Oracle11gDataStoreHelper constructor creates a new Oracle11gDataStoreHelper based on the DataStoreHelper properties 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.

The DataStoreHelper properties for Oracle11gDataStoreHelper include a property, dataSourceClass, set to the Oracle JDBC driver's DataSource implementation class name.

Parameters:
props - DataStoreHelper properties.
Method Detail

doStatementCleanup

public void doStatementCleanup(java.sql.PreparedStatement stmt)
                        throws java.sql.SQLException

This method cleans up a statement before it is returned to the statement cache. This method is called only for statements that will be cached. It is called only if at least one of the following statement APIs was invoked. Each method in the table shows what it will be set to when the statement is returned to the cache.

Oracle11gDataStoreHelper resets all of the statement properties listed below.

method origin setter method value reset to
JDBC setFetchDirection ResultSet.FETCH_FORWARD
JDBC setMaxFieldSize 0
JDBC setMaxRows 0
JDBC setQueryTimeout 0
Oracle defineColumnType OracleStatement.clearDefines()
Oracle defineColumnTypeBytes OracleStatement.clearDefines()
Oracle defineColumnTypeChars OracleStatement.clearDefines()
Oracle setRowPrefetch OracleConnection.getDefaultRowPrefetch()
Oracle setLobPrefetchSize (For JDBC drivers >= 11.2.0.1) 4000

The following operations do not need to be included in the statement cleanup since they are automatically performed by WebSphere Application Server when caching statements,

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:
doStatementCleanup in interface DataStoreHelper
Overrides:
doStatementCleanup in class OracleDataStoreHelper
Parameters:
stmt - the PreparedStatement to clean up
Throws:
java.sql.SQLException - if an error occurs cleaning up the statement.

getResultSetConcurrency

public int getResultSetConcurrency(AccessIntent intent)
                            throws javax.resource.ResourceException
This method determines the result set concurrency based on the specified AccessIntent. Oracle11gDataStoreHelper returns java.sql.ResultSet.CONCUR_UPDATABLE if the access type of the AccessIntent is AccessIntent.ACCESS_TYPE_UPDATE, and otherwise java.sql.ResultSet.CONCUR_READ_ONLY. Note, however, that for performance reasons, this method will always return java.sql.ResultSet.CONCUR_READ_ONLY

Specified by:
getResultSetConcurrency in interface DataStoreHelper
Overrides:
getResultSetConcurrency in class Oracle10gDataStoreHelper
Parameters:
intent - An AccessIntent.
Returns:
A result set concurrency constant defined on java.sql.ResultSet.
Throws:
javax.resource.ResourceException - If a result set concurrency cannot be determined from the AccessIntent.

getIsolationLevel

public int getIsolationLevel(AccessIntent aIntent)
                      throws javax.resource.ResourceException
This method determines the transaction isolation level based on the specified AccessIntent. If the AccessIntent parameter is null, a default value is returned that is appropriate for the database backend. The default transaction isolation level for Oracle11gDataStoreHelper is Connection.TRANSACTION_READ_COMMITTED.

In the case where an AccessIntent is specified, Oracle11gDataStoreHelper computes the transation isolation level from the following table based on the pessimistic update lock hint.

pessimistic update lock hint transaction isolation level
AccessIntent.PESSIMISTIC_UPDATE_LOCK_HINT_NONE
AccessIntent.PESSIMISTIC_UPDATE_LOCK_HINT_WEAKEST_LOCK_AT_LOAD
AccessIntent.PESSIMISTIC_UPDATE_LOCK_HINT_NOCOLLISION
Connection.TRANSACTION_READ_COMMITTED
AccessIntent.PESSIMISTIC_UPDATE_LOCK_HINT_EXCLUSIVE Connection.TRANSACTION_SERIALIZABLE

Specified by:
getIsolationLevel in interface DataStoreHelper
Overrides:
getIsolationLevel in class Oracle10gDataStoreHelper
Parameters:
aIntent - An AccessIntent
Returns:
A transaction isolation level appropriate for the specified AccessIntent.
Throws:
javax.resource.ResourceException - If a transaction isolation level cannot be determined from the AccessIntent.

doConnectionCleanup

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.

If the Oracle connection has a proxy session associated with it, the proxy session is closed.

Specified by:
doConnectionCleanup in interface DataStoreHelper
Overrides:
doConnectionCleanup in class OracleDataStoreHelper
Parameters:
conn - The Connection to clean up.
Returns:
true if the cleanup was successful.
Throws:
SQLException - The clean up of the Oracle connection failed.
java.sql.SQLException - If an error occurs while cleaning up the connection.

findMappingClass

public final java.lang.Class findMappingClass(java.sql.SQLException e)

This method locates the com.ibm.websphere.ce.cm.PortableSQLException subclass corresponding to the specified SQLException, as defined by the Oracle11gDataStoreHelper, GenericDataStoreHelper, and user-defined SQLException maps. Precedence and related details of SQLException mapping are described on the DataStoreHelper.setUserDefinedMap method.

Overriding this method is one of three options you have for modifying SQLException mapping. The other two options are overriding the mapException method and invoking the setUserDefinedMap method to add a user-defined SQLException map.

Overrides:
findMappingClass in class OracleDataStoreHelper
Parameters:
e - The SQLException for which to locate a com.ibm.websphere.ce.cm.PortableSQLException subclass.
Returns:
The com.ibm.websphere.ce.cm.PortableSQLException subclass matching the SQLException, or null if no match was found.

hasLostUpdateOrDeadLockOccurred

public 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 to provide notification that code changes are needed to avoid potential problems.

pre-conditions

Specified by:
hasLostUpdateOrDeadLockOccurred in interface DataStoreHelper
Overrides:
hasLostUpdateOrDeadLockOccurred in class OracleDataStoreHelper
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
  1. DataStoreHelper.POTENTIAL_LOST_UPDATE
  2. DataStoreHelper.UPDATE_ON_READONLY
  3. DataStoreHelper.POTENTIAL_DEADLOCK

getLockType

public 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 a SELECT statement.

Oracle11gDataStoreHelper returns WSInteractionSpec.LOCKTYPE_SELECT_FOR_UPDATE if the AccessIntent is null or if all of the following are true:

  1. The access type of the AccessIntent is AccessIntent.ACCESS_TYPE_UPDATE.
  2. The concurrency control of the AccessIntent is AccessIntent.CONCURRENCY_CONTROL_PESSIMISTIC.
  3. The pessimistic update lock hint of the AccessIntent is AccessIntent.PESSIMISTIC_UPDATE_LOCK_HINT_NOCOLLISION.

In all other cases, WSInteractionSpec.LOCKTYPE_SELECT is returned.

Specified by:
getLockType in interface DataStoreHelper
Overrides:
getLockType in class OracleDataStoreHelper
Parameters:
intent - An AccessIntent
Returns:
the lock type constant. Valid values are defined in com.ibm.websphere.rsadapter.WSInteractionSpec:
  • LOCKTYPE_SELECT
  • LOCKTYPE_SELECT_FOR_UPDATE

getXAExceptionContents

public java.lang.String getXAExceptionContents(javax.transaction.xa.XAException xae)
This method provides a plug-in point for providing meaningful logging information for an 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 XAExceptions to include in WebSphere trace.

Specified by:
getXAExceptionContents in interface DataStoreHelper
Overrides:
getXAExceptionContents in class OracleDataStoreHelper
Parameters:
xae - the XAException.
Returns:
detailed information about the XAException, for inclusion in a WebSphere trace.

modifyXAFlag

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, adding the proprietary Oracle flag, OracleXAResource.ORATRANSLOOSE.

Specified by:
modifyXAFlag in interface DataStoreHelper
Overrides:
modifyXAFlag in class OracleDataStoreHelper
Parameters:
xaflag - The XA start flag to modify.
Returns:
The modified XA start flag.

isBatchUpdateSupportedWithAccessIntent

public 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. Oracle11gDataStoreHelper returns false if the concurrency control of the AccessIntent is AccessIntent.CONCURRENCY_CONTROL_OPTIMISTIC, and otherwise returns true.

Specified by:
isBatchUpdateSupportedWithAccessIntent in interface DataStoreHelper
Overrides:
isBatchUpdateSupportedWithAccessIntent in class OracleDataStoreHelper
Parameters:
accessIntent - AccessIntent
Returns:
boolean true if batching is allowed with the given AccessIntent, otherwise false.

showLockInfo

public final java.lang.String showLockInfo(java.util.Properties props)
                                    throws java.lang.Exception
This method returns lock information for Oracle. The props parameter may include the following properties:

  1. user - a user name that has a DBA authority. If not specified, a default value of null is used.
  2. password - the password corresponding to the user name. If not specified, a default value of null is used.
  3. URL - the Oracle URL from which JDBC connections are obtained. For example, jdbc:oracle:thin://@hostname:1521/dbname

Overrides:
showLockInfo in class OracleDataStoreHelper
Parameters:
props - properties containing information needed to connect to the database.
Returns:
the lock information for Oracle.
Throws:
java.lang.Exception - if an error occurs while collecting the lock information.

IBM WebSphere Application ServerTM
Release 8