Enterprise Information Portal APIs

com.ibm.mm.beans
Class CMBUserManagement

java.lang.Object
  |
  +--com.ibm.mm.beans.CMBUserManagement
All Implemented Interfaces:
CMBConnectionReplyListener, CMBUserRequestListener, java.util.EventListener, java.io.Serializable

public class CMBUserManagement
extends java.lang.Object
implements java.io.Serializable, CMBConnectionReplyListener, CMBUserRequestListener

The CMBUserManagement bean provides EIP User Management functions. This bean should only be used with federated dsType. It provides user mapping, server mapping utilities.

Summary of properties and events:

   imported properties   traceEnabled, defaulting off, will not veto
   exported properties   none
   standalone properties none
   interested in events  CMBSConnectionReplyEvent - to get connection handle
                         CMBUserRequestEvent      - to perform functions
   source of events      CMBUserReplyEvent        - to reply the request
                         CMBExceptionEvent        - to post exception
                         CMBTraceEvent            - to let logger trace
 

Since:
6.1
See Also:
CMBConnection, Serialized Form

Constructor Summary
CMBUserManagement()
          Default constructor
 
Method Summary
 void addCMBExceptionListener(CMBExceptionListener listener)
          CMBExceptionEvent registration method.
 void addCMBTraceListener(CMBTraceListener listener)
          CMBTraceEvent registration method.
 void addCMBUserReplyListener(CMBUserReplyListener listener)
          CMBUserReplyEvent registration method.
 void addUserMapping(java.lang.String serverName, java.lang.String uid, java.lang.String passwd)
          Adds new user mapping for the current logged on userid
 void changePassword(java.lang.String serverName, java.lang.String userid, java.lang.String passwd, java.lang.String newPasswd)
          Changes the native userid password on a given server
 CMBConnection getConnection()
          Gets the connection bean reference.
 CMBExceptionEvent getExceptionEvent()
          To support VisualCafe 3.0 "Add Interaction..."
 java.lang.String getNativeUserid(java.lang.String serverName)
          Gets the native userid on the given back-end server
 java.lang.String[] getServerName()
          Gets a list of back-end server names that the current logged on federated userid has access to.
 java.lang.String getServerName(int index)
          Index getter for back-end server name that the current logged on federated userid has access to.
 CMBTraceEvent getTraceEvent()
          To support VisualCafe 3.0 "Add Interaction..."
 CMBUserReplyEvent getUserReplyEvent()
          To support VisualCafe 3.0 "Add Interaction..."
 boolean isTraceEnabled()
          Indicates if tracing is enabled on this bean.
 void onCMBConnectionReply(CMBConnectionReplyEvent evt)
          Implementation of connection reply service method: update the connection handle accordingly.
 void onCMBUserRequest(CMBUserRequestEvent evt)
          Implementation of user request service method
 void removeCMBExceptionListener(CMBExceptionListener listener)
          CMBExceptionEvent unregistration method.
 void removeCMBTraceListener(CMBTraceListener listener)
          CMBTraceEvent unregistration method.
 void removeCMBUserReplyListener(CMBUserReplyListener listener)
          CMBUserReplyEvent unregistration method.
 void removeUserMapping(java.lang.String serverName)
          Deletes current user mapping on a server
 void setConnection(CMBConnection connObj)
          Sets the connection bean reference.
 void setTraceEnabled(boolean newValue)
          Enables or disables tracing on this bean.
 void updateUserMapping(java.lang.String serverName, java.lang.String uid, java.lang.String passwd)
          Updates current user mapping on a server
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBUserManagement

public CMBUserManagement()
Default constructor
Method Detail

isTraceEnabled

public boolean isTraceEnabled()
Indicates if tracing is enabled on this bean.
Returns:
true if tracing is enabled, false if tracing is disabled.

setTraceEnabled

public void setTraceEnabled(boolean newValue)
Enables or disables tracing on this bean.
Parameters:
newValue - if true, tracing is enabled. If false, tracing is disabled.

setConnection

public void setConnection(CMBConnection connObj)
Sets the connection bean reference.
Parameters:
connObj - CMBConnection bean reference

getConnection

public CMBConnection getConnection()
Gets the connection bean reference.
Returns:
the reference to the CMBConnection object.

getServerName

public java.lang.String[] getServerName()
                                 throws CMBException
Gets a list of back-end server names that the current logged on federated userid has access to.
Returns:
an array of server names.
Throws:
CMBException - when error occurs in the server

getServerName

public java.lang.String getServerName(int index)
                               throws java.lang.ArrayIndexOutOfBoundsException,
                                      CMBException
Index getter for back-end server name that the current logged on federated userid has access to.
Parameters:
index - int - index to the current list of back-end servers
Returns:
back-end server name

getNativeUserid

public java.lang.String getNativeUserid(java.lang.String serverName)
                                 throws CMBException
Gets the native userid on the given back-end server
Parameters:
serverName - back-end server name
Returns:
native userid

addUserMapping

public void addUserMapping(java.lang.String serverName,
                           java.lang.String uid,
                           java.lang.String passwd)
                    throws CMBException,
                           CMBUserAlreadyExistException
Adds new user mapping for the current logged on userid
Parameters:
serverName - name of the back-end server
uid - back-end server uid
passwd - back-end server uid password
Throws:
CMBException - if adding failed at the server
CMBUserAlreadyExist - if mapping already exist for this back-end serverName

updateUserMapping

public void updateUserMapping(java.lang.String serverName,
                              java.lang.String uid,
                              java.lang.String passwd)
                       throws CMBException
Updates current user mapping on a server
Parameters:
serverName - name of the back-end server
uid - back-end server uid
passwd - back-end server uid password
Throws:
CMBException - if adding failed at the server

removeUserMapping

public void removeUserMapping(java.lang.String serverName)
                       throws CMBException
Deletes current user mapping on a server
Parameters:
serverName - name of the back-end server
Throws:
CMBException - if adding failed at the server

changePassword

public void changePassword(java.lang.String serverName,
                           java.lang.String userid,
                           java.lang.String passwd,
                           java.lang.String newPasswd)
                    throws CMBException
Changes the native userid password on a given server

onCMBConnectionReply

public void onCMBConnectionReply(CMBConnectionReplyEvent evt)
Implementation of connection reply service method: update the connection handle accordingly.
Specified by:
onCMBConnectionReply in interface CMBConnectionReplyListener
Parameters:
evt - a CMBConnectionReplyEvent

onCMBUserRequest

public void onCMBUserRequest(CMBUserRequestEvent evt)
Implementation of user request service method
Specified by:
onCMBUserRequest in interface CMBUserRequestListener
Parameters:
evt - a CMBUserRequestEvent

addCMBExceptionListener

public void addCMBExceptionListener(CMBExceptionListener listener)
CMBExceptionEvent registration method. It ignores a registration request if the listener is already registered.
Parameters:
listener - listener to be registered

removeCMBExceptionListener

public void removeCMBExceptionListener(CMBExceptionListener listener)
CMBExceptionEvent unregistration method.
Parameters:
listener - listener to be unregistered

addCMBTraceListener

public void addCMBTraceListener(CMBTraceListener listener)
CMBTraceEvent registration method. It ignores a registration request if the listener is already registered.
Parameters:
listener - listener to be registered

removeCMBTraceListener

public void removeCMBTraceListener(CMBTraceListener listener)
CMBTraceEvent unregistration method.
Parameters:
listener - listener to be unregistered

addCMBUserReplyListener

public void addCMBUserReplyListener(CMBUserReplyListener listener)
CMBUserReplyEvent registration method. It ignores a registration request if the listener is already registered.
Parameters:
listener - listener to be registered

removeCMBUserReplyListener

public void removeCMBUserReplyListener(CMBUserReplyListener listener)
CMBUserReplyEvent unregistration method.
Parameters:
listener - listener to be unregistered

getTraceEvent

public CMBTraceEvent getTraceEvent()
To support VisualCafe 3.0 "Add Interaction..."
Returns:
a CMBTraceEvent

getExceptionEvent

public CMBExceptionEvent getExceptionEvent()
To support VisualCafe 3.0 "Add Interaction..."
Returns:
a CMBExceptionEvent

getUserReplyEvent

public CMBUserReplyEvent getUserReplyEvent()
To support VisualCafe 3.0 "Add Interaction..."
Returns:
a CMBDataReplyEvent

EIP JavaBeans

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