|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractUserMgmt | +--com.ibm.mm.sdk.common.DKUserMgmtICM
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
com.ibm.mm.sdk.common.dkUserMgmt
, Serialized FormFields 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.DKMessageIdICM |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantICM |
For details, see the class or interface |
Method Summary | |
void |
add(dkUserDef userDef)
Adds a user object into the datastore. |
void |
add(dkUserGroupDef userGroupDef)
Adds a user group object into the datastore. |
void |
changePassword(java.lang.String newPwd)
Changes the password of the currently logged on user. |
void |
changePassword(java.lang.String userId,
java.lang.String newPwd)
Changes the password of a given user-id. |
void |
changePassword(java.lang.String userId,
java.lang.String oldPwd,
java.lang.String newPwd)
Changes the password of a given user name(user id). |
void |
clearCache()
Clears all cache data The lists: user list, user group List, user name List, user group name List, will be cleared. |
dkUserDef |
createUserDef()
Create a DKUserDefICM instance |
dkUserGroupDef |
createUserGroupDef()
Create a DKUserGroupDefICM instance |
void |
del(dkUserDef userDef)
Deletes an user object from the datastore. |
void |
del(dkUserGroupDef userGroupDef)
Deletes an user group object from the datastore. |
void |
delUser(java.lang.String name)
Deletes an user of the specified name from datastore |
void |
delUserGroup(java.lang.String name)
deletes an user group object of the specified name from the datastore |
int |
getAccessLevel()
Deprecated. |
dkDatastore |
getDatastore()
Gets the reference to the associated datastore object whose users and user groups are managed by this object. |
dkUserDef |
getUserDef(java.lang.String name)
Gets a user object from a cache. |
java.lang.String |
getUserDomain(java.lang.String name)
adminDomain sshi Gets the user's administrative domain |
dkUserGroupDef |
getUserGroupDef(java.lang.String name)
Gets a user group object from a cache. |
long |
getUserPrivilege(java.lang.String name)
Gets the user's privilege set code |
boolean |
isAdminUser(java.lang.String userName)
Check if userName is a system administrative userid |
java.lang.String[] |
listActiveUserNames()
Gets a list of active user object names who are currently logged on to the datastore. |
java.lang.String[] |
listActiveUserNames(java.lang.String domainName)
Gets a list of users name who are currently logged on to the specified domain. |
dkCollection |
listGroupsForUser(java.lang.String name)
Get a list of user group objects from the datastore to which this user belongs to |
dkCollection |
listUserDefs()
gets a list of user objects defined in the datastore. |
dkCollection |
listUserGroupDefs()
gets a list of user group objects defined in the datastore. |
dkCollection |
listUserGroupDefs(java.lang.String domainName)
Gets a list of user group object who are assigned to the specified administrative domain. |
java.lang.String[] |
listUserGroupNames()
Gets a list of user group names defined in the datastore. |
java.lang.String[] |
listUserGroupNames(java.lang.String domainName)
Gets a list of user group object names who are assigned to the specified administrative domain. |
java.lang.String[] |
listUserGroups()
Gets a list of user group names defined in the datastore. |
java.lang.String[] |
listUserGroups(java.lang.String domainName)
Gets a list of user group names who are assigned to the specified administrative domain. |
java.lang.String[] |
listUserNames()
Gets a list of user names defined in the datastore. |
java.lang.String[] |
listUserNames(java.lang.String domainName)
Gets a list of user object names who are assigned to the specified administrative domain. |
java.lang.String[] |
listUsers()
Gets a list of user names defined in the datastore. |
java.lang.String[] |
listUsers(java.lang.String domainName)
Gets a list of user names who are assigned to the specified administrative domain. |
dkCollection |
listUsersInGroup(java.lang.String name)
Get a list of user object in the specified user group from the datastore |
void |
removeUserDef(java.lang.String name)
Removes the specified user from cache.(memory only) |
dkUserDef |
retrieveUserDef(java.lang.String name)
Retrieves an user object from the datastore |
dkUserGroupDef |
retrieveUserGroupDef(java.lang.String name)
Retrieves an user group object from the datastore |
void |
setDatastore(dkDatastore ds)
Sets the datastore object whose users and user groups are managed by this object. |
void |
update(dkUserDef userDef)
Updates an user object in the datastore.If cache is enabled, it also updated in the cache. |
void |
update(dkUserGroupDef userGroupDef)
Updates an user group object in the datastore.If cache is enabled, it also updated in the cache. |
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, removeFromGroup |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public void setDatastore(dkDatastore ds)
setDatastore
in class dkAbstractUserMgmt
ds
- dkDatastore - datastore objectpublic dkDatastore getDatastore()
getDatastore
in class dkAbstractUserMgmt
public dkCollection listUserDefs() throws DKException, java.lang.Exception
listUserDefs
in class dkAbstractUserMgmt
DKException
- if error occursjava.lang.Exception
- if error occurslistUserNames.
public java.lang.String[] listActiveUserNames() throws DKException, java.lang.Exception
DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listActiveUserNames(java.lang.String domainName) throws DKException, java.lang.Exception
domainName
- domain name whose active users are to be listed.DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listUserNames() throws DKException, java.lang.Exception
DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listUserNames(java.lang.String domainName) throws DKException, java.lang.Exception
domainName
- Adminstrative domain name from which the user names are to be listed.DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listUsers() throws DKException, java.lang.Exception
this method turns around and calls listUserNames(). These two methodes, listUsers and listUserNames are the same
listUsers
in class dkAbstractUserMgmt
DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listUsers(java.lang.String domainName) throws DKException, java.lang.Exception
this method turns around and calls listUserNames(String domainName). These two methods, listUsers(String domainName) and listUserNames(String domainName) are the same
domainName
- Administrative domain name from which the user names are to be listed.DKException
- if error occursjava.lang.Exception
- if error occurspublic void add(dkUserDef userDef) throws DKAlreadyExistException, DKException, java.lang.Exception
add
in class dkAbstractUserMgmt
userDef
- -- an user object to be added to the datastore.DKAlreadyExistException
- if user object already existsDKException
- if error occursjava.lang.Exception
- if error occurspublic void update(dkUserDef userDef) throws DKNotExistException, DKException, java.lang.Exception
update
in class dkAbstractUserMgmt
userDef
- -- an user object to be updated in the datastoreDKNotExistException
- if the specified user does not exist.DKException
- if error occursjava.lang.Exception
- if error occurspublic dkUserDef retrieveUserDef(java.lang.String name) throws DKException, java.lang.Exception
retrieveUserDef
in class dkAbstractUserMgmt
name
- the name of user to be retrievedDKException
- if error occursjava.lang.Exception
- if error occurspublic dkUserDef getUserDef(java.lang.String name) throws DKException, java.lang.Exception
name
- - the name of the user to be retrievedDKException
- if error occurspublic void del(dkUserDef userDef) throws DKNotExistException, DKException, java.lang.Exception
del
in class dkAbstractUserMgmt
userDef
- -- an user object to be deleted from the datastore.DKNotExistException
- if the specified user does not existDKException
- if error occursjava.lang.Exception
- if error occurspublic void delUser(java.lang.String name) throws DKNotExistException, DKException, java.lang.Exception
delUser
in class dkAbstractUserMgmt
name
- -- the name of user to be deleted from datastoreDKNotExistException
- if user object does not existsDKException
- if error occursjava.lang.Exception
- if error occurspublic void removeUserDef(java.lang.String name) throws DKNotExistException, DKException, java.lang.Exception
name
- - the name of userDKNotExistException
- if user object does not existsDKException
- if error occursjava.lang.Exception
- if error occurspublic long getUserPrivilege(java.lang.String name) throws DKException, java.lang.Exception
name
- the user's name whose privilege set code is requested.DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String getUserDomain(java.lang.String name) throws DKException, java.lang.Exception
name
- the user's name whose administrative domain is requested.DKException
- if error occursjava.lang.Exception
- if error occurspublic dkCollection listUserGroupDefs() throws DKException, java.lang.Exception
listUserGroupDefs
in class dkAbstractUserMgmt
DKException
- if error occursjava.lang.Exception
- if error occurslistUserGroupNames.
public dkCollection listUserGroupDefs(java.lang.String domainName) throws DKException, java.lang.Exception
domainName
- Adminstrative domain name from which the user groups are to be listed.DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listUserGroupNames() throws DKException, java.lang.Exception
DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listUserGroupNames(java.lang.String domainName) throws DKException, java.lang.Exception
domainName
- Adminstrative domain name from which the user group names are to be listed.DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listUserGroups() throws DKException, java.lang.Exception
this method turns around and calls listUserGroupNames(). These two methods, listUserGroups and listUserGroupNames are the same
listUserGroups
in class dkAbstractUserMgmt
DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listUserGroups(java.lang.String domainName) throws DKException, java.lang.Exception
this method turns around and calls listUserGroupNames(String domainName). These two methods, listUserGroups(String domainName) and listUserGroupNames(String domainName) are the same
domainName
- Administrative domain name from which the user names are to be listed.DKException
- if error occursjava.lang.Exception
- if error occurspublic void add(dkUserGroupDef userGroupDef) throws DKAlreadyExistException, DKException, java.lang.Exception
add
in class dkAbstractUserMgmt
userGroupDef
- -- an user group object to be added to the datastore.DKAlreadyExistException
- if user group object already existsDKException
- if error occursjava.lang.Exception
- if error occurspublic void del(dkUserGroupDef userGroupDef) throws DKNotExistException, DKException, java.lang.Exception
del
in class dkAbstractUserMgmt
userGroupDef
- -- an user group object to be deleted from the datastore.DKNotExistException
- if the specified user group object does not existDKException
- if error occursjava.lang.Exception
- if error occurspublic dkUserGroupDef retrieveUserGroupDef(java.lang.String name) throws DKException, java.lang.Exception
retrieveUserGroupDef
in class dkAbstractUserMgmt
name
- the name of user group to be retrievedDKException
- if error occursjava.lang.Exception
- if error occurspublic void update(dkUserGroupDef userGroupDef) throws DKNotExistException, DKException, java.lang.Exception
update
in class dkAbstractUserMgmt
userGroupDef
- -- an user group object to be updated in the datastoreDKNotExistException
- if the specified user group object does not existDKException
- if error occursjava.lang.Exception
- if error occurspublic void delUserGroup(java.lang.String name) throws DKNotExistException, DKException, java.lang.Exception
delUserGroup
in class dkAbstractUserMgmt
name
- -- user group object name to be deletedDKNotExistException
- if the specified user group object does not existDKException
- if error occursjava.lang.Exception
- if error occurspublic dkUserGroupDef getUserGroupDef(java.lang.String name) throws DKException, java.lang.Exception
name
- - the name of the user group to be retrievedDKException
- if error occursjava.lang.Exception
- if error occurspublic dkCollection listUsersInGroup(java.lang.String name) throws DKException, java.lang.Exception
name
- the name of the usre groupDKException
- if error occursjava.lang.Exception
- if error occurspublic dkCollection listGroupsForUser(java.lang.String name) throws DKException, java.lang.Exception
name
- -- the name of the user whose groups are to be retrieved from the datastoreDKException
- if error occursjava.lang.Exception
- if error occurspublic void changePassword(java.lang.String userId, java.lang.String oldPwd, java.lang.String newPwd) throws DKException, java.lang.Exception
changePassword
in class dkAbstractUserMgmt
DKException
- if error occursjava.lang.Exception
- if error occurspublic void changePassword(java.lang.String userId, java.lang.String newPwd) throws DKException, java.lang.Exception
DKException
- if error occursjava.lang.Exception
- if error occurspublic void changePassword(java.lang.String newPwd) throws DKException, java.lang.Exception
DKException
- if error occursjava.lang.Exception
- if error occurspublic void validateUser(java.lang.String userName, java.lang.String pwd) throws DKNotExistException, DKException, java.lang.Exception
DKNotExistException
- if the specified user does not existDKException
- if error occursjava.lang.Exception
- if error occurspublic int getAccessLevel() throws java.lang.Exception
public boolean isAdminUser(java.lang.String userName) throws DKNotExistException, DKException, java.lang.Exception
isAdminUser
in class dkAbstractUserMgmt
userName
- user nameDKNotExistException
- if the user name is not exist in the systemDKException
- if internal error occurs in EIP serverjava.lang.Exception
- if there is an error occurs on the serser and this method
is called from client via RMI.public void clearCache()
clearCache
in class dkAbstractUserMgmt
public dkUserDef createUserDef()
createUserDef
in class dkAbstractUserMgmt
com.ibm.mm.sdk.common.dkAbstractUserMgmt
public dkUserGroupDef createUserGroupDef()
createUserGroupDef
in class dkAbstractUserMgmt
com.ibm.mm.sdk.common.dkAbstractUserMgmt
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |