com.ibm.websphere.rsadapter

Class ConnectJDBCDataStoreHelper

  • All Implemented Interfaces:
    DataStoreHelper

    public class ConnectJDBCDataStoreHelper
extends com.ibm.websphere.rsadapter.DataDirectDataStoreHelper
    ConnectJDBCDataStoreHelper is a DataStoreHelper implementation customized for the DataDirect Technologies Connect JDBC driver.

    SQLException mappings specific to the ConnectJDBCDataStoreHelper are the following:

    Error CodeSQL StatePortableSQLException subclass
    230StaleConnectionException.class
    2627DuplicateKeyException.class
    2217StaleConnectionException.class
    2251StaleConnectionException.class
    2306StaleConnectionException.class
    2310StaleConnectionException.class
    2311StaleConnectionException.class
    08000StaleConnectionException.class
    08002StaleConnectionException.class
    08004StaleConnectionException.class
    08007StaleConnectionException.class
    40003Void.class
    S1000Void.class
    If you have additional requirements on the Connect JDBC driver you should consider subclassing this implementation.
    Note: This class and its methods can not be called or referenced directly by user applications.

    • Constructor Detail

      • ConnectJDBCDataStoreHelper

        public ConnectJDBCDataStoreHelper(java.util.Properties props)
        This ConnectJDBCDataStoreHelper constructor creates a new ConnectJDBCDataStoreHelper 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.
        Parameters:
        props - DataStoreHelper properties.

    • Method Detail

      • 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. WebSphere automatically resets all standard connection properties (fields for which getters and setters are defined on java.sql.Connection). This method may be used to reset other properties proprietary to a specific JDBC driver/database and do whatever else is necessary to prepare the connection for reuse.

        A 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 is returned only if no standard connection properties were modified.

        ConnectJDBCDataStoreHelper resets the network timeout to 0.

        Specified by:
        doConnectionCleanup in interface DataStoreHelper
        Overrides:
        doConnectionCleanup in class GenericDataStoreHelper
        Parameters:
        conn - the connection to attempt to clean up.
        Returns:
        true if any standard connection property was modified, otherwise false.
        Throws:
        java.sql.SQLException - If an error occurs while cleaning up the connection.

      • doStatementCleanup

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

        This method cleans up a statement before the statement 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 properties has changed,

        • cursorName
        • fetchDirection
        • longDataCacheSize
        • maxFieldSize
        • maxRows
        • queryTimeout

        ConnectJDBCDataStoreHelper resets all of the statement properties listed above except for the cursorName property.

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

        • setFetchSize(0)
        • clearParameters()
        • clearWarnings()

        A helper class implementing this method 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 GenericDataStoreHelper
        Parameters:
        stmt - the PreparedStatement.
        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. ConnectJDBCDataStoreHelper returns java.sql.ResultSet.CONCUR_UPDATABLE if the access type of the AccessIntent is AccessIntent.ACCESS_TYPE_UPDATE and the concurrency control is AccessIntent.CONCURRENCY_CONTROL_PESSIMISTIC and the update lock hint is either AccessIntent.PESSIMISTIC_UPDATE_LOCK_HINT_EXCLUSIVE or AccessIntent.PESSIMISTIC_UPDATE_LOCK_HINT_NONE. In all other cases, java.sql.ResultSet.CONCUR_UPDATABLE is returned.
        Specified by:
        getResultSetConcurrency in interface DataStoreHelper
        Overrides:
        getResultSetConcurrency in class com.ibm.websphere.rsadapter.DataDirectDataStoreHelper
        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.
        See Also:
        AccessIntent, ResultSet

      • getIsolationLevel

        public int getIsolationLevel(AccessIntent intent)
                      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 ConnectJDBCDataStoreHelper is Connection.TRANSACTION_REPEATABLE_READ.

        In the case where an AccessIntent is specified, ConnectJDBCDataStoreHelper computes the transaction isolation level as follows:

        • If the concurrency control is AccessIntent.CONCURRENCY_CONTROL_OPTIMISTIC then a transaction isolation level of Connection.TRANSACTION_READ_COMMITTED is returned.

        • If the concurrency control is AccessIntent.CONCURRENCY_CONTROL_PESSIMISTIC and the access type is AccessIntent.ACCESS_TYPE_READ then a transaction isolation level of Connection.TRANSACTION_REPEATABLE_READ is returned.

        • If the concurrency control is AccessIntent.CONCURRENCY_CONTROL_PESSIMISTIC and the access type is AccessIntent.ACCESS_TYPE_UPDATE then the transation isolation level is determined 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          		 Connection.TRANSACTION_REPEATABLE_READ
          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 com.ibm.websphere.rsadapter.DataDirectDataStoreHelper
        Parameters:
        intent - 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.
        See Also:
        AccessIntent, Connection

      • isDuplicateKey

        public 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.

        Specified by:
        isDuplicateKey in interface DataStoreHelper
        Overrides:
        isDuplicateKey in class GenericDataStoreHelper
        Parameters:
        sqlX - the error.
        Returns:
        true if the error indicates a duplicate key violation, otherwise false.

      • showLockInfo

        public java.lang.String showLockInfo(java.util.Properties props)
                              throws java.lang.Exception

        This method returns lock information for Microsoft SQL Server. The props parameter can include the following properties:

        1. user - user name that has a DBA authority. If not specified, a default value of "sa" is used.
        2. password - the password corresponding to the user name. If not specified, a default value of "" (empty string) is used.
        3. serverName - the server name where the Microsoft SQL Server database resides.
        4. portNumber - the port where Microsoft SQL Server is listening.
        Overrides:
        showLockInfo in class com.ibm.websphere.rsadapter.DataDirectDataStoreHelper
        Parameters:
        props - properties containing information needed to connect to the database.
        Returns:
        the lock information.
        Throws:
        java.lang.Exception - if an error occurs while collecting the lock information.
IBM WebSphere Application ServerTM
Release 8.5