|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
UserGroupManager handles users and groups and their relations in Shark.
Method Summary | |
void |
addGroupToGroup(java.lang.String groupName,
java.lang.String subgroupName)
Adds an existing group subgroupName to the group groupName. |
void |
addUserToGroup(java.lang.String groupName,
java.lang.String username)
Adds an existing user with a given username to the given group. |
void |
createGroup(java.lang.String groupName,
java.lang.String description)
Creates a new user group. |
void |
createUser(java.lang.String groupName,
java.lang.String username,
java.lang.String password,
java.lang.String firstName,
java.lang.String lastName,
java.lang.String emailAddress)
Allows administrator to create new user. |
void |
moveGroup(java.lang.String currentParentGroup,
java.lang.String newParentGroup,
java.lang.String subgroupName)
Moves group subgroupName from the group currentParentGroup to group newParentGroup. |
void |
moveUser(java.lang.String currentGroup,
java.lang.String newGroup,
java.lang.String username)
Moves user username from the group currentGroup to group newGroup. |
void |
removeGroup(java.lang.String groupName)
Removes user group. |
void |
removeGroupFromGroup(java.lang.String groupName,
java.lang.String subgroupName)
Removes group subgroupName from the group groupName. |
void |
removeGroupTree(java.lang.String groupName)
Deletes group groupName and all its child groups that don't belong to any other group except this one. |
void |
removeUser(java.lang.String username)
Allows administrator to remove the user. |
void |
removeUserFromGroup(java.lang.String groupName,
java.lang.String username)
Removes the user from the group. |
void |
removeUsersFromGroupTree(java.lang.String groupName)
Removes all users from group group that don't belong to any other group except this one. |
void |
setPassword(java.lang.String username,
java.lang.String password)
Sets user password. |
void |
updateGroup(java.lang.String groupName,
java.lang.String description)
Allows administrator to update data about group. |
void |
updateUser(java.lang.String username,
java.lang.String firstName,
java.lang.String lastName,
java.lang.String emailAddress)
Allows administrator to update data about user. |
Methods inherited from interface org.enhydra.shark.api.internal.usergroup.UserGroupManager |
configure, doesGroupBelongToGroup, doesGroupExist, doesUserBelongToGroup, doesUserExist, getAllGroupnames, getAllGroupnamesForUser, getAllImmediateSubgroupsForGroup, getAllImmediateUsersForGroup, getAllSubgroupsForGroups, getAllUsers, getAllUsersForGroups, getGroupDescription, getGroups, getObjects, getUserEMailAddress, getUserFirstName, getUserLastName, getUserPassword, getUserRealName, validateUser |
Method Detail |
public void createGroup(java.lang.String groupName, java.lang.String description) throws java.lang.Exception
groupName
- name of the given group.description
- group description.
java.lang.Exception
- If something unexpected happens.public void removeGroup(java.lang.String groupName) throws java.lang.Exception
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.public void updateGroup(java.lang.String groupName, java.lang.String description) throws java.lang.Exception
groupName
- name of the given group.description
- group description.
java.lang.Exception
- If something unexpected happens.public void addGroupToGroup(java.lang.String groupName, java.lang.String subgroupName) throws java.lang.Exception
groupName
- name of the given group.subgroupName
- name of the given subgroup to be added.
java.lang.Exception
- If something unexpected happens.public void removeGroupFromGroup(java.lang.String groupName, java.lang.String subgroupName) throws java.lang.Exception
groupName
- name of the given group.subgroupName
- name of the given subgroup to be removed.
java.lang.Exception
- If something unexpected happens.public void removeGroupTree(java.lang.String groupName) throws java.lang.Exception
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.public void removeUsersFromGroupTree(java.lang.String groupName) throws java.lang.Exception
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.public void moveGroup(java.lang.String currentParentGroup, java.lang.String newParentGroup, java.lang.String subgroupName) throws java.lang.Exception
currentParentGroup
- current group that contains group subgroupName.newParentGroup
- new group where group subgroupName will be moved to.subgroupName
- subgroup that will be moved.
java.lang.Exception
- If something unexpected happens.public void addUserToGroup(java.lang.String groupName, java.lang.String username) throws java.lang.Exception
groupName
- name of the given group.username
- username used to uniquely identify shark user.
java.lang.Exception
- If something unexpected happens.public void removeUserFromGroup(java.lang.String groupName, java.lang.String username) throws java.lang.Exception
groupName
- name of the given group.username
- username used to uniquely identify shark user.
java.lang.Exception
- If something unexpected happens.public void moveUser(java.lang.String currentGroup, java.lang.String newGroup, java.lang.String username) throws java.lang.Exception
currentGroup
- current group that contains the user.newGroup
- new group where the user will be moved to.username
- the user that will be moved.
java.lang.Exception
- If something unexpected happens.public void createUser(java.lang.String groupName, java.lang.String username, java.lang.String password, java.lang.String firstName, java.lang.String lastName, java.lang.String emailAddress) throws java.lang.Exception
groupName
- groupName used to uniquely identify group -
this parameter is mandatory.username
- username used to uniquely identify user -
this parameter is mandatory.password
- password used to authenticate -
this parameter is mandatory.firstName
- the user's first name.lastName
- the user's last name.emailAddress
- email address of the user.
java.lang.Exception
- If something unexpected happens (i.e the user with
given username already exists).public void updateUser(java.lang.String username, java.lang.String firstName, java.lang.String lastName, java.lang.String emailAddress) throws java.lang.Exception
username
- username used to uniquely identify user -
this parameter is mandatory.firstName
- the user's first name.lastName
- the user's last name.emailAddress
- email address of the user.
java.lang.Exception
- If something unexpected happens (i.e the user with
given username does not exist).public void removeUser(java.lang.String username) throws java.lang.Exception
username
- username used to uniquely identify user.
java.lang.Exception
- If something unexpected happens (i.e the user with
given username does not exist, or this is a user that can't be removed).public void setPassword(java.lang.String username, java.lang.String password) throws java.lang.Exception
username
- username of the shark user.password
- new password of the shark user.
java.lang.Exception
- If something unexpected happens.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |