| org.enhydra.shark.api.admin.UserGroupManagerAdmin
All known Subclasses: org.enhydra.shark.usergroup.DODSUserGroupManagerAdmin, org.enhydra.shark.ws.UserGroupManagerAdminWrapper,
| UserGroupManagerAdmin | | public interface UserGroupManagerAdmin extends UserGroupManager(Code) | | UserGroupManager handles users and groups and their relations in Shark.
author:
Sasa Bojanic, Vladimir Puskas, Tanja Jovanovic |
| Method Summary | |
| void | addGroupToGroup(String groupName, String subgroupName)
Adds an existing group subgroupName to the group groupName. | | void | addUserToGroup(String groupName, String username)
Adds an existing user with a given username to the given group. | | void | createGroup(String groupName, String description)
Creates a new user group. | | void | createUser(String groupName, String username, String password, String firstName, String lastName, String emailAddress)
Allows administrator to create new user. | | void | moveGroup(String currentParentGroup, String newParentGroup, String subgroupName)
Moves group subgroupName from the group currentParentGroup to
group newParentGroup. | | void | moveUser(String currentGroup, String newGroup, String username)
Moves user username from the group currentGroup to group
newGroup. | | void | removeGroup(String groupName)
Removes user group. | | void | removeGroupFromGroup(String groupName, String subgroupName)
Removes group subgroupName from the group groupName. | | void | removeGroupTree(String groupName)
Deletes group groupName and all its child groups that don't belong
to any other group except this one. | | void | removeUser(String username)
Allows administrator to remove the user. | | void | removeUserFromGroup(String groupName, String username)
Removes the user from the group. | | void | removeUsersFromGroupTree(String groupName)
Removes all users from group group that don't belong to any other
group except this one. | | void | setPassword(String username, String password)
Sets user password. | | void | updateGroup(String groupName, String description)
Allows administrator to update data about group. | | void | updateUser(String username, String firstName, String lastName, String emailAddress)
Allows administrator to update data about user. |
| addGroupToGroup | | void addGroupToGroup(String groupName, String subgroupName) throws Exception(Code) | | Adds an existing group subgroupName to the group groupName.
Parameters:
groupName - name of the given group.
Parameters:
subgroupName - name of the given subgroup to be added.
throws:
Exception - If something unexpected happens. |
| addUserToGroup | | void addUserToGroup(String groupName, String username) throws Exception(Code) | | Adds an existing user with a given username to the given group.
Parameters:
groupName - name of the given group.
Parameters:
username - username used to uniquely identify shark user.
throws:
Exception - If something unexpected happens. |
| createGroup | | void createGroup(String groupName, String description) throws Exception(Code) | | Creates a new user group.
Parameters:
groupName - name of the given group.
Parameters:
description - group description.
throws:
Exception - If something unexpected happens. |
| createUser | | void createUser(String groupName, String username, String password, String firstName, String lastName, String emailAddress) throws Exception(Code) | | Allows administrator to create new user. After its creation, the client
application will always be able to log onto shark using username and
password defined for the user.
Parameters:
groupName - groupName used to uniquely identify group -this parameter is mandatory.
Parameters:
username - username used to uniquely identify user -this parameter is mandatory.
Parameters:
password - password used to authenticate -this parameter is mandatory.
Parameters:
firstName - the user's first name.
Parameters:
lastName - the user's last name.
Parameters:
emailAddress - email address of the user.
throws:
Exception - If something unexpected happens (i.e the user withgiven username already exists). |
| moveGroup | | void moveGroup(String currentParentGroup, String newParentGroup, String subgroupName) throws Exception(Code) | | Moves group subgroupName from the group currentParentGroup to
group newParentGroup.
Parameters:
currentParentGroup - current group that contains group subgroupName.
Parameters:
newParentGroup - new group where group subgroupName will be moved to.
Parameters:
subgroupName - subgroup that will be moved.
throws:
Exception - If something unexpected happens. |
| moveUser | | void moveUser(String currentGroup, String newGroup, String username) throws Exception(Code) | | Moves user username from the group currentGroup to group
newGroup.
Parameters:
currentGroup - current group that contains the user.
Parameters:
newGroup - new group where the user will be moved to.
Parameters:
username - the user that will be moved.
throws:
Exception - If something unexpected happens. |
| removeGroup | | void removeGroup(String groupName) throws Exception(Code) | | Removes user group.
Parameters:
groupName - name of the given group.
throws:
Exception - If something unexpected happens. |
| removeGroupFromGroup | | void removeGroupFromGroup(String groupName, String subgroupName) throws Exception(Code) | | Removes group subgroupName from the group groupName.
Parameters:
groupName - name of the given group.
Parameters:
subgroupName - name of the given subgroup to be removed.
throws:
Exception - If something unexpected happens. |
| removeGroupTree | | void removeGroupTree(String groupName) throws Exception(Code) | | Deletes group groupName and all its child groups that don't belong
to any other group except this one.
Parameters:
groupName - name of the given group.
throws:
Exception - If something unexpected happens. |
| removeUser | | void removeUser(String username) throws Exception(Code) | | Allows administrator to remove the user.
Parameters:
username - username used to uniquely identify user.
throws:
Exception - If something unexpected happens (i.e the user withgiven username does not exist, or this is a user that can't be removed). |
| removeUserFromGroup | | void removeUserFromGroup(String groupName, String username) throws Exception(Code) | | Removes the user from the group.
Parameters:
groupName - name of the given group.
Parameters:
username - username used to uniquely identify shark user.
throws:
Exception - If something unexpected happens. |
| removeUsersFromGroupTree | | void removeUsersFromGroupTree(String groupName) throws Exception(Code) | | Removes all users from group group that don't belong to any other
group except this one.
Parameters:
groupName - name of the given group.
throws:
Exception - If something unexpected happens. |
| setPassword | | void setPassword(String username, String password) throws Exception(Code) | | Sets user password.
Parameters:
username - username of the shark user.
Parameters:
password - new password of the shark user.
throws:
Exception - If something unexpected happens. |
| updateGroup | | void updateGroup(String groupName, String description) throws Exception(Code) | | Allows administrator to update data about group.
Parameters:
groupName - name of the given group.
Parameters:
description - group description.
throws:
Exception - If something unexpected happens. |
| updateUser | | void updateUser(String username, String firstName, String lastName, String emailAddress) throws Exception(Code) | | Allows administrator to update data about user.
Parameters:
username - username used to uniquely identify user -this parameter is mandatory.
Parameters:
firstName - the user's first name.
Parameters:
lastName - the user's last name.
Parameters:
emailAddress - email address of the user.
throws:
Exception - If something unexpected happens (i.e the user withgiven username does not exist). |
|
|