IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.rsadapter
Interface WSConnectionSpec

All Superinterfaces:
javax.resource.cci.ConnectionSpec
All Known Subinterfaces:
JDBCConnectionSpec, WSCciConnectionSpec

public interface WSConnectionSpec
extends javax.resource.cci.ConnectionSpec

A ConnectionSpec interface provided for applications using the javax.resource.cci interfaces to specify Connection properties available on the WebSphere Relational Resource Adapter.


Method Summary
 java.lang.String getCatalog()
          Get the catalog name.
 int getHoldability()
          Get the cursor holdability value.
 java.lang.String getPassword()
          Get the password.
 java.util.Map getTypeMap()
          Get the type map, which is used for the custom mapping of SQL structured types and distinct types.
 java.lang.String getUserName()
          Get the user name.
 java.lang.Boolean isReadOnly()
          Get the read-only indicator for the database.
 void setCatalog(java.lang.String catalog)
          Set the catalog name.
 void setHoldability(int holdability)
          Set the cursor holdability value.
 void setPassword(java.lang.String pwd)
          Set the password.
 void setReadOnly(java.lang.Boolean readOnly)
          Indicate whether the connection is read only.
 void setTypeMap(java.util.Map map)
          Set the type map for this connection.
 void setUserName(java.lang.String userName)
          Set the user name.
 

Method Detail

getCatalog

java.lang.String getCatalog()
Get the catalog name.

Returns:
the catalog name.

getPassword

java.lang.String getPassword()
Get the password.

Returns:
the password.

getTypeMap

java.util.Map getTypeMap()
Get the type map, which is used for the custom mapping of SQL structured types and distinct types.

Returns:
the type map.

getHoldability

int getHoldability()

Get the cursor holdability value. If the JDBC driver doesn't support cursor holdability feature, 0 is returned.

Returns:
the cursor holdability. 0 If the JDBC driver doesn't support cursor holdability feature.

getUserName

java.lang.String getUserName()
Get the user name.

Returns:
the user name.

isReadOnly

java.lang.Boolean isReadOnly()
Get the read-only indicator for the database.

Returns:
true if the connection is read only; otherwise false. Value will be null if the readOnly property was never set, which means the database default will be used.

setCatalog

void setCatalog(java.lang.String catalog)
Set the catalog name. A value of null indicates to use the database default.

Parameters:
catalog - the catalog name.

setPassword

void setPassword(java.lang.String pwd)
Set the password.

Parameters:
pwd - the password.

setReadOnly

void setReadOnly(java.lang.Boolean readOnly)
Indicate whether the connection is read only. A value of null indicates to use the database default.

Parameters:
readOnly - a flag indicating whether the connection is read only.

setTypeMap

void setTypeMap(java.util.Map map)
Set the type map for this connection. The type map is used for the custom mapping of SQL structured types and distinct types. A value of null indicates to use the database default.

Parameters:
typeMap - the type map.

setUserName

void setUserName(java.lang.String userName)
Set the user name.

Parameters:
userName - the user name.

setHoldability

void setHoldability(int holdability)
Set the cursor holdability value. A value of 0 indicates to use the database default. If the JDBC driver doesn't support cursor holdability feature, you can set the holdability value to 0.

Parameters:
holdability - the cursor holdability

IBM WebSphere Application ServerTM
Release 7