|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserGroupManager
UserGroupManager handles users and groups and their relations in Shark.
Method Summary | |
---|---|
void |
configure(CallbackUtilities cus)
Method configure is called at Shark start up, to configure implementation of UserGroupManager. |
boolean |
doesGroupBelongToGroup(WMSessionHandle shandle,
java.lang.String groupName,
java.lang.String subgroupName)
Returns true if group subgroupName is subgroup of group groupName. |
boolean |
doesGroupExist(WMSessionHandle shandle,
java.lang.String groupName)
Returns true if user group with given name exists. |
boolean |
doesUserBelongToGroup(WMSessionHandle shandle,
java.lang.String groupName,
java.lang.String username)
Returns true if the given user belongs to the given group. |
boolean |
doesUserExist(WMSessionHandle shandle,
java.lang.String username)
Returns true if user with given username exists. |
java.lang.String[] |
getAllGroupnames(WMSessionHandle shandle)
Returns Ids of all user groups. |
java.lang.String[] |
getAllGroupnamesForUser(WMSessionHandle shandle,
java.lang.String userName)
Returns Ids of all groups for the given user. |
java.lang.String[] |
getAllImmediateSubgroupsForGroup(WMSessionHandle shandle,
java.lang.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). |
java.lang.String[] |
getAllImmediateUsersForGroup(WMSessionHandle shandle,
java.lang.String groupName)
Returns all users that are immediate children of the given group. |
java.lang.String[] |
getAllSubgroupsForGroups(WMSessionHandle shandle,
java.lang.String[] groupNames)
Returns all groups that belong to the given groups. |
java.lang.String[] |
getAllUsers(WMSessionHandle shandle)
Returns Ids of all users. |
java.lang.String[] |
getAllUsersForGroups(WMSessionHandle shandle,
java.lang.String[] groupNames)
Returns all users that belong to the given groups. |
java.lang.String |
getGroupAttribute(WMSessionHandle shandle,
java.lang.String groupName,
java.lang.String attName)
Returns string representing value of group attribute for the group with the given name and attribute name |
java.lang.String |
getGroupDescription(WMSessionHandle shandle,
java.lang.String groupName)
Returns a group description. |
java.lang.String[] |
getGroups(WMSessionHandle sessionHandle,
java.lang.String expression)
Return all groups that match the specified expression evaluation. |
java.lang.String[] |
getObjects(WMSessionHandle sessionHandle,
java.lang.String expression)
Return the list of objects that match specified expression evaluation. |
java.lang.String |
getUserAttribute(WMSessionHandle shandle,
java.lang.String username,
java.lang.String attName)
Returns string representing value of user attribute for the user with the given name and attribute name |
java.lang.String |
getUserEMailAddress(WMSessionHandle shandle,
java.lang.String username)
Returns string representing email address for the user with the given username. |
java.lang.String |
getUserFirstName(WMSessionHandle shandle,
java.lang.String username)
Returns string representing user's first name. |
java.lang.String |
getUserLastName(WMSessionHandle shandle,
java.lang.String username)
Returns string representing user's last name. |
java.lang.String |
getUserPassword(WMSessionHandle shandle,
java.lang.String username)
Returns string representing the password for the shark user with the given username. |
java.lang.String |
getUserRealName(WMSessionHandle shandle,
java.lang.String username)
Returns string representing the real name for the shark user with the given username (first and last name). |
boolean |
validateUser(java.lang.String username,
java.lang.String pwd)
Validates user. |
Method Detail |
---|
void configure(CallbackUtilities cus) throws java.lang.Exception
cus
- an instance of CallbackUtilities used to get properties for configuring
userg roup manager in Shark.
java.lang.Exception
- Thrown if configuring doesn't succeed.java.lang.String[] getAllGroupnames(WMSessionHandle shandle) throws java.lang.Exception
java.lang.Exception
- If something unexpected happens.java.lang.String[] getAllGroupnamesForUser(WMSessionHandle shandle, java.lang.String userName) throws java.lang.Exception
userName
- name of the given user.
java.lang.Exception
- If something unexpected happens.java.lang.String[] getAllUsers(WMSessionHandle shandle) throws java.lang.Exception
java.lang.Exception
- If something unexpected happens.java.lang.String[] getAllUsersForGroups(WMSessionHandle shandle, java.lang.String[] groupNames) throws java.lang.Exception
groupNames
- names of the given groups.
java.lang.Exception
- If something unexpected happens.java.lang.String[] getAllImmediateUsersForGroup(WMSessionHandle shandle, java.lang.String groupName) throws java.lang.Exception
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.java.lang.String[] getAllSubgroupsForGroups(WMSessionHandle shandle, java.lang.String[] groupNames) throws java.lang.Exception
groupNames
- names of the given groups.
java.lang.Exception
- If something unexpected happens.java.lang.String[] getAllImmediateSubgroupsForGroup(WMSessionHandle shandle, java.lang.String groupName) throws java.lang.Exception
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.boolean doesGroupExist(WMSessionHandle shandle, java.lang.String groupName) throws java.lang.Exception
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.boolean doesGroupBelongToGroup(WMSessionHandle shandle, java.lang.String groupName, java.lang.String subgroupName) throws java.lang.Exception
groupName
- name of the given group.subgroupName
- name of the given subgroup.
java.lang.Exception
- If something unexpected happens.java.lang.String getGroupDescription(WMSessionHandle shandle, java.lang.String groupName) throws java.lang.Exception
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.boolean doesUserBelongToGroup(WMSessionHandle shandle, 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.boolean doesUserExist(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.java.lang.String getUserPassword(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.java.lang.String getUserRealName(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.java.lang.String getUserFirstName(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.java.lang.String getUserLastName(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.java.lang.String getUserEMailAddress(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.java.lang.String getUserAttribute(WMSessionHandle shandle, java.lang.String username, java.lang.String attName) throws java.lang.Exception
shandle
- username
- username of the shark user.attName
- attribute name.
java.lang.Exception
- If something unexpected happens.java.lang.String getGroupAttribute(WMSessionHandle shandle, java.lang.String groupName, java.lang.String attName) throws java.lang.Exception
shandle
- groupName
- group name of the shark groupattName
- attribute name.
java.lang.Exception
java.lang.String[] getObjects(WMSessionHandle sessionHandle, java.lang.String expression) throws java.lang.Exception
java.lang.Exception
java.lang.String[] getGroups(WMSessionHandle sessionHandle, java.lang.String expression) throws java.lang.Exception
java.lang.Exception
boolean validateUser(java.lang.String username, java.lang.String pwd) throws java.lang.Exception
username
- user name.pwd
- user password.
java.lang.Exception
- If something unexpected happens.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |