|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.db2.wrapper.CatalogInfo
com.ibm.db2.wrapper.UserInfo
The UserInfo class encapsulates the catalog information for a user mapping from the CREATE USER MAPPING and ALTER USER MAPPING statements.
The UserInfo class is one of the catalog classes for the Java API.
Usage:
The UserInfo class is instantiated by the DB2 federated server to contain
information from a CREATE USER MAPPING or an ALTER USER MAPPING statement
or to contain information from the federated server's system catalog.
This class is instantiated by the wrapper when information is added during
CREATE USER MAPPING or ALTER USER MAPPING statement operations.
Constructor Summary | |
UserInfo()
Construct a default (empty) user information object. |
Method Summary | |
void |
addOption(java.lang.String optionName,
java.lang.String optionValue,
int action)
Add an option to the options chain. |
java.lang.String |
getAuthID()
Retrieve the authorization ID for this user mapping. |
java.lang.String |
getPassword()
Retrieve the password for this user mapping. |
java.lang.String |
getServerName()
Retrieve the data source server name for this user mapping. |
boolean |
isAuthIDValid()
Verify whether an authorization ID is specified. |
boolean |
isServerNameValid()
Verify whether a data source server name is specified. |
void |
setAuthID(java.lang.String authID)
Set the authorization ID for this user mapping. |
void |
setServerName(java.lang.String serverName)
Set the data source server name for this user mapping. |
Methods inherited from class com.ibm.db2.wrapper.CatalogInfo |
addOption, dropOption, getFirstOption, getNextOption, getOption |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public UserInfo()
Method Detail |
public void addOption(java.lang.String optionName, java.lang.String optionValue, int action) throws WrapperException
optionName
- The name of the option.optionValue
- The value of the option.action
- The action flag for the option.
Valid actions for the options are specified in CatalogOption
class.
WrapperException
- if the option already exists in the chain or if the action is invalid.public java.lang.String getAuthID()
public java.lang.String getPassword()
public java.lang.String getServerName()
public boolean isAuthIDValid()
public boolean isServerNameValid()
public void setAuthID(java.lang.String authID)
authID
- The authorization ID.public void setServerName(java.lang.String serverName)
serverName
- The data source server name.
|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
(C)Copyright IBM Corp. 2002. All rights reserved.
Links on this page are made available for your convenience and may take you to non-IBM sites. IBM does not warrant any sample code provided on these sites.