Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKUMapLDAP

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKUMapLDAP
All Implemented Interfaces:
dkUMapMgmt, java.io.Serializable

public class DKUMapLDAP
extends java.lang.Object
implements dkUMapMgmt, java.io.Serializable

See Also:
Serialized Form

Constructor Summary
DKUMapLDAP()
           
 
Method Summary
 void addMapping(java.lang.String serverName, java.lang.String serverType, java.lang.String dName, java.lang.String uid, java.lang.String pw)
          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.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 uid, java.lang.String pw)
          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

DKUMapLDAP

public DKUMapLDAP()
Method Detail

addMapping

public void addMapping(java.lang.String serverName,
                       java.lang.String serverType,
                       java.lang.String dName,
                       java.lang.String uid,
                       java.lang.String pw)
                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 uid,
                          java.lang.String pw)
                   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.

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.