Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKUserMappingMgmt

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKUserMappingMgmt

public class DKUserMappingMgmt
extends java.lang.Object


Constructor Summary
DKUserMappingMgmt(java.lang.String mServerType, java.lang.String mServerName)
           
 
Method Summary
 void addMapping(java.lang.String serverName, java.lang.String serverType, DKAuthenticationData authObj)
          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, DKAuthenticationData authObj)
          Deletes the mapped userid and password from the mapping server
 boolean retrieveMapping(java.lang.String serverName, java.lang.String serverType, DKAuthenticationData authObj)
          Retrieve the mapped userid and password from the mapping server
static void setMappedClass(java.lang.String mType, java.lang.String className)
           
 void updateMapping(java.lang.String serverName, java.lang.String serverType, DKAuthenticationData authObj)
          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

DKUserMappingMgmt

public DKUserMappingMgmt(java.lang.String mServerType,
                         java.lang.String mServerName)
                  throws DKException
Method Detail

addMapping

public void addMapping(java.lang.String serverName,
                       java.lang.String serverType,
                       DKAuthenticationData authObj)
                throws DKAlreadyExistException,
                       DKUsageError,
                       DKException,
                       java.lang.Exception
Adds the mapping of the username to the mapped userid and password to the mapping server
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
authObj - authentication data object
Throws:
DKAlreadyExistException - if the mapping for the distinguish name already exist
DKUsageError - if the user name is empty
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,
                          DKAuthenticationData authObj)
                   throws DKNotExistException,
                          DKUsageError,
                          DKException,
                          java.lang.Exception
Updates the mapped userid and password from the mapping server
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
authObj - authentication data object
Throws:
DKNotExistException - if the mapping for the distinguish name does not exist
DKUsageError - if the user name is empty
DKException - if there is an error at the mapping server
java.lang.Exception - if there is any network communication error.

retrieveMapping

public boolean retrieveMapping(java.lang.String serverName,
                               java.lang.String serverType,
                               DKAuthenticationData authObj)
                        throws DKException,
                               java.lang.Exception
Retrieve the mapped userid and password from the mapping server
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
authObj - authentication data object
Returns:
true if there is mapping, false otherwise. When there is a mapping, the mapped userid and password are set in the authObj 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.

deleteMapping

public void deleteMapping(java.lang.String serverName,
                          java.lang.String serverType,
                          DKAuthenticationData authObj)
                   throws DKUsageError,
                          DKException,
                          java.lang.Exception
Deletes the mapped userid and password from the mapping server
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
authObj - authentication data object
Throws:
DKNotExistException - if the mapping for the distinguish name does not exist
DKUsageError - if the user name is empty
DKException - if there is an error at the mapping server
java.lang.Exception - if there is any network communication error.

setMappedClass

public static void setMappedClass(java.lang.String mType,
                                  java.lang.String className)

EIP Java APIs

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