Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKUMapFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKUMapFed
All Implemented Interfaces:
DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, dkUMapMgmt, java.io.Serializable

public class DKUMapFed
extends java.lang.Object
implements dkUMapMgmt, DKConstantFed, DKMessageIdFed, java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKUMapFed(java.lang.String serverName)
           
 
Method Summary
 void addMapping(java.lang.String serverName, java.lang.String serverType, java.lang.String dName, java.lang.String mUserid, java.lang.String mPassword)
          Adds the mapping of the username to the mapped userid and password to the mapping server
 void deleteMapping(java.lang.String serverName, java.lang.String serverType, java.lang.String dName)
          Deletes the mapped userid and password from the mapping server
 java.util.Vector listMapping()
          List all the mapped userid and password
 java.lang.String[] retrieveMapping(java.lang.String serverName, java.lang.String serverType, java.lang.String dName)
          Retrieve the mapped userid and password from the mapping server
 void updateMapping(java.lang.String serverName, java.lang.String serverType, java.lang.String dName, java.lang.String mUserid, java.lang.String mPassword)
          Updates the mapped userid and password from the mapping server
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKUMapFed

public DKUMapFed(java.lang.String serverName)
          throws java.lang.Exception
Method Detail

addMapping

public void addMapping(java.lang.String serverName,
                       java.lang.String serverType,
                       java.lang.String dName,
                       java.lang.String mUserid,
                       java.lang.String mPassword)
                throws DKAlreadyExistException,
                       DKException,
                       java.lang.Exception
Adds the mapping of the username to the mapped userid and password to the mapping server
Specified by:
addMapping in interface dkUMapMgmt
Parameters:
serverName - name of the server where the mapped userid and password is for
serverType - type of the server where the mapped userid and password is for
dName - user distinguish name or username
Throws:
DKAlreadyExistException - if the mapping for the distinguish name already exist
DKException - if there is an error at the mapping server
java.lang.Exception - if there is any network communication error.

updateMapping

public void updateMapping(java.lang.String serverName,
                          java.lang.String serverType,
                          java.lang.String dName,
                          java.lang.String mUserid,
                          java.lang.String mPassword)
                   throws DKNotExistException,
                          DKException,
                          java.lang.Exception
Updates the mapped userid and password from the mapping server
Specified by:
updateMapping in interface dkUMapMgmt
Parameters:
serverName - name of the server where the mapped userid and password is for
serverType - type of the server where the mapped userid and password is for
dName - user distinguish name or username
Throws:
DKNotExistException - if the mapping for the distinguish name does not exist
DKException - if there is an error at the mapping server
java.lang.Exception - if there is any network communication error.

retrieveMapping

public java.lang.String[] retrieveMapping(java.lang.String serverName,
                                          java.lang.String serverType,
                                          java.lang.String dName)
                                   throws DKNotExistException,
                                          DKException,
                                          java.lang.Exception
Retrieve the mapped userid and password from the mapping server
Specified by:
retrieveMapping in interface dkUMapMgmt
Parameters:
serverName - name of the server where the mapped userid and password is for
serverType - type of the server where the mapped userid and password is for
dName - user distinguish name or username
Returns:
an array of 2 values: mapped userid and mapped password Warning: this mapped password is in the clear, so use this method with care!
Throws:
DKNotExistException - if the mapping for the distinguish name does not exist
DKException - if there is an error at the mapping server
java.lang.Exception - if there is any network communication error.

listMapping

public java.util.Vector listMapping()
                             throws DKException,
                                    java.lang.Exception
List all the mapped userid and password
Returns:
a Vector containing String[] for mapped userid, mapped password, mapped server name, mapped server type and WPS name Warning: this mapped password is in the clear, so use this method with care!
Throws:
DKException - if there is an error at the mapping server
java.lang.Exception - if there is any network communication error.

deleteMapping

public void deleteMapping(java.lang.String serverName,
                          java.lang.String serverType,
                          java.lang.String dName)
                   throws DKNotExistException,
                          DKException,
                          java.lang.Exception
Deletes the mapped userid and password from the mapping server
Specified by:
deleteMapping in interface dkUMapMgmt
Parameters:
serverName - name of the server where the mapped userid and password is for
serverType - type of the server where the mapped userid and password is for
dName - user distinguish name or username
Throws:
DKNotExistException - if the mapping for the distinguish name does not exist
DKException - if there is an error at the mapping server
java.lang.Exception - if there is any network communication error.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.