com.ibm.websphere.rsadapter
Class DataStoreHelperMetaData

java.lang.Object
  |
  +--com.ibm.websphere.rsadapter.DataStoreHelperMetaData
All Implemented Interfaces:
java.io.Serializable
public class DataStoreHelperMetaData
extends java.lang.Object
implements java.io.Serializable

This class provides metadata information for DataStoreHelpers. DataStoreHelperMetaData can be used to retrieve static information about the database and JDBC driver. Setter methods are provided only for the DataStoreHelper class to use in initializing the DataStoreHelperMetaData. The setter methods must never be used directly by the application.

See Also:
Serialized Form

Constructor Summary
DataStoreHelperMetaData()
          Create a new DataStoreHelperMetaData instance configured with the following default values,
 
Method Summary
 int getDatabaseDefaultIsolationLevel()
          Returns the default transaction isolation level for the JDBC driver to which this DataStoreHelperMetaData corresponds.
 int getHelperType()
          Returns a constant indicating the type of DataStoreHelper to which this DataStoreHelperMetaData instance applies.
 void setDatabaseDefaultIsolationLevel(int level)
          Configures an indicator of the default transaction isolation level for the JDBC driver.
 void setExtendedForUpdateSupport(boolean flag)
          Configures an indicator of whether extended-for-update is supported by the database.
 void setGetCatalogSupport(boolean flag)
          Configures an indicator of whether the JDBC driver supports java.sql.Connection.getCatalog.
 void setGetTypeMapSupport(boolean flag)
          Configures an indicator of whether the JDBC driver supports java.sql.Connection.getTypeMap.
 void setHelperType(int hType)
          Configures the DataStoreHelepr type.
 void setKerberosSupport(boolean flag)
          Configures an indicator of whether the database supports kerberos.
 void setMultiplePartitionDBSupport(boolean flag)
          d146350 This method configures whether the database supports mulitiple partitions.
 void setReadOnlySupport(boolean flag)
          Configures an indicator of whether the JDBC driver supports java.sql.Connection.isReadOnly.
 void setSelectForUpdateSupport(boolean flag)
          Configures an indicator of whether the database supports select for update.
 boolean supportsExtendedForUpdate()
          Indicates whether the database supports extended-for-update.
 boolean supportsGetCatalog()
          Indicates whether the JDBC driver supports java.sql.Connection.getCatalog.
 boolean supportsGetTypeMap()
          Indicates whether the JDBC driver supports java.sql.Connection.getTypeMap.
 boolean supportsIsReadOnly()
          Indicates whether the JDBC driver supports java.sql.Connection.isReadOnly.
 boolean supportsKerberos()
          Indicates whether the database supports kerberos.
 boolean supportsMultiplePartitionDB()
          d146350 add Indicates whether the database supports multiple partitions.
 boolean supportsSelectForUpdate()
          Indicates whether the database supports select for update.
 java.lang.String toString()
          Returns a nicely formatted, legible representation of the DataStoreHelperMetaData.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataStoreHelperMetaData

public DataStoreHelperMetaData()

Create a new DataStoreHelperMetaData instance configured with the following default values,

DatabaseDefaultIsolationLevel = java.sql.Connection.TRANSACTION_READ_COMMITTED;
HelperType = DataStoreHelper.GENERIC_HELPER;
SupportsExtendedForUpdate = false;
SupportsKerberos = false;
SupportsSelectForUpdate = true;
SupportsGetCatalog = true;
SupportsGetTypeMap = true;
SupportsIsReadOnly = true;
SupportsMultiplePartitionDB = false;

Method Detail

getHelperType

public final int getHelperType()
Returns a constant indicating the type of DataStoreHelper to which this DataStoreHelperMetaData instance applies. A list of valid DataStoreHelper types is defined on the DataStoreHelper interface. For example, DataStoreHelper.DB2_UNIVERSAL_HELPER.

Returns:
the DataStoreHelper type constant indicating the DataStoreHelper type.
Since:
WAS 5.0.1
See Also:
DataStoreHelper

setHelperType

public final void setHelperType(int hType)
Configures the DataStoreHelepr type. A list of valid DataStoreHelper types is defined on the DataStoreHelper interface. For example, DataStoreHelper.DB2_UNIVERSAL_HELPER.

Parameters:
hType - a valid DataStoreHelper type constant defined on the DataStoreHelper interface.
Since:
WAS 5.0.1
See Also:
DataStoreHelper

getDatabaseDefaultIsolationLevel

public final int getDatabaseDefaultIsolationLevel()
Returns the default transaction isolation level for the JDBC driver to which this DataStoreHelperMetaData corresponds. The default transaction isolation level is considered to be the transaction isolation level found on a newly obtained java.sql.Connection.

Returns:
the default transaction isolation level for the JDBC driver. Isolation level constants are defined on the java.sql.Connection interface.
See Also:
Connection

setDatabaseDefaultIsolationLevel

public final void setDatabaseDefaultIsolationLevel(int level)
Configures an indicator of the default transaction isolation level for the JDBC driver. This method should be used only by the DataStoreHelper class to initially configure the DataStoreHelperMetaData.

Parameters:
level - the transaction isolation level. Transaction isolation level constants are defined on the java.sql.Connection interface.
See Also:
Connection

setExtendedForUpdateSupport

public final void setExtendedForUpdateSupport(boolean flag)
Configures an indicator of whether extended-for-update is supported by the database. This method should be used only by the DataStoreHelper class to initially configure the DataStoreHelperMetaData.

Parameters:
flag - indicates whether the database supports extended-for-update.

supportsExtendedForUpdate

public final boolean supportsExtendedForUpdate()
Indicates whether the database supports extended-for-update.

Returns:
true if the database supports extended-for-update, otherwise false.

setKerberosSupport

public final void setKerberosSupport(boolean flag)
Configures an indicator of whether the database supports kerberos. This method should be used only the DataStoreHelper class to initially configure the DatastoreHelperMetaData.

Parameters:
flag - indicates whether the database supports kerberos.

supportsKerberos

public final boolean supportsKerberos()
Indicates whether the database supports kerberos.

Returns:
true if the database supports kerberos, otherwise false.

setSelectForUpdateSupport

public final void setSelectForUpdateSupport(boolean flag)
Configures an indicator of whether the database supports select for update. This method should be used only by the DataStoreHelper class to initially configure the DataStoreHelperMetaData.

Parameters:
flag - indicates whether the database supports select for update.

supportsSelectForUpdate

public final boolean supportsSelectForUpdate()
Indicates whether the database supports select for update.

Returns:
true if the database supports select for update, otherwise false.

setGetCatalogSupport

public final void setGetCatalogSupport(boolean flag)
Configures an indicator of whether the JDBC driver supports java.sql.Connection.getCatalog. This method should be used only by the DataStoreHelper class to initially configure the DataStoreHelperMetaData.

Parameters:
flag - indicates whether the operation is supported.

supportsGetCatalog

public final boolean supportsGetCatalog()
Indicates whether the JDBC driver supports java.sql.Connection.getCatalog.

Returns:
true if the operation is supported, otherwise false.

setGetTypeMapSupport

public final void setGetTypeMapSupport(boolean flag)
Configures an indicator of whether the JDBC driver supports java.sql.Connection.getTypeMap. This method should be used only by the DataStoreHelper class to initially configure the DataStoreHelperMetaData.

Parameters:
flag - indicates whether the operation is supported.

supportsGetTypeMap

public final boolean supportsGetTypeMap()
Indicates whether the JDBC driver supports java.sql.Connection.getTypeMap.

Returns:
true if the operation is supported, otherwise false.

setReadOnlySupport

public final void setReadOnlySupport(boolean flag)
Configures an indicator of whether the JDBC driver supports java.sql.Connection.isReadOnly. This method should be used only by the DataStoreHelper class to initially configure the DataStoreHelperMetaData.

Parameters:
flag - indicates whether the operation is supported.

supportsIsReadOnly

public final boolean supportsIsReadOnly()
Indicates whether the JDBC driver supports java.sql.Connection.isReadOnly.

Returns:
true if the operation is supported, otherwise false.

setMultiplePartitionDBSupport

public final void setMultiplePartitionDBSupport(boolean flag)
d146350 This method configures whether the database supports mulitiple partitions. This method should be used only by the DataStoreHelper class to initially configure the DataStoreHelperMetaData.

Parameters:
flag - indicates whether the database supports multiple partitions.

supportsMultiplePartitionDB

public final boolean supportsMultiplePartitionDB()
d146350 add Indicates whether the database supports multiple partitions.

Returns:
true if the database supports multiple partitions, otherwise false.

toString

public java.lang.String toString()
Returns a nicely formatted, legible representation of the DataStoreHelperMetaData.

Overrides:
toString in class java.lang.Object
Returns:
a String representing the DataStoreHelperMetaData.

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.