|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GroupManager
This object can be used to manage groups in JIRA.
Method Summary | |
---|---|
void |
addUserToGroup(com.atlassian.crowd.embedded.api.User user,
com.atlassian.crowd.embedded.api.Group group)
Adds a user as a member of a group. |
com.atlassian.crowd.embedded.api.Group |
createGroup(String groupName)
Create a group with the given name. |
Collection<com.atlassian.crowd.embedded.api.Group> |
getAllGroups()
Get all groups. |
Collection<com.atlassian.crowd.embedded.api.User> |
getDirectUsersInGroup(com.atlassian.crowd.embedded.api.Group group)
Returns all the users that are direct members of the group. |
com.atlassian.crowd.embedded.api.Group |
getGroup(String groupName)
Returns the Group for this groupName, else null if no such Group exists. |
com.atlassian.crowd.embedded.api.Group |
getGroupEvenWhenUnknown(String groupName)
Returns the Group for this groupName, if no such Group exists then a proxy unknown immutable Group object is returned. |
Collection<String> |
getGroupNamesForUser(ApplicationUser user)
Returns the names of all the groups that the given user belongs to. |
Collection<String> |
getGroupNamesForUser(String userName)
Returns the names of all the groups that the given user belongs to. |
Collection<String> |
getGroupNamesForUser(com.atlassian.crowd.embedded.api.User user)
Returns the names of all the groups that the given user belongs to. |
com.atlassian.crowd.embedded.api.Group |
getGroupObject(String groupName)
Returns the Group for this groupName, else null if no such Group exists. |
Collection<com.atlassian.crowd.embedded.api.Group> |
getGroupsForUser(String userName)
Returns all the groups that the given user belongs to. |
Collection<com.atlassian.crowd.embedded.api.Group> |
getGroupsForUser(com.atlassian.crowd.embedded.api.User userName)
Returns all the groups that the given user belongs to. |
Collection<String> |
getUserNamesInGroup(com.atlassian.crowd.embedded.api.Group group)
Returns the names of all the users in a group. |
Collection<String> |
getUserNamesInGroup(String groupName)
Returns the names of all the users in a group. |
Collection<com.atlassian.crowd.embedded.api.User> |
getUsersInGroup(com.atlassian.crowd.embedded.api.Group group)
Returns all the users in a group. |
Collection<com.atlassian.crowd.embedded.api.User> |
getUsersInGroup(String groupName)
Returns all the users in a group. |
boolean |
groupExists(String groupName)
Returns true if the given group name exists. |
boolean |
isUserInGroup(String username,
String groupname)
Returns true if the user is a member of the group. |
boolean |
isUserInGroup(com.atlassian.crowd.embedded.api.User user,
com.atlassian.crowd.embedded.api.Group group)
Returns true if the user is a member of the group. |
Method Detail |
---|
boolean groupExists(String groupName)
true
if the given group name exists.
groupName
- The group name.
true
if the given group name exists.Collection<com.atlassian.crowd.embedded.api.Group> getAllGroups()
com.atlassian.crowd.embedded.api.Group createGroup(String groupName) throws com.atlassian.crowd.exception.OperationNotPermittedException, com.atlassian.crowd.exception.embedded.InvalidGroupException
groupName
- The group name.
com.atlassian.crowd.exception.embedded.InvalidGroupException
- if the group already exists in ANY associated directory or the group template does not have the required properties populated.
com.atlassian.crowd.exception.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedcom.atlassian.crowd.embedded.api.Group getGroup(String groupName)
groupName
- The group name.
com.atlassian.crowd.embedded.api.Group getGroupEvenWhenUnknown(String groupName)
groupName
- The group name.
com.atlassian.crowd.embedded.api.Group getGroupObject(String groupName)
getGroup(String)
.
groupName
- The group name.
getGroup(String)
boolean isUserInGroup(String username, String groupname)
true
if the user is a member of the group.
Note that if the username or groupname is null, then it will return false.
username
- user to inspect.groupname
- group to inspect.
true
if and only if the user is a direct or indirect (nested) member of the group.isUserInGroup(com.atlassian.crowd.embedded.api.User, com.atlassian.crowd.embedded.api.Group)
boolean isUserInGroup(com.atlassian.crowd.embedded.api.User user, com.atlassian.crowd.embedded.api.Group group)
true
if the user is a member of the group.
Note that if the User or Group object is null, then it will return false. This was done to retain consistency with the old OSUser behaviour of User.inGroup() and Group.containsUser()
user
- user to inspect.group
- group to inspect.
true
if and only if the user is a direct or indirect (nested) member of the group.isUserInGroup(String, String)
Collection<com.atlassian.crowd.embedded.api.User> getUsersInGroup(String groupName)
groupName
- The group
#getUsersInGroup(Group)}
Collection<com.atlassian.crowd.embedded.api.User> getUsersInGroup(com.atlassian.crowd.embedded.api.Group group)
group
- The group
NullPointerException
- if the group is null#getUsersInGroup(String)}
Collection<String> getUserNamesInGroup(com.atlassian.crowd.embedded.api.Group group)
group
- The group
NullPointerException
- if the group is null#getUsersInGroup(Group)}
Collection<String> getUserNamesInGroup(String groupName)
groupName
- The group
NullPointerException
- if the group is null#getUsersInGroup(String)}
Collection<com.atlassian.crowd.embedded.api.User> getDirectUsersInGroup(com.atlassian.crowd.embedded.api.Group group)
group
- The group
NullPointerException
- if the group is null#getUsersInGroup(String)}
Collection<com.atlassian.crowd.embedded.api.Group> getGroupsForUser(String userName)
userName
- The user
getGroupNamesForUser(String)
Collection<com.atlassian.crowd.embedded.api.Group> getGroupsForUser(com.atlassian.crowd.embedded.api.User userName)
userName
- The user
getGroupNamesForUser(String)
Collection<String> getGroupNamesForUser(String userName)
userName
- The user
getGroupsForUser(String)
,
getGroupNamesForUser(com.atlassian.jira.user.ApplicationUser)
Collection<String> getGroupNamesForUser(com.atlassian.crowd.embedded.api.User user)
user
- The user
getGroupsForUser(String)
Collection<String> getGroupNamesForUser(ApplicationUser user)
user
- The user
getGroupsForUser(String)
void addUserToGroup(com.atlassian.crowd.embedded.api.User user, com.atlassian.crowd.embedded.api.Group group) throws com.atlassian.crowd.exception.GroupNotFoundException, com.atlassian.crowd.exception.UserNotFoundException, com.atlassian.crowd.exception.OperationNotPermittedException, com.atlassian.crowd.exception.OperationFailedException
user
- The user that will become a member of the group.group
- The group that will gain a new member.
com.atlassian.crowd.exception.UserNotFoundException
- if the user
could not be found
com.atlassian.crowd.exception.GroupNotFoundException
- if the group
could not be found
com.atlassian.crowd.exception.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performed
com.atlassian.crowd.exception.OperationFailedException
- If the underlying directory implementation failed to execute the operation.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |