com.ibm.websphere.rsadapter

Interface WSConnectionSpec

All Superinterfaces:
javax.resource.cci.ConnectionSpec
All known subinterfaces:
JDBCConnectionSpec, WSCciConnectionSpec

  1. public interface WSConnectionSpec
  2. 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

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

Method Detail

getCatalog

  1. java.lang.String getCatalog()
Get the catalog name.
Returns:
the catalog name.

getPassword

  1. java.lang.String getPassword()
Get the password.
Returns:
the password.

getTypeMap

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

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

  1. java.lang.String getUserName()
Get the user name.
Returns:
the user name.

isReadOnly

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

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

  1. void setPassword(java.lang.String pwd)
Set the password.
Parameters:
pwd - the password.

setReadOnly

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

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

setUserName

  1. void setUserName(java.lang.String userName)
Set the user name.
Parameters:
userName - the user name.

setHoldability

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