Class MicrosoftSQLServerDataStoreHelper

java.lang.Object
com.ibm.websphere.rsadapter.GenericDataStoreHelper
com.ibm.websphere.rsadapter.MicrosoftSQLServerDataStoreHelper
All Implemented Interfaces:
DataStoreHelper

public class MicrosoftSQLServerDataStoreHelper extends GenericDataStoreHelper
MicrosoftSQLServerDataStoreHelper is provided as an implementation of the DataStoreHelper interface to enable connectivity to Microsoft SQL Server via the Microsoft SQL Server JDBC Driver. If you have additional requirements with the Microsoft SQL Server JDBC Driver or the Microsoft SQL Server database, you should consider subclassing this implementation.
Note: This class and its methods cannot be called or referenced directly by applications.

SQLException mappings specific to the MicrosoftSQLServerDataStoreHelper are the following:

Error CodeSQL StatePortableSQLException subclass
230StaleConnectionException.class
2627DuplicateKeyException.class
6002StaleConnectionException.class
  • Field Details

    • RESOURCE_TYPES

      public static final String[] RESOURCE_TYPES
    • LOCK_REQUEST_STATUSES

      public static final String[] LOCK_REQUEST_STATUSES
    • LOCK_OWNER_TPYES

      public static final String[] LOCK_OWNER_TPYES
    • LOCK_REQUEST_MODES

      public static final String[] LOCK_REQUEST_MODES
  • Constructor Details

    • MicrosoftSQLServerDataStoreHelper

      public MicrosoftSQLServerDataStoreHelper(Properties props)
      This MicrosoftSQLServerDataStoreHelper constructor creates a new MicrosoftSQLServerDataStoreHelper 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 Details

    • doStatementCleanup

      public void doStatementCleanup(PreparedStatement stmt) throws SQLException

      This method cleans up a statement before the statement is returned to the statement cache. This method is called only for statements that are cached. It is called only if at least one of the following statement properties has changed:

      • cursorName
      • fetchDirection
      • maxFieldSize
      • maxRows
      • queryTimeout
      • responseBuffering

      MicrosoftSQLServerDataStoreHelper resets all of the properties listed above.

      The following operations do not need to be included in the statement cleanup since they are automatically performed by the application server 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:
      SQLException - if an error occurs cleaning up the statement.
    • getIsolationLevel

      public int getIsolationLevel(AccessIntent intent) throws javax.resource.ResourceException
      This method determines the default transaction isolation level. The default value for this data store helper is Connection.TRANSACTION_REPEATABLE_READ.
      Specified by:
      getIsolationLevel in interface DataStoreHelper
      Overrides:
      getIsolationLevel in class GenericDataStoreHelper
      Parameters:
      intent - always null in Liberty.
      Returns:
      A transaction isolation level.
      Throws:
      javax.resource.ResourceException - If a transaction isolation level cannot be determined.
    • showLockInfo

      public final String showLockInfo(Properties props) throws 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 GenericDataStoreHelper
      Parameters:
      props - properties containing information needed to connect to the database.
      Returns:
      the lock information.
      Throws:
      Exception - if an error occurs while collecting the lock information.