|
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.DKUserMgmtFed
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
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.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 |
public void setDatastore(dkDatastore ds)
setDatastore
in class dkAbstractUserMgmt
ds
- dkDatastore - datastore objectpublic void adminOnly() throws DKException, java.lang.Exception
public dkUserDef createUserDef() throws DKException, java.lang.Exception
createUserDef
in class dkAbstractUserMgmt
public dkUserGroupDef createUserGroupDef() throws DKException, java.lang.Exception
createUserGroupDef
in class dkAbstractUserMgmt
public void add(dkUserDef userDef) throws DKAlreadyExistException, DKException, java.lang.Exception
add
in class dkAbstractUserMgmt
userDef
- -- an user object to be added to the datastoreDKAlreadyExistException
- if user object already existsDKException
- if error occurspublic void addUser(DKUserDataFed sd) throws DKAlreadyExistException, DKException, java.lang.Exception
public void update(dkUserDef userDef) throws DKException, java.lang.Exception
update
in class dkAbstractUserMgmt
userDef
- -- an user object to be updatedDKNotExistException,
- DKException if error occurspublic void updateUser(DKUserDataFed sd) throws DKNotExistException, DKException, java.lang.Exception
public dkUserDef retrieveUserDef(java.lang.String userName) throws DKException, java.lang.Exception
retrieveUserDef
in class dkAbstractUserMgmt
name
- -- the name of user to be retrievedDKException
- if error occurspublic DKUserDataFed getUser(java.lang.String userName) throws DKException, java.lang.Exception
public void removeUser(java.lang.String userName) throws DKNotExistException, DKException, java.lang.Exception
public void delUser(java.lang.String userName) throws DKNotExistException, DKException, java.lang.Exception
delUser
in class dkAbstractUserMgmt
userName
- -- name of the user object to be deletedDKNotExistException,
- DKException, Exception if error occurspublic void del(dkUserDef userDef) throws DKException, java.lang.Exception
del
in class dkAbstractUserMgmt
userDef
- -- an user object to be deletedDKNotExistException,
- DKException, Exception if error occurspublic java.lang.String[] listUsers() throws DKException, java.lang.Exception
listUsers
in class dkAbstractUserMgmt
DKException
- if error occurspublic java.lang.String[] listUsers(java.lang.String domainName) throws DKException, java.lang.Exception
domainName
- - a domain nameDKException
- if error occurspublic java.lang.String[] listUserNames() throws DKException, java.lang.Exception
DKException
- if error occurspublic java.lang.String[] listUserNames(java.lang.String domainName) throws DKException, java.lang.Exception
domainName
- -- domain nameDKException
- if error occurspublic dkCollection listUserDefs() throws DKException, java.lang.Exception
listUserDefs
in class dkAbstractUserMgmt
DKException
- if error occurspublic dkCollection listUserDefs(java.lang.String domainName) throws DKException, java.lang.Exception
domainName
- - a domain nameDKException
- if error occurspublic dkCollection listUserData() throws DKException, java.lang.Exception
public dkCollection listUserData(java.lang.String domainName) throws DKException, java.lang.Exception
public void changePassword(java.lang.String userName, java.lang.String oldPwd, java.lang.String newPwd) throws DKException, java.lang.Exception
changePassword
in class dkAbstractUserMgmt
public void changePassword(java.lang.String userName, java.lang.String newPwd) throws DKException, java.lang.Exception
public void changePassword(java.lang.String newPwd) throws DKException, java.lang.Exception
public java.lang.String getCurrentLogonUser() throws DKException, java.lang.Exception
public java.lang.String[] listUserGroups() throws DKException, java.lang.Exception
listUserGroups
in class dkAbstractUserMgmt
public java.lang.String[] listUserGroupNames() throws DKException, java.lang.Exception
public java.lang.String[] listUserGroups(java.lang.String domainName) throws DKException, java.lang.Exception
public java.lang.String[] listUserGroupNames(java.lang.String domainName) throws DKException, java.lang.Exception
public dkCollection listUserGroupDefs() throws DKException, java.lang.Exception
listUserGroupDefs
in class dkAbstractUserMgmt
DKException
- if error occurspublic dkCollection listUserGroupDefs(java.lang.String domainName) throws DKException, java.lang.Exception
DKException
- if error occurspublic dkUserGroupDef retrieveUserGroupDef(java.lang.String userGroupName) throws DKException, java.lang.Exception
retrieveUserGroupDef
in class dkAbstractUserMgmt
public DKUserGroupDataFed getUserGroup(java.lang.String userGrpName) throws DKException, java.lang.Exception
public void add(dkUserGroupDef usrGrpDef) throws DKException, java.lang.Exception
add
in class dkAbstractUserMgmt
public void addUserGroup(DKUserGroupDataFed sd) throws DKAlreadyExistException, DKException, java.lang.Exception
public void update(dkUserGroupDef usrGrpDef) throws DKException, java.lang.Exception
update
in class dkAbstractUserMgmt
public void updateUserGroup(DKUserGroupDataFed sd) throws DKNotExistException, DKException, java.lang.Exception
public void delUserGroup(java.lang.String userGrpName) throws DKException, java.lang.Exception
delUserGroup
in class dkAbstractUserMgmt
com.ibm.mm.sdk.common.dkAbstractUserMgmt
dkAbstractUserMgmt.deleteUserGroupDef(java.lang.String)
public void del(dkUserGroupDef usrGrpDef) throws DKException, java.lang.Exception
del
in class dkAbstractUserMgmt
public void removeUserGroup(java.lang.String name) throws DKNotExistException, DKException, java.lang.Exception
public void addToGroup(java.lang.String groupName, java.lang.String userName) throws DKException, java.lang.Exception
addToGroup
in class dkAbstractUserMgmt
com.ibm.mm.sdk.common.dkAbstractUserMgmt
dkAbstractUserMgmt.update(dkUserGroupDef)
public void addUsersToGroup(java.lang.String groupName, java.lang.String[] arUserName) throws DKException, java.lang.Exception
public void removeFromGroup(java.lang.String groupName, java.lang.String userName) throws DKException, java.lang.Exception
removeFromGroup
in class dkAbstractUserMgmt
com.ibm.mm.sdk.common.dkAbstractUserMgmt
dkAbstractUserMgmt.update(dkUserGroupDef)
public void removeUsersFromGroup(java.lang.String groupName, java.lang.String[] arUserName) throws DKException, java.lang.Exception
public java.lang.String[] listGroupUsers(java.lang.String groupName) throws DKException, java.lang.Exception
public dkCollection listUsersInGroup(java.lang.String groupName) throws DKNotExistException, DKException, java.lang.Exception
name
- the name of the privilege group whose privileges are to be retrieved from the datastorepublic dkCollection listGroupsForUser(java.lang.String userName) throws DKNotExistException, DKException, java.lang.Exception
name
- the name of the user whose groups are to be retrieved from the datastorepublic java.lang.String[] listGroupNamesForUser(java.lang.String userName) throws DKException, java.lang.Exception
name
- the name of the user whose group names are to be retrieved from the datastorepublic void addGroupCoordinator(java.lang.String grpName, java.lang.String coordinator) throws DKAlreadyExistException, DKException, java.lang.Exception
public void updateGroupCoordinator(java.lang.String grpName, java.lang.String coordinator) throws DKNotExistException, DKException, java.lang.Exception
public void removeGroupCoordinator(java.lang.String grpName) throws DKNotExistException, DKException, java.lang.Exception
public java.lang.String getGroupCoordinator(java.lang.String grpName) throws DKException, java.lang.Exception
public java.lang.String[] getWFPotentialCoordinators() throws DKException, 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 dkPrivilegeSet getUserPrivilege(java.lang.String userName) throws DKException, java.lang.Exception
userName
- - the userNameDKException
- public DKCommonPrivilege getCommonPrivilege(java.lang.String userName) throws DKException, java.lang.Exception
userName
- - the userNameDKException
- public int checkUser(java.lang.String name, java.lang.String pwd) throws DKNotExistException, DKInvalidPasswordException, DKException, java.lang.Exception
name
- user namepwd
- user passwordDKNotExistException
- if the user name is not exist in the systemDKInvalidPasswordException
- if the user's password does not matchDKException
- 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 validateUser(java.lang.String userName, java.lang.String pwd) throws DKNotExistException, DKInvalidPasswordException, DKException, java.lang.Exception
name
- user namepwd
- user passwordDKNotExistException
- if the user name is not exist in the systemDKInvalidPasswordException
- if the user's password does not matchDKException
- 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 int getAccessLevel() throws java.lang.Exception
public dkCollection listMapUsers(java.lang.String user) throws DKException, java.lang.Exception
public void addMapUser(DKUserMapDataFed md) throws DKException, java.lang.Exception
public void updateMapUser(DKUserMapDataFed md) throws DKException, java.lang.Exception
public void removeMapUser(java.lang.String userName, java.lang.String srvName) throws DKException, java.lang.Exception
userName
- the user namesrvName
- the server namepublic void changeMapPassword(java.lang.String server, java.lang.String newPwd) throws DKException, java.lang.Exception
public dkCollection listMapUsers() throws DKException, java.lang.Exception
public dkCollection listGroupMapping(java.lang.String grp) throws DKException, java.lang.Exception
public void addGroupMapping(DKGroupMapDataFed md) throws DKException, java.lang.Exception
public void updateGroupMapping(DKGroupMapDataFed md) throws DKException, java.lang.Exception
public void removeGroupMapping(java.lang.String grpName, java.lang.String server) throws DKException, java.lang.Exception
public void addOwnMapUser(DKUserMapDataFed md) throws DKException, java.lang.Exception
public void updateOwnMapUser(DKUserMapDataFed md) throws DKException, java.lang.Exception
public void changeMapPassword(java.lang.String server, java.lang.String oldPwd, java.lang.String newPwd) throws DKException, java.lang.Exception
public void removeMapUser(java.lang.String srvName) throws DKException, java.lang.Exception
srvName
- the server namepublic void setUserMappingEnabled(boolean b) throws DKException, java.lang.Exception
public boolean isUserMappingEnabled() throws DKException, java.lang.Exception
public void setGroupMappingEnabled(boolean b) throws DKException, java.lang.Exception
public boolean isGroupMappingEnabled() throws DKException, java.lang.Exception
public void clearCache()
clearCache
in class dkAbstractUserMgmt
public void setTraceEnabled(boolean isEnabled)
isEnabled
- true if want to turn on trace, false otherwise, default is no tracepublic boolean isTraceEnabled()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |