com.ibm.mm.sdk.common

Class DKUserMgmtICM

  1. java.lang.Object
  2. extended bycom.ibm.mm.sdk.common.dkAbstractUserMgmt
  3. extended bycom.ibm.mm.sdk.common.DKUserMgmtICM
All implemented interfaces:
dkUserManagement, java.io.Serializable
  1. public class DKUserMgmtICM
  2. extends dkAbstractUserMgmt
  3. implements java.io.Serializable
DKUserMgmtICM class is the implementation of the abstract class dkUserMgmt. It represents and processes management functions for user and user group. The class provides facilities to query, retrieve, update, store, and manage objects associated with user and user group
See Also:
com.ibm.mm.sdk.common.dkUserMgmt, Serialized Form

Field Summary

Modifier and Type Field and Description
  1. static
  2. short
 ACTION_ADD
  1. static
  2. short
 ACTION_CHANGE_PSWD
  1. static
  2. short
 ACTION_DELETE
  1. static
  2. short
 ACTION_UPDATE
  1. static
  2. java.lang.String
 VALID_USERNAME_CHARS

Constructor Summary

Constructor and Description
DKUserMgmtICM(dkDatastore ds)
Constructs and initializes an user management class.

Method Summary

Modifier and Type Method and Description
  1. void
 add(dkUserDef userDef)
Adds a user object into the datastore.
  1. void
 add(dkUserGroupDef userGroupDef)
Adds a user group object into the datastore.
  1. void
 changePassword(java.lang.String newPwd)
Changes the password of the currently logged on user.
  1. void
 changePassword(java.lang.String userId,java.lang.String newPwd)
Changes the password of a given user-id.
  1. void
 changePassword(java.lang.String userId,java.lang.String oldPwd,java.lang.String newPwd)
Changes the password of a given user name(user id).
  1. void
 clearCache()
  1. dkUserDef
 createUserDef()
Create a DKUserDefICM instance
  1. dkUserGroupDef
 createUserGroupDef()
Create a DKUserGroupDefICM instance
  1. void
 del(dkUserDef userDef)
Deletes an user object from the datastore.
  1. void
 del(dkUserGroupDef userGroup)
Deletes an user group object from the datastore.
  1. void
 delUser(java.lang.String name)
Deletes an user of the specified name from datastore
  1. void
 delUserGroup(java.lang.String name)
deletes an user group object of the specified name from the datastore
  1. int
 getAccessLevel()
Deprecated.
  1. dkDatastore
 getDatastore()
Gets the reference to the associated datastore object whose users and user groups are managed by this object.
  1. dkUserDef
 getUserDef(java.lang.String name)
Gets a user object from a cache.
  1. java.lang.String
 getUserDomain(java.lang.String name)
adminDomain sshi Gets the user's administrative domain
  1. dkUserGroupDef
 getUserGroupDef(java.lang.String name)
Gets a user group object from a cache.
  1. long
 getUserPrivilege(java.lang.String name)
Gets the user's privilege set code
  1. boolean
 isAdminUser(java.lang.String userName)
Check if userName is a system administrative userid
  1. java.lang.String[]
 listActiveUserNames()
Gets a list of active user object names who are currently logged on to the datastore.
  1. java.lang.String[]
 listActiveUserNames(java.lang.String domainName)
Gets a list of users name who are currently logged on to the specified domain.
  1. dkCollection
 listGroupsForUser(java.lang.String name)
Get a list of user group objects from the datastore to which this user belongs to
  1. dkCollection
 listUserDefs()
gets a list of user objects defined in the datastore.
  1. dkCollection
 listUserDefs(java.lang.String domainName)
Retrieve list of all users belonging to a domain in the system.
  1. dkCollection
 listUserGroupDefs()
gets a list of user group objects defined in the datastore.
  1. dkCollection
 listUserGroupDefs(java.lang.String domainName)
Gets a list of user group object who are assigned to the specified administrative domain.
  1. java.util.Vector
 listUserGroupNameDomain()
Gets a list of user group names and related information defined in the datastore for user groups with names that match the name string that is passed in.
  1. java.util.Vector
 listUserGroupNameDomain(java.lang.String name)
Gets a list of user group names and related information defined in the datastore for user groups with names that match the name string that is passed in.
  1. java.lang.String[]
 listUserGroupNames()
Gets a list of user group names defined in the datastore.
  1. java.lang.String[]
 listUserGroupNames(java.lang.String domainName)
Gets a list of user group object names who are assigned to the specified administrative domain.
  1. java.util.Vector
 listUserNameDomainDesc()
Gets a list of user names and related information defined in the datastore for users with names that match the name string that is passed in.
  1. java.util.Vector
 listUserNameDomainDesc(java.lang.String name)
Gets a list of user names and related information defined in the datastore for users with names that match the name string that is passed in.
  1. java.lang.String[]
 listUserNames()
Gets a list of user names defined in the datastore.
  1. java.lang.String[]
 listUserNames(java.lang.String domainName)
Gets a list of user object names who are assigned to the specified administrative domain.
  1. dkCollection
 listUsersInGroup(java.lang.String name)
Get a list of user object in the specified user group from the datastore
  1. void
 removeUserDef(java.lang.String name)
Removes the specified user from cache.(memory only)
  1. dkUserDef
 retrieveUserDef(java.lang.String name)
Retrieves an user object from the datastore
  1. dkUserDef
 retrieveUserFromDB(java.lang.String name)
Force Retrieving an user object from the datastore
  1. dkUserGroupDef
 retrieveUserGroupDef(java.lang.String name)
Retrieves an user group object from the datastore
  1. dkUserGroupDef
 retrieveUserGroupDef(java.lang.String name,int option)
Retrieves an user group object from the datastore
  1. dkUserGroupDef
 retrieveUserGroupFromDB(java.lang.String name)
Retrieves an user group object from the datastore
  1. dkUserGroupDef
 retrieveUserGroupFromDB(java.lang.String name,int option)
Retrieves an user group object from the datastore
  1. void
 setDatastore(dkDatastore ds)
Sets the datastore object whose users and user groups are managed by this object.
  1. void
 update(dkUserDef userDef)
Updates an user object in the datastore.If cache is enabled, it also updated in the cache.
  1. void
 update(dkUserGroupDef userGroup)
Updates an user group object in the datastore.If cache is enabled, it also updated in the cache.
  1. void
 update(dkUserGroupDef userGroup,java.util.Vector v,int action)
Updates a user group in the datastore.
  1. void
 update(dkUserGroupDef userGroup,java.util.Vector v,int action,int option)
Updates a user group in the datastore.
  1. void
 validateUser(java.lang.String userName,java.lang.String pwd)
Deprecated.
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractUserMgmt
addToGroup, addUser, addUser, addUserGroup, addUserGroup, deleteUserDef, deleteUserGroupDef, listUserGroups, listUsers, removeFromGroup
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACTION_ADD

  1. public static final short ACTION_ADD
See Also:
Constant Field Values

ACTION_UPDATE

  1. public static final short ACTION_UPDATE
See Also:
Constant Field Values

ACTION_DELETE

  1. public static final short ACTION_DELETE
See Also:
Constant Field Values

ACTION_CHANGE_PSWD

  1. public static final short ACTION_CHANGE_PSWD
See Also:
Constant Field Values

VALID_USERNAME_CHARS

  1. public static final java.lang.String VALID_USERNAME_CHARS
See Also:
Constant Field Values

Constructor Detail

DKUserMgmtICM

  1. public DKUserMgmtICM(dkDatastore ds)
Constructs and initializes an user management class.

It initializes authorizationMgmt objects from datastoreAdmin class for handling objects related to user and user group

Parameters:
ds - the owner datastore object
Throws:
DKException - fails to initialize management objects
See Also:
dkDatastoreDef.datastoreAdmin(), datastoreAdmin#authorizationMgmt

Method Detail

setDatastore

  1. public void setDatastore(dkDatastore ds)
Sets the datastore object whose users and user groups are managed by this object.
Specified by:
setDatastore in interface dkUserManagement
Overrides:
setDatastore in class dkAbstractUserMgmt
Parameters:
ds - dkDatastore - datastore object

getDatastore

  1. public dkDatastore getDatastore( )
Gets the reference to the associated datastore object whose users and user groups are managed by this object.
Specified by:
getDatastore in interface dkUserManagement
Overrides:
getDatastore in class dkAbstractUserMgmt
Returns:
objecttarget datastore object whose users and user groups are managed by this obect.

listUserDefs

  1. public dkCollection listUserDefs( )
  2. throws DKException
  3. java.lang.Exception
gets a list of user objects defined in the datastore. If the cache is enabled and if the list is available in the memory then the list is returned from the memory. If not the list is queried from the datastore and cached. Groups to which the user belongs are not part of the user object returned in the collection. Note: If just the user names are required, listUserNames method can be used
Specified by:
listUserDefs in interface dkUserManagement
Overrides:
listUserDefs in class dkAbstractUserMgmt
Returns:
a collection of DKUserDefICM objects.
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs
See Also:
listUserNames.

listActiveUserNames

  1. public java.lang.String[] listActiveUserNames( )
  2. throws DKException
  3. java.lang.Exception
Gets a list of active user object names who are currently logged on to the datastore.
Returns:
A string array of user names who are currently logged on to the datastore.
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listActiveUserNames

  1. public java.lang.String[] listActiveUserNames( java.lang.String domainName)
  2. throws DKException
  3. java.lang.Exception
Gets a list of users name who are currently logged on to the specified domain.
Parameters:
domainName - domain name whose active users are to be listed.
Returns:
A string array of user names who are currently logged on to the specified domain.
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listUserNames

  1. public java.lang.String[] listUserNames( )
  2. throws DKException
  3. java.lang.Exception
Gets a list of user names defined in the datastore. If the cache is enabled and if the list is available in the memory then the list is returned from the memory. If not the list is queried from the datastore and cached.
Returns:
a list of user object names
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listUserNames

  1. public java.lang.String[] listUserNames( java.lang.String domainName)
  2. throws DKException
  3. java.lang.Exception
Gets a list of user object names who are assigned to the specified administrative domain. If the cache is enabled and if the list is available in the memory then the list is returned from the memory. If not the list is queried from the datastore and cached.
Parameters:
domainName - Adminstrative domain name from which the user names are to be listed.
Returns:
A string array of list of user object names who are assigned to the specified administrative domain.
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listUserNameDomainDesc

  1. public java.util.Vector listUserNameDomainDesc( )
  2. throws DKException
  3. java.lang.Exception
Gets a list of user names and related information defined in the datastore for users with names that match the name string that is passed in. This information is always retrieved from library server, and no cache is saved.
Returns:
a vector of String arrays. Each String array contains information of a user, and has five pieces of information:
  • userId
  • userName
  • domainId
  • userPrivCode
  • LDAPInfo
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listUserNameDomainDesc

  1. public java.util.Vector listUserNameDomainDesc( java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
Gets a list of user names and related information defined in the datastore for users with names that match the name string that is passed in. This information is always retrieved from library server, and no cache is saved.
Parameters:
name - the full user name, or any substring of the user name, followed by a wildcard character, "%". For example, "Rob%" will cause the API to return user name related information for all user names that start with "Rob".
Returns:
a vector of String arrays. Each String array contains information of a user, and has five pieces of information:
  • userId
  • userName
  • domainId
  • userPrivCode
  • LDAPInfo
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

add

  1. public void add(dkUserDef userDef)
  2. throws DKAlreadyExistException
  3. DKException
  4. java.lang.Exception
Adds a user object into the datastore. If cache is enabled, it added to the cache. Note: The user name will be uppercased.
Specified by:
add in interface dkUserManagement
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
java.lang.Exception - if error occurs

update

  1. public void update(dkUserDef userDef)
  2. throws DKNotExistException
  3. DKException
  4. java.lang.Exception
Updates an user object in the datastore.If cache is enabled, it also updated in the cache. Note: The user name cannot be updated. Note: Password can not updated if the user use system define password.
Specified by:
update in interface dkUserManagement
Overrides:
update in class dkAbstractUserMgmt
Parameters:
userDef - -- an user object to be updated in the datastore
Throws:
DKNotExistException - if the specified user does not exist.
DKException - if error occurs
java.lang.Exception - if error occurs

retrieveUserDef

  1. public dkUserDef retrieveUserDef( java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
Retrieves an user object from the datastore
Specified by:
retrieveUserDef in interface dkUserManagement
Overrides:
retrieveUserDef in class dkAbstractUserMgmt
Parameters:
name - the name of user to be retrieved
Returns:
user defintion
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

retrieveUserFromDB

  1. public dkUserDef retrieveUserFromDB( java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
Force Retrieving an user object from the datastore
Parameters:
name - the name of user to be retrieved
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

getUserDef

  1. public dkUserDef getUserDef(java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
Gets a user object from a cache. (memory only) Note: the case of the user name is ignored.
Parameters:
name - - the name of the user to be retrieved
Throws:
DKException - if error occurs
java.lang.Exception

del

  1. public void del(dkUserDef userDef)
  2. throws DKNotExistException
  3. DKException
  4. java.lang.Exception
Deletes an user object from the datastore. If cache is enabled, it deleted from the cache.
Specified by:
del in interface dkUserManagement
Overrides:
del in class dkAbstractUserMgmt
Parameters:
userDef - -- an user object to be deleted from the datastore.
Throws:
DKNotExistException - if the specified user does not exist
DKException - if error occurs
java.lang.Exception - if error occurs

delUser

  1. public void delUser(java.lang.String name)
  2. throws DKNotExistException
  3. DKException
  4. java.lang.Exception
Deletes an user of the specified name from datastore
Specified by:
delUser in interface dkUserManagement
Overrides:
delUser in class dkAbstractUserMgmt
Parameters:
name - -- the name of user to be deleted from datastore
Throws:
DKNotExistException - if user object does not exists
DKException - if error occurs
java.lang.Exception - if error occurs
See Also:
dkAbstractUserMgmt.del(dkUserDef)

removeUserDef

  1. public void removeUserDef(java.lang.String name)
  2. throws DKNotExistException
  3. DKException
  4. java.lang.Exception
Removes the specified user from cache.(memory only)
Parameters:
name - - the name of user
Throws:
DKNotExistException - if user object does not exists
DKException - if error occurs
java.lang.Exception - if error occurs

getUserPrivilege

  1. public long getUserPrivilege(java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
Gets the user's privilege set code
Parameters:
name - the user's name whose privilege set code is requested.
Returns:
the user's privilege set code
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

getUserDomain

  1. public java.lang.String getUserDomain( java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
adminDomain sshi Gets the user's administrative domain
Parameters:
name - the user's name whose administrative domain is requested.
Returns:
an administrative domain name to which the specified belongs to.
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listUserGroupDefs

  1. public dkCollection listUserGroupDefs( )
  2. throws DKException
  3. java.lang.Exception
gets a list of user group objects defined in the datastore. If the cache is enabled and if the list is available in the memory then the list is returned from the memory. If not the list is queried from the datastore and cached.. Note: If just the user group names are required, listUserGroupNames method can be used
Specified by:
listUserGroupDefs in interface dkUserManagement
Overrides:
listUserGroupDefs in class dkAbstractUserMgmt
Returns:
a collection of DKUserGroupDefICM objects.
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs
See Also:
listUserGroupNames.

listUserGroupDefs

  1. public dkCollection listUserGroupDefs( java.lang.String domainName)
  2. throws DKException
  3. java.lang.Exception
Gets a list of user group object who are assigned to the specified administrative domain. If the cache is enabled and if the list is available in the memory then the list is returned from the memory. If not the list is queried from the datastore and cached.
Parameters:
domainName - Adminstrative domain name from which the user groups are to be listed.
Returns:
A collection of DKUserGroupDefICM objects who belong to the specified domain.
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listUserGroupNames

  1. public java.lang.String[] listUserGroupNames( )
  2. throws DKException
  3. java.lang.Exception
Gets a list of user group names defined in the datastore. If the cache is enabled and if the list is available in the memory then the list is returned from the memory. If not the list is queried from the datastore and cached.
Returns:
A string array of user group object names
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listUserGroupNameDomain

  1. public java.util.Vector listUserGroupNameDomain( )
  2. throws DKException
  3. java.lang.Exception
Gets a list of user group names and related information defined in the datastore for user groups with names that match the name string that is passed in. This information is always retrieved from library server, and no cache is saved.
Returns:
a vector of String arrays. Each String array contains information of a user group, and has three pieces of information:
  • userGroupId
  • userGroupDomainId
  • userGroupName
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listUserGroupNameDomain

  1. public java.util.Vector listUserGroupNameDomain( java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
Gets a list of user group names and related information defined in the datastore for user groups with names that match the name string that is passed in. This information is always retrieved from library server, and no cache is saved.
Parameters:
name - the full user group name, or any substring of the user group name, followed by a wildcard character, "%". For example, "Rob%" will cause the API to return user group name related information for all user group names that start with "Rob".
Returns:
a vector of String arrays. Each String array contains information of a user group, and has three pieces of information:
  • userGroupId
  • userGroupDomainId
  • userGroupName
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listUserGroupNames

  1. public java.lang.String[] listUserGroupNames( java.lang.String domainName)
  2. throws DKException
  3. java.lang.Exception
Gets a list of user group object names who are assigned to the specified administrative domain. If the cache is enabled and if the list is available in the memory then the list is returned from the memory. If not the list is queried from the datastore and cached.
Parameters:
domainName - Adminstrative domain name from which the user group names are to be listed.
Returns:
A string array of list of user group object names who are assigned to the specified administrative domain.
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

add

  1. public void add(dkUserGroupDef userGroupDef)
  2. throws DKAlreadyExistException
  3. DKException
  4. java.lang.Exception
Adds a user group object into the datastore. If cache is enabled, it added to the cache. Note: The user group name will be uppercased.
Specified by:
add in interface dkUserManagement
Overrides:
add in class dkAbstractUserMgmt
Parameters:
userGroupDef - -- an user group object to be added to the datastore.
Throws:
DKAlreadyExistException - if user group object already exists
DKException - if error occurs
java.lang.Exception - if error occurs

del

  1. public void del(dkUserGroupDef userGroup)
  2. throws DKNotExistException
  3. DKException
  4. java.lang.Exception
Deletes an user group object from the datastore. If cache is enabled, it deleted from the cache.
Specified by:
del in interface dkUserManagement
Overrides:
del in class dkAbstractUserMgmt
Throws:
DKNotExistException - if the specified user group object does not exist
DKException - if error occurs
java.lang.Exception - if error occurs

retrieveUserGroupDef

  1. public dkUserGroupDef retrieveUserGroupDef( java.lang.String name,
  2. int option)
  3. throws DKException
  4. java.lang.Exception
Retrieves an user group object from the datastore
Specified by:
retrieveUserGroupDef in interface dkUserManagement
Overrides:
retrieveUserGroupDef in class dkAbstractUserMgmt
Parameters:
name - the name of user group to be retrieved
option - - option when retrieve user group def
Returns:
user defintion
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

retrieveUserGroupDef

  1. public dkUserGroupDef retrieveUserGroupDef( java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
Retrieves an user group object from the datastore
Specified by:
retrieveUserGroupDef in interface dkUserManagement
Overrides:
retrieveUserGroupDef in class dkAbstractUserMgmt
Parameters:
name - the name of user group to be retrieved
Returns:
user defintion
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

retrieveUserGroupFromDB

  1. public dkUserGroupDef retrieveUserGroupFromDB( java.lang.String name,
  2. int option)
  3. throws DKException
  4. java.lang.Exception
Retrieves an user group object from the datastore
Parameters:
name - the name of user group to be retrieved
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

retrieveUserGroupFromDB

  1. public dkUserGroupDef retrieveUserGroupFromDB( java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
Retrieves an user group object from the datastore
Parameters:
name - the name of user group to be retrieved
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

update

  1. public void update(dkUserGroupDef userGroup,
  2. java.util.Vector v,
  3. int action)
  4. throws DKNotExistException
  5. DKException
  6. java.lang.Exception
Updates a user group in the datastore. Based on the value of the action argument, users in the v argument are either added or deleted from the group. If action == DKUserMgmtICM.ACTION_ADD, then the users in the v argument are added to the group. If this operation fails (such as a user being added already exists in the group), DKException is thrown with the following errorId - DK_ICM_MSG_USERGROUP_ADD_FAILED. If action == DKUserMgmtICM.ACTION_DELETE, users in the v argument are removed from the group. If this operation fails (such as a user being removed does not belong to the group), DKException is thrown with the following errorId - DK_ICM_MSG_USERGROUP_DELETE_FAILED. Note that in case of failure, the operation is rolled back and NONE of the users in the vector are added or removed.
Throws:
DKNotExistException - if the specified user group does not exist in the datastore.
DKException - if error occurs
java.lang.Exception - if error occurs

update

  1. public void update(dkUserGroupDef userGroup,
  2. java.util.Vector v,
  3. int action,
  4. int option)
  5. throws DKNotExistException
  6. DKException
  7. java.lang.Exception
Updates a user group in the datastore. Based on the value of the action argument, users in the v argument are either added or deleted from the group. If action == DKUserMgmtICM.ACTION_ADD, then the users in the v argument are added to the group. If this operation fails (such as a user being added already exists in the group), DKException is thrown with the following errorId - DK_ICM_MSG_USERGROUP_ADD_FAILED. If action == DKUserMgmtICM.ACTION_DELETE, users in the v argument are removed from the group. If this operation fails (such as a user being removed does not belong to the group), and DK_CM_DO_NOT_ROLLBACK_ON_ERROR bit mask is set in the option argument, the transaction is still COMMITTED without the user in error. However, at the end of the operation DKException will be thrown with the following errorId - DK_ICM_MSG_USERGROUP_DELETE_FAILED. If DK_CM_DO_NOT_ROLLBACK_ON_ERROR bitmask is not set in the option argument, the operation fails and none of the users are removed from the group. DKException is thrown with the following errorId - DK_ICM_MSG_USERGROUP_DELETE_FAILED. Note that the bitmask DK_CM_DO_NOT_ROLLBACK_ON_ERROR associated with option is applicable only if the value for action is DKUserMgmtICM.ACTION_DELETE.
Throws:
DKNotExistException - if the specified user group does not exist in the datastore.
DKException - if error occurs
java.lang.Exception - if error occurs

update

  1. public void update(dkUserGroupDef userGroup)
  2. throws DKNotExistException
  3. DKException
  4. java.lang.Exception
Updates an user group object in the datastore.If cache is enabled, it also updated in the cache. Note: The user group name cannot be updated.
Specified by:
update in interface dkUserManagement
Overrides:
update in class dkAbstractUserMgmt
Throws:
DKNotExistException - if the specified user group object does not exist
DKException - if error occurs
java.lang.Exception - if error occurs

delUserGroup

  1. public void delUserGroup(java.lang.String name)
  2. throws DKNotExistException
  3. DKException
  4. java.lang.Exception
deletes an user group object of the specified name from the datastore
Specified by:
delUserGroup in interface dkUserManagement
Overrides:
delUserGroup in class dkAbstractUserMgmt
Parameters:
name - -- user group object name to be deleted
Throws:
DKNotExistException - if the specified user group object does not exist
DKException - if error occurs
java.lang.Exception - if error occurs
See Also:
dkAbstractUserMgmt.deleteUserGroupDef(java.lang.String)

getUserGroupDef

  1. public dkUserGroupDef getUserGroupDef( java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
Gets a user group object from a cache. (memory only) Note: the case of the user group name is ignored.
Parameters:
name - - the name of the user group to be retrieved
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listUsersInGroup

  1. public dkCollection listUsersInGroup( java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
Get a list of user object in the specified user group from the datastore
Parameters:
name - the name of the usre group
Returns:
A collection of DKUserDefICM object
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

listGroupsForUser

  1. public dkCollection listGroupsForUser( java.lang.String name)
  2. throws DKException
  3. java.lang.Exception
Get a list of user group objects from the datastore to which this user belongs to
Parameters:
name - -- the name of the user whose groups are to be retrieved from the datastore
Returns:
A collection of DKUserGroupDefICM object which this user belongs to
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

changePassword

  1. public void changePassword(java.lang.String userId,
  2. java.lang.String oldPwd,
  3. java.lang.String newPwd)
  4. throws DKException
  5. java.lang.Exception
Changes the password of a given user name(user id). The password string can be 31 characters long Note: the old password is ignored.
Specified by:
changePassword in interface dkUserManagement
Overrides:
changePassword in class dkAbstractUserMgmt
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

changePassword

  1. public void changePassword(java.lang.String userId,
  2. java.lang.String newPwd)
  3. throws DKException
  4. java.lang.Exception
Changes the password of a given user-id. Administrator only function The password string can be 31 characters long
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

changePassword

  1. public void changePassword(java.lang.String newPwd)
  2. throws DKException
  3. java.lang.Exception
Changes the password of the currently logged on user. Note: This methods is similar to the changePassword(String userId, String newPwd) method
Throws:
DKException - if error occurs
java.lang.Exception - if error occurs

validateUser

  1. public void validateUser(java.lang.String userName,
  2. java.lang.String pwd)
  3. throws DKNotExistException
  4. DKException
  5. java.lang.Exception
Deprecated.
Check whether the user exist or not in the datastore.
Throws:
DKNotExistException - if the specified user does not exist
DKException - if error occurs
java.lang.Exception - if error occurs

getAccessLevel

  1. public int getAccessLevel()
  2. throws java.lang.Exception
Deprecated.
Get user's access level Regular User : 0 Administrative User : 1
Throws:
java.lang.Exception

isAdminUser

  1. public boolean isAdminUser(java.lang.String userName)
  2. throws DKNotExistException
  3. DKException
  4. java.lang.Exception
Check if userName is a system administrative userid
Specified by:
isAdminUser in interface dkUserManagement
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.

clearCache

  1. public void clearCache()
  2. throws DKException
  3. java.lang.Exception
Description copied from class: dkAbstractUserMgmt
Clear datastore cache

Note:DKUsageError exception thrown if method is not implemented

Specified by:
clearCache in interface dkUserManagement
Overrides:
clearCache in class dkAbstractUserMgmt
Throws:
DKException
java.lang.Exception

createUserDef

  1. public dkUserDef createUserDef( )
Create a DKUserDefICM instance
Specified by:
createUserDef in interface dkUserManagement
Overrides:
createUserDef in class dkAbstractUserMgmt
Returns:
userDef object

createUserGroupDef

  1. public dkUserGroupDef createUserGroupDef( )
Create a DKUserGroupDefICM instance
Specified by:
createUserGroupDef in interface dkUserManagement
Overrides:
createUserGroupDef in class dkAbstractUserMgmt
Returns:
userGroupDef object

listUserDefs

  1. public dkCollection listUserDefs( java.lang.String domainName)
  2. throws DKException
  3. java.lang.Exception
Retrieve list of all users belonging to a domain in the system. The collection of users returned are populated with all its properties. Groups to which the user belongs are not part of the user object returned in the collection.
Parameters:
domainName - name of domain whoe users are to be fetched
Returns:
collection of user groups- DKUserGroupDefICM objects
Throws:
DKNotExistException - if the user name is not exist in the system
DKException - if internal error occurs
java.lang.Exception - if there is an error occurs on the serser and this method is called from client via RMI.