Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKUserMgmtFed

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

public class DKUserMgmtFed
extends dkAbstractUserMgmt
implements DKConstant, DKMessageId, DKMessageIdFed, DKConstantFed, java.io.Serializable

The DKUserMgmtICM class is the implementation of the abstract class dkUserMgmt. It represents and processes management functions for user and user group. The dkUserMgmt provides facilities to query, retrieve, update, store, and manage objects associating with user and user group

See Also:
com.ibm.mm.sdk.common.dkUserMgmt, Serialized Form

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.DKMessageId
    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.DKConstantFed
    For details, see the class or interface
 
Method Summary
 void add(dkUserDef userDef)
          adds a user object into the persistent datastore
 void add(dkUserGroupDef usrGrpDef)
          Creates a new user-group
 void addGroupCoordinator(java.lang.String grpName, java.lang.String coordinator)
          Deprecated.  
 void addGroupMapping(DKGroupMapDataFed md)
          Add a mapped group to the database.
 void addMapUser(DKUserMapDataFed md)
          Add a mapped user to the database.
 void addOwnMapUser(DKUserMapDataFed md)
          Add a mapped user for the logoned user to the database.
 void addToGroup(java.lang.String groupName, java.lang.String userName)
          Adds a user to a user-group.
 void addUser(DKUserDataFed sd)
          Deprecated.  
 void addUserGroup(DKUserGroupDataFed sd)
          Deprecated.  
 void addUsersToGroup(java.lang.String groupName, java.lang.String[] arUserName)
          Add an array of users to group.
 void adminOnly()
           
 void changeMapPassword(java.lang.String server, java.lang.String newPwd)
          Changes the mapped password for the logoned user.
 void changeMapPassword(java.lang.String server, java.lang.String oldPwd, java.lang.String newPwd)
          Changes the mapped password for the logoned user.
 void changePassword(java.lang.String newPwd)
          Changes the password of the logoned user
 void changePassword(java.lang.String userName, java.lang.String newPwd)
          Changes the password of a given user name.
 void changePassword(java.lang.String userName, java.lang.String oldPwd, java.lang.String newPwd)
          Deprecated.  
 int checkUser(java.lang.String name, java.lang.String pwd)
          Deprecated.  
 void clearCache()
          Clears all cache data
 dkUserDef createUserDef()
          Create user def
 dkUserGroupDef createUserGroupDef()
          Create user group def
 void del(dkUserDef userDef)
          deletes an user object from the persistent datastore
 void del(dkUserGroupDef usrGrpDef)
          Deletes a user-group from the system
 void delUser(java.lang.String userName)
          deletes an user object from the persistent datastore
 void delUserGroup(java.lang.String userGrpName)
          Deletes a user-group from the system
 int getAccessLevel()
          Deprecated.  
 DKCommonPrivilege getCommonPrivilege(java.lang.String userName)
          Deprecated.  
 java.lang.String getCurrentLogonUser()
          Deprecated.  
 java.lang.String getGroupCoordinator(java.lang.String grpName)
          Deprecated.  
 DKUserDataFed getUser(java.lang.String userName)
          Deprecated.  
 DKUserGroupDataFed getUserGroup(java.lang.String userGrpName)
          Deprecated.  
 dkPrivilegeSet getUserPrivilege(java.lang.String userName)
          Deprecated.  
 java.lang.String[] getWFPotentialCoordinators()
          Deprecated.  
 boolean isAdminUser(java.lang.String userName)
          Check if userName is a system administrative user name
 boolean isGroupMappingEnabled()
          Determines whether the Group Mapping inheritance is enabled
 boolean isTraceEnabled()
          Checks to see if trace is currently enabled
 boolean isUserMappingEnabled()
          Determines whether the User Mapping is enabled
 dkCollection listGroupMapping(java.lang.String grp)
          List the mapped users belong to the group.
 java.lang.String[] listGroupNamesForUser(java.lang.String userName)
          lists group names for the user from the persistent store
 dkCollection listGroupsForUser(java.lang.String userName)
          lists groups for the user from the persistent store
 java.lang.String[] listGroupUsers(java.lang.String groupName)
          List users belonged to a group
 dkCollection listMapUsers()
          List the mapped users ( with server, decrypted password information ) belong to the logoned user.
 dkCollection listMapUsers(java.lang.String user)
          List the mapped users belong to the federated user.
 dkCollection listUserData()
          Deprecated.  
 dkCollection listUserData(java.lang.String domainName)
          Deprecated.  
 dkCollection listUserDefs()
          gets a list of user objects
 dkCollection listUserDefs(java.lang.String domainName)
          gets a list of user objects to this admin domain
 dkCollection listUserGroupDefs()
          gets a list of user group objects
 dkCollection listUserGroupDefs(java.lang.String domainName)
          gets a list of user group objects to this admin domain
 java.lang.String[] listUserGroupNames()
          Lists user groups defined in the system
 java.lang.String[] listUserGroupNames(java.lang.String domainName)
          Lists user groups defined in the system
 java.lang.String[] listUserGroups()
          Deprecated.  
 java.lang.String[] listUserGroups(java.lang.String domainName)
           
 java.lang.String[] listUserNames()
          gets a list of user object names
 java.lang.String[] listUserNames(java.lang.String domainName)
          gets a list of user object names to this admin domain
 java.lang.String[] listUsers()
          Deprecated.  
 java.lang.String[] listUsers(java.lang.String domainName)
          Deprecated.  
 dkCollection listUsersInGroup(java.lang.String groupName)
          lists privileges in a privilege group from the persistent store
 void removeFromGroup(java.lang.String groupName, java.lang.String userName)
          Removes a user from a user-group
 void removeGroupCoordinator(java.lang.String grpName)
          Deprecated.  
 void removeGroupMapping(java.lang.String grpName, java.lang.String server)
          Remove a mapped group to the database.
 void removeMapUser(java.lang.String srvName)
          Remove the uesr mapping by mapped server name for the logoned user.
 void removeMapUser(java.lang.String userName, java.lang.String srvName)
          Remove the uesr mapping by by user and server name.
 void removeUser(java.lang.String userName)
          Deprecated.  
 void removeUserGroup(java.lang.String name)
          Deprecated.  
 void removeUsersFromGroup(java.lang.String groupName, java.lang.String[] arUserName)
          Deprecated.  
 dkUserDef retrieveUserDef(java.lang.String userName)
          retrieve an user object from the persistent datastore
 dkUserGroupDef retrieveUserGroupDef(java.lang.String userGroupName)
          Retrieve a user group
 void setDatastore(dkDatastore ds)
          Sets the datastore object
 void setGroupMappingEnabled(boolean b)
          Enables or disables the Group Mapping inheritance option, depending on the value of the parameter b Administrator only function.
 void setTraceEnabled(boolean isEnabled)
          Sets whether we should turn on trace for debuggin purpose
 void setUserMappingEnabled(boolean b)
          Enables or disables the User Mapping option, depending on the value of the parameter b Administrator only function.
 void update(dkUserDef userDef)
          updates an user object in the persistent datastore
 void update(dkUserGroupDef usrGrpDef)
          Update a new user-group
 void updateGroupCoordinator(java.lang.String grpName, java.lang.String coordinator)
          Deprecated.  
 void updateGroupMapping(DKGroupMapDataFed md)
          Update a mapped group to the database.
 void updateMapUser(DKUserMapDataFed md)
          Update the mapped user.
 void updateOwnMapUser(DKUserMapDataFed md)
          Update the mapped user.
 void updateUser(DKUserDataFed sd)
          Deprecated.  
 void updateUserGroup(DKUserGroupDataFed sd)
          Deprecated.  
 void validateUser(java.lang.String userName, java.lang.String pwd)
          Deprecated.  
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractUserMgmt
addUser, addUser, addUserGroup, addUserGroup, deleteUserDef, deleteUserGroupDef, getDatastore
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the datastore object
Overrides:
setDatastore in class dkAbstractUserMgmt
Parameters:
ds - dkDatastore - datastore object

adminOnly

public void adminOnly()
               throws DKException,
                      java.lang.Exception

createUserDef

public dkUserDef createUserDef()
                        throws DKException,
                               java.lang.Exception
Create user def
Overrides:
createUserDef in class dkAbstractUserMgmt
Returns:
userDef object

createUserGroupDef

public dkUserGroupDef createUserGroupDef()
                                  throws DKException,
                                         java.lang.Exception
Create user group def
Overrides:
createUserGroupDef in class dkAbstractUserMgmt
Returns:
userGroupDef object

add

public void add(dkUserDef userDef)
         throws DKAlreadyExistException,
                DKException,
                java.lang.Exception
adds a user object into the persistent datastore
Overrides:
add in class dkAbstractUserMgmt
Parameters:
userDef - -- an user object to be added to the datastore
Throws:
DKAlreadyExistException - if user object already exists
DKException - if error occurs

addUser

public void addUser(DKUserDataFed sd)
             throws DKAlreadyExistException,
                    DKException,
                    java.lang.Exception
Deprecated.  

Add a user to the database Administrator only function.

update

public void update(dkUserDef userDef)
            throws DKException,
                   java.lang.Exception
updates an user object in the persistent datastore
Overrides:
update in class dkAbstractUserMgmt
Parameters:
userDef - -- an user object to be updated
Throws:
DKNotExistException, - DKException if error occurs

updateUser

public void updateUser(DKUserDataFed sd)
                throws DKNotExistException,
                       DKException,
                       java.lang.Exception
Deprecated.  

Update the User. - Administrator only function.

retrieveUserDef

public dkUserDef retrieveUserDef(java.lang.String userName)
                          throws DKException,
                                 java.lang.Exception
retrieve an user object from the persistent datastore
Overrides:
retrieveUserDef in class dkAbstractUserMgmt
Parameters:
name - -- the name of user to be retrieved
Throws:
DKException - if error occurs

getUser

public DKUserDataFed getUser(java.lang.String userName)
                      throws DKException,
                             java.lang.Exception
Deprecated.  

Retrieve user by user name from memory

removeUser

public void removeUser(java.lang.String userName)
                throws DKNotExistException,
                       DKException,
                       java.lang.Exception
Deprecated.  

Remove the uesr by name. Administrator only function.

delUser

public void delUser(java.lang.String userName)
             throws DKNotExistException,
                    DKException,
                    java.lang.Exception
deletes an user object from the persistent datastore
Overrides:
delUser in class dkAbstractUserMgmt
Parameters:
userName - -- name of the user object to be deleted
Throws:
DKNotExistException, - DKException, Exception if error occurs

del

public void del(dkUserDef userDef)
         throws DKException,
                java.lang.Exception
deletes an user object from the persistent datastore
Overrides:
del in class dkAbstractUserMgmt
Parameters:
userDef - -- an user object to be deleted
Throws:
DKNotExistException, - DKException, Exception if error occurs

listUsers

public java.lang.String[] listUsers()
                             throws DKException,
                                    java.lang.Exception
Deprecated.  

gets a list of user objects name
Overrides:
listUsers in class dkAbstractUserMgmt
Returns:
an array of user objects' name
Throws:
DKException - if error occurs

listUsers

public java.lang.String[] listUsers(java.lang.String domainName)
                             throws DKException,
                                    java.lang.Exception
Deprecated.  

gets a list of user objects name to this admin domain
Parameters:
domainName - - a domain name
Returns:
an array of user objects' name
Throws:
DKException - if error occurs

listUserNames

public java.lang.String[] listUserNames()
                                 throws DKException,
                                        java.lang.Exception
gets a list of user object names
Returns:
a list of user object names
Throws:
DKException - if error occurs

listUserNames

public java.lang.String[] listUserNames(java.lang.String domainName)
                                 throws DKException,
                                        java.lang.Exception
gets a list of user object names to this admin domain
Parameters:
domainName - -- domain name
Returns:
a list of user object names
Throws:
DKException - if error occurs

listUserDefs

public dkCollection listUserDefs()
                          throws DKException,
                                 java.lang.Exception
gets a list of user objects
Overrides:
listUserDefs in class dkAbstractUserMgmt
Returns:
a collection of user objects
Throws:
DKException - if error occurs

listUserDefs

public dkCollection listUserDefs(java.lang.String domainName)
                          throws DKException,
                                 java.lang.Exception
gets a list of user objects to this admin domain
Parameters:
domainName - - a domain name
Returns:
a collection of user objects
Throws:
DKException - if error occurs

listUserData

public dkCollection listUserData()
                          throws DKException,
                                 java.lang.Exception
Deprecated.  

Gets a collection of DKUserDataFed objects
Returns:
a dkCollection of user data objects

listUserData

public dkCollection listUserData(java.lang.String domainName)
                          throws DKException,
                                 java.lang.Exception
Deprecated.  

Gets a collection of DKUserDataFed objects
Returns:
a dkCollection of user data objects

changePassword

public void changePassword(java.lang.String userName,
                           java.lang.String oldPwd,
                           java.lang.String newPwd)
                    throws DKException,
                           java.lang.Exception
Deprecated.  

Changes the password of a given user name. Administrator only function
Overrides:
changePassword in class dkAbstractUserMgmt

changePassword

public void changePassword(java.lang.String userName,
                           java.lang.String newPwd)
                    throws DKException,
                           java.lang.Exception
Changes the password of a given user name. Administrator only function

changePassword

public void changePassword(java.lang.String newPwd)
                    throws DKException,
                           java.lang.Exception
Changes the password of the logoned user

getCurrentLogonUser

public java.lang.String getCurrentLogonUser()
                                     throws DKException,
                                            java.lang.Exception
Deprecated.  

Gets currently log on user

listUserGroups

public java.lang.String[] listUserGroups()
                                  throws DKException,
                                         java.lang.Exception
Deprecated.  

Lists user groups defined in the system
Overrides:
listUserGroups in class dkAbstractUserMgmt

listUserGroupNames

public java.lang.String[] listUserGroupNames()
                                      throws DKException,
                                             java.lang.Exception
Lists user groups defined in the system

listUserGroups

public java.lang.String[] listUserGroups(java.lang.String domainName)
                                  throws DKException,
                                         java.lang.Exception

listUserGroupNames

public java.lang.String[] listUserGroupNames(java.lang.String domainName)
                                      throws DKException,
                                             java.lang.Exception
Lists user groups defined in the system

listUserGroupDefs

public dkCollection listUserGroupDefs()
                               throws DKException,
                                      java.lang.Exception
gets a list of user group objects
Overrides:
listUserGroupDefs in class dkAbstractUserMgmt
Returns:
a collection of user group objects
Throws:
DKException - if error occurs

listUserGroupDefs

public dkCollection listUserGroupDefs(java.lang.String domainName)
                               throws DKException,
                                      java.lang.Exception
gets a list of user group objects to this admin domain
Returns:
a collection of user objects
Throws:
DKException - if error occurs

retrieveUserGroupDef

public dkUserGroupDef retrieveUserGroupDef(java.lang.String userGroupName)
                                    throws DKException,
                                           java.lang.Exception
Retrieve a user group
Overrides:
retrieveUserGroupDef in class dkAbstractUserMgmt
Returns:
user defintion

getUserGroup

public DKUserGroupDataFed getUserGroup(java.lang.String userGrpName)
                                throws DKException,
                                       java.lang.Exception
Deprecated.  

Get a user group from memory

add

public void add(dkUserGroupDef usrGrpDef)
         throws DKException,
                java.lang.Exception
Creates a new user-group
Overrides:
add in class dkAbstractUserMgmt

addUserGroup

public void addUserGroup(DKUserGroupDataFed sd)
                  throws DKAlreadyExistException,
                         DKException,
                         java.lang.Exception
Deprecated.  

Add a user group. Administrator only function.

update

public void update(dkUserGroupDef usrGrpDef)
            throws DKException,
                   java.lang.Exception
Update a new user-group
Overrides:
update in class dkAbstractUserMgmt

updateUserGroup

public void updateUserGroup(DKUserGroupDataFed sd)
                     throws DKNotExistException,
                            DKException,
                            java.lang.Exception
Deprecated.  

Update a user group. Administrator only function.

delUserGroup

public void delUserGroup(java.lang.String userGrpName)
                  throws DKException,
                         java.lang.Exception
Deletes a user-group from the system
Overrides:
delUserGroup in class dkAbstractUserMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractUserMgmt
See Also:
dkAbstractUserMgmt.deleteUserGroupDef(java.lang.String)

del

public void del(dkUserGroupDef usrGrpDef)
         throws DKException,
                java.lang.Exception
Deletes a user-group from the system
Overrides:
del in class dkAbstractUserMgmt

removeUserGroup

public void removeUserGroup(java.lang.String name)
                     throws DKNotExistException,
                            DKException,
                            java.lang.Exception
Deprecated.  

Remove a user group. Administrator only function.

addToGroup

public void addToGroup(java.lang.String groupName,
                       java.lang.String userName)
                throws DKException,
                       java.lang.Exception
Adds a user to a user-group.
Overrides:
addToGroup in class dkAbstractUserMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractUserMgmt
See Also:
dkAbstractUserMgmt.update(dkUserGroupDef)

addUsersToGroup

public void addUsersToGroup(java.lang.String groupName,
                            java.lang.String[] arUserName)
                     throws DKException,
                            java.lang.Exception
Add an array of users to group. The user array can have one or more than one member. Administrator only function.

removeFromGroup

public void removeFromGroup(java.lang.String groupName,
                            java.lang.String userName)
                     throws DKException,
                            java.lang.Exception
Removes a user from a user-group
Overrides:
removeFromGroup in class dkAbstractUserMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractUserMgmt
See Also:
dkAbstractUserMgmt.update(dkUserGroupDef)

removeUsersFromGroup

public void removeUsersFromGroup(java.lang.String groupName,
                                 java.lang.String[] arUserName)
                          throws DKException,
                                 java.lang.Exception
Deprecated.  

Remove an array of users from a group. The user array can have one or more than one member. Administrator only function.

listGroupUsers

public java.lang.String[] listGroupUsers(java.lang.String groupName)
                                  throws DKException,
                                         java.lang.Exception
List users belonged to a group

listUsersInGroup

public dkCollection listUsersInGroup(java.lang.String groupName)
                              throws DKNotExistException,
                                     DKException,
                                     java.lang.Exception
lists privileges in a privilege group from the persistent store
Parameters:
name - the name of the privilege group whose privileges are to be retrieved from the datastore

listGroupsForUser

public dkCollection listGroupsForUser(java.lang.String userName)
                               throws DKNotExistException,
                                      DKException,
                                      java.lang.Exception
lists groups for the user from the persistent store
Parameters:
name - the name of the user whose groups are to be retrieved from the datastore

listGroupNamesForUser

public java.lang.String[] listGroupNamesForUser(java.lang.String userName)
                                         throws DKException,
                                                java.lang.Exception
lists group names for the user from the persistent store
Parameters:
name - the name of the user whose group names are to be retrieved from the datastore

addGroupCoordinator

public void addGroupCoordinator(java.lang.String grpName,
                                java.lang.String coordinator)
                         throws DKAlreadyExistException,
                                DKException,
                                java.lang.Exception
Deprecated.  

Add a coordinator to a group. Administrator only function.

updateGroupCoordinator

public void updateGroupCoordinator(java.lang.String grpName,
                                   java.lang.String coordinator)
                            throws DKNotExistException,
                                   DKException,
                                   java.lang.Exception
Deprecated.  

Update a coordinator of a group. Administrator only function.

removeGroupCoordinator

public void removeGroupCoordinator(java.lang.String grpName)
                            throws DKNotExistException,
                                   DKException,
                                   java.lang.Exception
Deprecated.  

Remove a coordinator from a group. Administ rator only function.

getGroupCoordinator

public java.lang.String getGroupCoordinator(java.lang.String grpName)
                                     throws DKException,
                                            java.lang.Exception
Deprecated.  

Get a coordinator of a group. Administrator only function.

getWFPotentialCoordinators

public java.lang.String[] getWFPotentialCoordinators()
                                              throws DKException,
                                                     java.lang.Exception
Deprecated.  

Gets an array of potential Workflow coordinator user names. This is the filtered list of users based on their privilege set
Returns:
an array of user names that have the authorithy to be Workflow coordinators

isAdminUser

public boolean isAdminUser(java.lang.String userName)
                    throws DKNotExistException,
                           DKException,
                           java.lang.Exception
Check if userName is a system administrative user name
Overrides:
isAdminUser in class dkAbstractUserMgmt
Parameters:
userName - user name
Returns:
true if user is administrative user, false otherwise
Throws:
DKNotExistException - if the user name is not exist in the system
DKException - if internal error occurs in EIP server
java.lang.Exception - if there is an error occurs on the serser and this method is called from client via RMI.

getUserPrivilege

public dkPrivilegeSet getUserPrivilege(java.lang.String userName)
                                throws DKException,
                                       java.lang.Exception
Deprecated.  

Gets the user privileges
Parameters:
userName - - the userName
Returns:
dkPrivilegeSet object
Throws:
DKException -  

getCommonPrivilege

public DKCommonPrivilege getCommonPrivilege(java.lang.String userName)
                                     throws DKException,
                                            java.lang.Exception
Deprecated.  

Gets the user privileges
Parameters:
userName - - the userName
Returns:
dkPrivilegeSet object
Throws:
DKException -  

checkUser

public int checkUser(java.lang.String name,
                     java.lang.String pwd)
              throws DKNotExistException,
                     DKInvalidPasswordException,
                     DKException,
                     java.lang.Exception
Deprecated.  

Check if user is defined in the database, and retrieve its access privelegs
Parameters:
name - user name
pwd - user password
Returns:
one of these 2 values:
  • Regular User : 0
  • Administrative User : 1
Throws:
DKNotExistException - if the user name is not exist in the system
DKInvalidPasswordException - if the user's password does not match
DKException - if internal error occurs in EIP server
java.lang.Exception - if there is an error occurs on the serser and this method is called from client via RMI.

validateUser

public void validateUser(java.lang.String userName,
                         java.lang.String pwd)
                  throws DKNotExistException,
                         DKInvalidPasswordException,
                         DKException,
                         java.lang.Exception
Deprecated.  

Check if user is defined in the database, and retrieve its access privelegs
Parameters:
name - user name
pwd - user password
Throws:
DKNotExistException - if the user name is not exist in the system
DKInvalidPasswordException - if the user's password does not match
DKException - if internal error occurs in EIP server
java.lang.Exception - if there is an error occurs on the serser and this method is called from client via RMI.

getAccessLevel

public int getAccessLevel()
                   throws java.lang.Exception
Deprecated.  

Get user's access level Regular User : 0 Administrative User : 1

listMapUsers

public dkCollection listMapUsers(java.lang.String user)
                          throws DKException,
                                 java.lang.Exception
List the mapped users belong to the federated user.

addMapUser

public void addMapUser(DKUserMapDataFed md)
                throws DKException,
                       java.lang.Exception
Add a mapped user to the database. Administrator only function.

updateMapUser

public void updateMapUser(DKUserMapDataFed md)
                   throws DKException,
                          java.lang.Exception
Update the mapped user. The Federated user name and server name can't be changed. The password field will also be updated. Administrator only function.

removeMapUser

public void removeMapUser(java.lang.String userName,
                          java.lang.String srvName)
                   throws DKException,
                          java.lang.Exception
Remove the uesr mapping by by user and server name. Administrator only function.
Parameters:
userName - the user name
srvName - the server name

changeMapPassword

public void changeMapPassword(java.lang.String server,
                              java.lang.String newPwd)
                       throws DKException,
                              java.lang.Exception
Changes the mapped password for the logoned user.

listMapUsers

public dkCollection listMapUsers()
                          throws DKException,
                                 java.lang.Exception
List the mapped users ( with server, decrypted password information ) belong to the logoned user.

listGroupMapping

public dkCollection listGroupMapping(java.lang.String grp)
                              throws DKException,
                                     java.lang.Exception
List the mapped users belong to the group.

addGroupMapping

public void addGroupMapping(DKGroupMapDataFed md)
                     throws DKException,
                            java.lang.Exception
Add a mapped group to the database. Administrator only function.

updateGroupMapping

public void updateGroupMapping(DKGroupMapDataFed md)
                        throws DKException,
                               java.lang.Exception
Update a mapped group to the database. Administrator only function.

removeGroupMapping

public void removeGroupMapping(java.lang.String grpName,
                               java.lang.String server)
                        throws DKException,
                               java.lang.Exception
Remove a mapped group to the database. Administrator only function.

addOwnMapUser

public void addOwnMapUser(DKUserMapDataFed md)
                   throws DKException,
                          java.lang.Exception
Add a mapped user for the logoned user to the database.

updateOwnMapUser

public void updateOwnMapUser(DKUserMapDataFed md)
                      throws DKException,
                             java.lang.Exception
Update the mapped user. The server name can't be changed. The password field will also be updated.

changeMapPassword

public void changeMapPassword(java.lang.String server,
                              java.lang.String oldPwd,
                              java.lang.String newPwd)
                       throws DKException,
                              java.lang.Exception
Changes the mapped password for the logoned user.

removeMapUser

public void removeMapUser(java.lang.String srvName)
                   throws DKException,
                          java.lang.Exception
Remove the uesr mapping by mapped server name for the logoned user.
Parameters:
srvName - the server name

setUserMappingEnabled

public void setUserMappingEnabled(boolean b)
                           throws DKException,
                                  java.lang.Exception
Enables or disables the User Mapping option, depending on the value of the parameter b Administrator only function.

isUserMappingEnabled

public boolean isUserMappingEnabled()
                             throws DKException,
                                    java.lang.Exception
Determines whether the User Mapping is enabled

setGroupMappingEnabled

public void setGroupMappingEnabled(boolean b)
                            throws DKException,
                                   java.lang.Exception
Enables or disables the Group Mapping inheritance option, depending on the value of the parameter b Administrator only function.

isGroupMappingEnabled

public boolean isGroupMappingEnabled()
                              throws DKException,
                                     java.lang.Exception
Determines whether the Group Mapping inheritance is enabled

clearCache

public void clearCache()
Clears all cache data
Overrides:
clearCache in class dkAbstractUserMgmt

setTraceEnabled

public void setTraceEnabled(boolean isEnabled)
Sets whether we should turn on trace for debuggin purpose
Parameters:
isEnabled - true if want to turn on trace, false otherwise, default is no trace

isTraceEnabled

public boolean isTraceEnabled()
Checks to see if trace is currently enabled
Returns:
true if trace is enabled, false otherwise

EIP Java APIs

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