IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

com.ibm.db2.wrapper
Class UserInfo

java.lang.Object
  extended bycom.ibm.db2.wrapper.CatalogInfo
      extended bycom.ibm.db2.wrapper.UserInfo

public final class UserInfo
extends CatalogInfo

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.

Since:
IBM DB2 Information Integrator Version 8.2

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

UserInfo

public UserInfo()
Construct a default (empty) user information object.

Since:
IBM DB2 Information Integrator Version 8.2
Method Detail

addOption

public void addOption(java.lang.String optionName,
                      java.lang.String optionValue,
                      int action)
               throws WrapperException
Add an option to the options chain.

Parameters:
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.
Throws:
WrapperException - if the option already exists in the chain or if the action is invalid.
Since:
IBM DB2 Information Integrator Version 8.2

getAuthID

public java.lang.String getAuthID()
Retrieve the authorization ID for this user mapping.

Returns:
The authorization ID.
Since:
IBM DB2 Information Integrator Version 8.2

getPassword

public java.lang.String getPassword()
Retrieve the password for this user mapping. Obtains the value of the REMOTE_PASSWORD option specified for this user mapping, if any.

Returns:
The password specified as the value of the REMOTE_PASSWORD option for this user mapping or null if the option is not found.
Since:
IBM DB2 Information Integrator Version 8.2

getServerName

public java.lang.String getServerName()
Retrieve the data source server name for this user mapping.

Returns:
The data source server name.
Since:
IBM DB2 Information Integrator Version 8.2

isAuthIDValid

public boolean isAuthIDValid()
Verify whether an authorization ID is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

isServerNameValid

public boolean isServerNameValid()
Verify whether a data source server name is specified.

Returns:
true if a value is specified, false otherwise.
Since:
IBM DB2 Information Integrator Version 8.2

setAuthID

public void setAuthID(java.lang.String authID)
Set the authorization ID for this user mapping.

Parameters:
authID - The authorization ID.
Since:
IBM DB2 Information Integrator Version 8.2

setServerName

public void setServerName(java.lang.String serverName)
Set the data source server name for this user mapping.

Parameters:
serverName - The data source server name.
Since:
IBM DB2 Information Integrator Version 8.2

IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

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