| java.lang.Object
 org.enhydra.shark.usergroup.DODSUserGroupManagerAdmin
| DODSUserGroupManagerAdmin | | public class DODSUserGroupManagerAdmin implements UserGroupManagerAdmin(Code) | | Used for managing users, groups and their relations.
author:
Sasa Bojanic, Vladimir Puskas, Tanja Jovanovic
version:
0.1 |
| Method Summary | |
| public void | addGroupToGroup(String groupName, String subgroupName)
Adds an existing group subgroupName to the group groupName. | | public void | addUserToGroup(String groupName, String username)
Adds an existing user with a given username to the given group. | | public void | configure(CallbackUtilities cus)
Method configure is called at Shark start up, to configure implementation of
DODSUserGroupManager. | | public void | createGroup(String groupName, String description)
Creates a new user group. | | public void | createUser(String groupName, String username, String password, String firstName, String lastName, String emailAddress)
Allows administrator to create new user. | | public boolean | doesGroupBelongToGroup(WMSessionHandle shandle, String groupName, String subgroupName)
Returns true if group subgroupName is subgroup of group groupName.
Parameters:
groupName - name of the given group.
Parameters:
subgroupName - name of the given subgroup. | | public boolean | doesGroupExist(WMSessionHandle shandle, String groupName)
Returns true if user group with given name exists.
Parameters:
groupName - name of the given group. | | protected boolean | doesGroupExist(String groupName)
Returns true if user group with given name exists.
Parameters:
groupName - name of the given group. | | public boolean | doesUserBelongToGroup(WMSessionHandle shandle, String groupName, String username)
Returns true if the given user belongs to the given group.
Parameters:
groupName - name of the given group.
Parameters:
username - username used to uniquely identify shark user. | | public boolean | doesUserExist(WMSessionHandle shandle, String username)
Returns true if user with given username exists.
Parameters:
username - username of the shark user. | | protected boolean | doesUserExist(String username)
Returns true if user with given username exists.
Parameters:
username - username of the shark user. | | public String[] | getAllGroupnames(WMSessionHandle shandle)
Returns Ids of all user groups. | | public String[] | getAllGroupnamesForUser(WMSessionHandle shandle, String userName)
Returns Ids of all groups for the given user.
Parameters:
userName - name of the given user. | | public String[] | getAllImmediateSubgroupsForGroup(WMSessionHandle shandle, String groupName)
Returns all groups that are immediate children of the given group (which are on the
first level bellow the level of the given group).
Parameters:
groupName - name of the given group. | | public String[] | getAllImmediateUsersForGroup(WMSessionHandle shandle, String groupName)
Returns all users that are immediate children of the given group.
Parameters:
groupName - name of the given group. | | protected String[] | getAllSubgroupsForGroup(WMSessionHandle shandle, String groupName)
Returns all groups that belong to the given group.
Parameters:
groupName - name of the given group. | | public String[] | getAllSubgroupsForGroups(WMSessionHandle shandle, String[] groupNames)
Returns all groups that belong to the given groups.
Parameters:
groupNames - names of the given groups. | | public String[] | getAllUsers(WMSessionHandle shandle)
Returns Ids of all users. | | protected String[] | getAllUsersForGroup(WMSessionHandle shandle, String groupName)
Returns all usernames that belong to the given group.
Parameters:
groupName - name of the given group. | | public String[] | getAllUsersForGroups(WMSessionHandle shandle, String[] groupNames)
Returns all users that belong to the given groups.
Parameters:
groupNames - names of the given groups. | | protected DBTransaction | getDBTransaction()
| | public String | getGroupDescription(WMSessionHandle shandle, String groupName)
Returns a group description.
Parameters:
groupName - name of the given group. | | public String[] | getGroups(WMSessionHandle sessionHandle, String expression)
| | public String[] | getObjects(WMSessionHandle sessionHandle, String expression)
| | public String | getUserEMailAddress(WMSessionHandle shandle, String username)
Returns string representing email address for the user with the given username.
Parameters:
username - username of the shark user. | | public String | getUserFirstName(WMSessionHandle shandle, String username)
Returns string representing user's first name.
Parameters:
username - username of the shark user. | | public String | getUserLastName(WMSessionHandle shandle, String username)
Returns string representing user's last name.
Parameters:
username - username of the shark user. | | public String | getUserPassword(WMSessionHandle shandle, String username)
| | public String | getUserRealName(WMSessionHandle shandle, String username)
Returns string representing the real name for the shark user with the given username
(first and last name).
Parameters:
username - username of the shark user. | | public void | moveGroup(String currentParentGroup, String newParentGroup, String subgroupName)
Moves group subgroupName from the group currentParentGroup to group
newParentGroup. | | public void | moveUser(String currentGroup, String newGroup, String username)
Moves user username from the group currentGroup to group newGroup. | | protected void | refreshDOCaches()
| | public void | removeGroup(String groupName)
Removes user group. | | public void | removeGroupFromGroup(String groupName, String subgroupName)
Removes group subgroupName from the group groupName. | | public void | removeGroupTree(String groupName)
Deletes group groupName and all its child groups that don't belong to any
other group except this one. | | public void | removeUser(String username)
Allows administrator to remove the user. | | public void | removeUserFromGroup(String groupName, String username)
Removes the user from the group. | | public void | removeUsersFromGroupTree(String groupName)
Removes all users from group group that don't belong to any other group
except this one. | | protected void | setLDBName()
| | public void | setPassword(String username, String password)
Sets user password. | | public void | updateGroup(String groupName, String description)
Allows administrator to update data about group. | | public void | updateUser(String username, String firstName, String lastName, String emailAddress)
Allows administrator to update data about user. | | public boolean | validateUser(String username, String password)
Validates user.
Parameters:
username - user name.
Parameters:
password - user password. |
| addGroupToGroup | | public 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 | | public 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. |
| configure | | public void configure(CallbackUtilities cus) throws Exception(Code) | | Method configure is called at Shark start up, to configure implementation of
DODSUserGroupManager.
Parameters:
cus - an instance of CallbackUtilities used to get properties for configuringuser group manager in Shark.
exception:
Exception - thrown if configuring doesn't succeed. |
| createGroup | | public 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 | | public 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 ismandatory.
Parameters:
username - username used to uniquely identify user - this parameter ismandatory.
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 with given usernamealready exists). |
| doesGroupBelongToGroup | | public boolean doesGroupBelongToGroup(WMSessionHandle shandle, String groupName, String subgroupName) throws Exception(Code) | | Returns true if group subgroupName is subgroup of group groupName.
Parameters:
groupName - name of the given group.
Parameters:
subgroupName - name of the given subgroup. true if group subgroupName is subgroup of group groupName,otherwise false.
throws:
Exception - If something unexpected happens. |
| doesGroupExist | | public boolean doesGroupExist(WMSessionHandle shandle, String groupName) throws Exception(Code) | | Returns true if user group with given name exists.
Parameters:
groupName - name of the given group. true if user group exists, otherwise false.
throws:
Exception - If something unexpected happens. |
| doesGroupExist | | protected boolean doesGroupExist(String groupName) throws Exception(Code) | | Returns true if user group with given name exists.
Parameters:
groupName - name of the given group. true if user group exists, otherwise false.
throws:
Exception - If something unexpected happens. |
| doesUserBelongToGroup | | public boolean doesUserBelongToGroup(WMSessionHandle shandle, String groupName, String username) throws Exception(Code) | | Returns true if the given user belongs to the given group.
Parameters:
groupName - name of the given group.
Parameters:
username - username used to uniquely identify shark user. true if the given user belongs to the given group, otherwise false.
throws:
Exception - If something unexpected happens. |
| doesUserExist | | public boolean doesUserExist(WMSessionHandle shandle, String username) throws Exception(Code) | | Returns true if user with given username exists.
Parameters:
username - username of the shark user. true if the user with the given username exists, otherwise false.
throws:
Exception - If something unexpected happens. |
| doesUserExist | | protected boolean doesUserExist(String username) throws Exception(Code) | | Returns true if user with given username exists.
Parameters:
username - username of the shark user. true if the user with the given username exists, otherwise false.
throws:
Exception - If something unexpected happens. |
| getAllGroupnamesForUser | | public String[] getAllGroupnamesForUser(WMSessionHandle shandle, String userName) throws Exception(Code) | | Returns Ids of all groups for the given user.
Parameters:
userName - name of the given user. List of all group ids for the given user.
throws:
Exception - If something unexpected happens. |
| getAllImmediateSubgroupsForGroup | | public String[] getAllImmediateSubgroupsForGroup(WMSessionHandle shandle, String groupName) throws Exception(Code) | | Returns all groups that are immediate children of the given group (which are on the
first level bellow the level of the given group).
Parameters:
groupName - name of the given group. List of all groups that are immediate children of the given group.
throws:
Exception - If something unexpected happens. |
| getAllImmediateUsersForGroup | | public String[] getAllImmediateUsersForGroup(WMSessionHandle shandle, String groupName) throws Exception(Code) | | Returns all users that are immediate children of the given group.
Parameters:
groupName - name of the given group. List of all immediate (direct) users that belong to the given group.
throws:
Exception - If something unexpected happens. |
| getAllSubgroupsForGroup | | protected String[] getAllSubgroupsForGroup(WMSessionHandle shandle, String groupName) throws Exception(Code) | | Returns all groups that belong to the given group.
Parameters:
groupName - name of the given group. List of all groups that belong to the given group.
throws:
Exception - If something unexpected happens. |
| getAllSubgroupsForGroups | | public String[] getAllSubgroupsForGroups(WMSessionHandle shandle, String[] groupNames) throws Exception(Code) | | Returns all groups that belong to the given groups.
Parameters:
groupNames - names of the given groups. List of all groups that belong to the given groups.
throws:
Exception - If something unexpected happens. |
| getAllUsersForGroup | | protected String[] getAllUsersForGroup(WMSessionHandle shandle, String groupName) throws Exception(Code) | | Returns all usernames that belong to the given group.
Parameters:
groupName - name of the given group. List of all usernames that belong to given group.
throws:
Exception - If something unexpected happens. |
| getAllUsersForGroups | | public String[] getAllUsersForGroups(WMSessionHandle shandle, String[] groupNames) throws Exception(Code) | | Returns all users that belong to the given groups.
Parameters:
groupNames - names of the given groups. List of all users that belong to given groups.
throws:
Exception - If something unexpected happens. |
| getDBTransaction | | protected DBTransaction getDBTransaction() throws Exception(Code) | | |
| getGroupDescription | | public String getGroupDescription(WMSessionHandle shandle, String groupName) throws Exception(Code) | | Returns a group description.
Parameters:
groupName - name of the given group. Group description.
throws:
Exception - If something unexpected happens. |
| getUserEMailAddress | | public String getUserEMailAddress(WMSessionHandle shandle, String username) throws Exception(Code) | | Returns string representing email address for the user with the given username.
Parameters:
username - username of the shark user. Email of the shark user.
throws:
Exception - If something unexpected happens. |
| getUserFirstName | | public String getUserFirstName(WMSessionHandle shandle, String username) throws Exception(Code) | | Returns string representing user's first name.
Parameters:
username - username of the shark user. First name of the shark user.
throws:
Exception - If something unexpected happens. |
| getUserLastName | | public String getUserLastName(WMSessionHandle shandle, String username) throws Exception(Code) | | Returns string representing user's last name.
Parameters:
username - username of the shark user. Last name of the shark user.
throws:
Exception - If something unexpected happens. |
| getUserRealName | | public String getUserRealName(WMSessionHandle shandle, String username) throws Exception(Code) | | Returns string representing the real name for the shark user with the given username
(first and last name).
Parameters:
username - username of the shark user. Real name of the shark user.
throws:
Exception - If something unexpected happens. |
| moveGroup | | public 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 | | public 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 | | public void removeGroup(String groupName) throws Exception(Code) | | Removes user group.
Parameters:
groupName - name of the given group.
throws:
Exception - If something unexpected happens. |
| removeGroupFromGroup | | public 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 | | public 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 | | public 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 with given usernamedoes not exist, or this is a user that can't be removed). |
| removeUserFromGroup | | public 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 | | public 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. |
| setLDBName | | protected void setLDBName()(Code) | | |
| setPassword | | public 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 | | public 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 | | public 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 ismandatory.
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 with given usernamedoes not exist). |
| validateUser | | public boolean validateUser(String username, String password) throws Exception(Code) | | Validates user.
Parameters:
username - user name.
Parameters:
password - user password. true if user is validated, otherwise false.
exception:
Exception - If something unexpected happens. |
|
|