|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.enhydra.shark.usergroup.DODSUserGroupManagerAdmin
public class DODSUserGroupManagerAdmin
Used for managing users, groups and their relations.
Constructor Summary | |
---|---|
DODSUserGroupManagerAdmin()
|
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 |
configure(CallbackUtilities cus)
Method configure is called at Shark start up, to configure implementation of DODSUserGroupManager. |
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. |
boolean |
doesGroupBelongToGroup(WMSessionHandle shandle,
java.lang.String groupName,
java.lang.String subgroupName)
Returns true if group subgroupName is subgroup of group groupName. |
protected boolean |
doesGroupExist(java.lang.String groupName)
Returns true if user group with given name exists. |
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. |
protected boolean |
doesUserExist(java.lang.String username)
Returns true if user with given username exists. |
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. |
protected java.lang.String[] |
getAllSubgroupsForGroup(WMSessionHandle shandle,
java.lang.String groupName)
Returns all groups that belong to 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. |
protected java.lang.String[] |
getAllUsersForGroup(WMSessionHandle shandle,
java.lang.String groupName)
Returns all usernames that belong to the given group. |
java.lang.String[] |
getAllUsersForGroups(WMSessionHandle shandle,
java.lang.String[] groupNames)
Returns all users that belong to the given groups. |
protected com.lutris.appserver.server.sql.DBTransaction |
getDBTransaction()
|
java.lang.String |
getGroupDescription(WMSessionHandle shandle,
java.lang.String groupName)
Returns a group description. |
java.lang.String[] |
getGroups(WMSessionHandle sessionHandle,
java.lang.String expression)
|
java.lang.String[] |
getObjects(WMSessionHandle sessionHandle,
java.lang.String expression)
|
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)
|
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). |
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. |
protected void |
refreshDOCaches()
|
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. |
protected void |
setLDBName()
|
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. |
boolean |
validateUser(java.lang.String username,
java.lang.String password)
Validates user. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DODSUserGroupManagerAdmin()
Method Detail |
---|
public void configure(CallbackUtilities cus) throws java.lang.Exception
configure
in interface UserGroupManager
cus
- an instance of CallbackUtilities used to get properties for configuring
user group manager in Shark.
java.lang.Exception
- thrown if configuring doesn't succeed.public java.lang.String[] getAllGroupnames(WMSessionHandle shandle) throws java.lang.Exception
getAllGroupnames
in interface UserGroupManager
java.lang.Exception
- If something unexpected happens.public java.lang.String[] getAllGroupnamesForUser(WMSessionHandle shandle, java.lang.String userName) throws java.lang.Exception
getAllGroupnamesForUser
in interface UserGroupManager
userName
- name of the given user.
java.lang.Exception
- If something unexpected happens.public java.lang.String[] getAllUsers(WMSessionHandle shandle) throws java.lang.Exception
getAllUsers
in interface UserGroupManager
java.lang.Exception
- If something unexpected happens.protected java.lang.String[] getAllUsersForGroup(WMSessionHandle shandle, java.lang.String groupName) throws java.lang.Exception
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.public java.lang.String[] getAllUsersForGroups(WMSessionHandle shandle, java.lang.String[] groupNames) throws java.lang.Exception
getAllUsersForGroups
in interface UserGroupManager
groupNames
- names of the given groups.
java.lang.Exception
- If something unexpected happens.public java.lang.String[] getAllImmediateUsersForGroup(WMSessionHandle shandle, java.lang.String groupName) throws java.lang.Exception
getAllImmediateUsersForGroup
in interface UserGroupManager
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.protected java.lang.String[] getAllSubgroupsForGroup(WMSessionHandle shandle, java.lang.String groupName) throws java.lang.Exception
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.public java.lang.String[] getAllSubgroupsForGroups(WMSessionHandle shandle, java.lang.String[] groupNames) throws java.lang.Exception
getAllSubgroupsForGroups
in interface UserGroupManager
groupNames
- names of the given groups.
java.lang.Exception
- If something unexpected happens.public java.lang.String[] getAllImmediateSubgroupsForGroup(WMSessionHandle shandle, java.lang.String groupName) throws java.lang.Exception
getAllImmediateSubgroupsForGroup
in interface UserGroupManager
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.public boolean doesGroupExist(WMSessionHandle shandle, java.lang.String groupName) throws java.lang.Exception
doesGroupExist
in interface UserGroupManager
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.public boolean doesGroupBelongToGroup(WMSessionHandle shandle, java.lang.String groupName, java.lang.String subgroupName) throws java.lang.Exception
doesGroupBelongToGroup
in interface UserGroupManager
groupName
- name of the given group.subgroupName
- name of the given subgroup.
java.lang.Exception
- If something unexpected happens.public java.lang.String getGroupDescription(WMSessionHandle shandle, java.lang.String groupName) throws java.lang.Exception
getGroupDescription
in interface UserGroupManager
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.public boolean doesUserBelongToGroup(WMSessionHandle shandle, java.lang.String groupName, java.lang.String username) throws java.lang.Exception
doesUserBelongToGroup
in interface UserGroupManager
groupName
- name of the given group.username
- username used to uniquely identify shark user.
java.lang.Exception
- If something unexpected happens.public boolean doesUserExist(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
doesUserExist
in interface UserGroupManager
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.public java.lang.String getUserPassword(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
getUserPassword
in interface UserGroupManager
java.lang.Exception
public java.lang.String getUserRealName(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
getUserRealName
in interface UserGroupManager
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.public java.lang.String getUserFirstName(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
getUserFirstName
in interface UserGroupManager
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.public java.lang.String getUserLastName(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
getUserLastName
in interface UserGroupManager
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.public java.lang.String getUserEMailAddress(WMSessionHandle shandle, java.lang.String username) throws java.lang.Exception
getUserEMailAddress
in interface UserGroupManager
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.public void createGroup(java.lang.String groupName, java.lang.String description) throws java.lang.Exception
createGroup
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
removeGroup
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
updateGroup
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
addGroupToGroup
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
removeGroupFromGroup
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
removeGroupTree
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.public void removeUsersFromGroupTree(java.lang.String groupName) throws java.lang.Exception
removeUsersFromGroupTree
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
moveGroup
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
addUserToGroup
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
removeUserFromGroup
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
moveUser
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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 java.lang.String[] getObjects(WMSessionHandle sessionHandle, java.lang.String expression) throws java.lang.Exception
getObjects
in interface UserGroupManager
java.lang.Exception
public java.lang.String[] getGroups(WMSessionHandle sessionHandle, java.lang.String expression) throws java.lang.Exception
getGroups
in interface UserGroupManager
java.lang.Exception
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
createUser
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
updateUser
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
removeUser
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
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
setPassword
in interface org.enhydra.shark.api.admin.UserGroupManagerAdmin
username
- username of the shark user.password
- new password of the shark user.
java.lang.Exception
- If something unexpected happens.public boolean validateUser(java.lang.String username, java.lang.String password) throws java.lang.Exception
validateUser
in interface UserGroupManager
username
- user name.password
- user password.
java.lang.Exception
- If something unexpected happens.protected boolean doesGroupExist(java.lang.String groupName) throws java.lang.Exception
groupName
- name of the given group.
java.lang.Exception
- If something unexpected happens.protected boolean doesUserExist(java.lang.String username) throws java.lang.Exception
username
- username of the shark user.
java.lang.Exception
- If something unexpected happens.protected com.lutris.appserver.server.sql.DBTransaction getDBTransaction() throws java.lang.Exception
java.lang.Exception
protected void setLDBName()
protected void refreshDOCaches() throws java.lang.Exception
java.lang.Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |