public interface GroupManager
Modifier and Type | Method and Description |
---|---|
void |
addUserToGroup(ApplicationUser 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<String> |
filterUsersInAllGroupsDirect(Collection<String> userNames,
Collection<String> groupNames)
Returns a collection of user names for the users that are direct members of every one of the supplied groups.
|
Collection<com.atlassian.crowd.embedded.api.Group> |
getAllGroups()
Deprecated.
Since v7.0. Only retrieve the users you really need. See
GroupPickerSearchService |
Collection<ApplicationUser> |
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.
|
com.atlassian.crowd.embedded.api.Group |
getGroupObject(String groupName)
Deprecated.
use
getGroup(String) instead. Since 6.5 |
Collection<com.atlassian.crowd.embedded.api.Group> |
getGroupsForUser(ApplicationUser userName)
Returns all the groups that the given user belongs to.
|
Collection<com.atlassian.crowd.embedded.api.Group> |
getGroupsForUser(String userName)
Returns all the groups that the given user belongs to.
|
Collection<String> |
getNamesOfDirectMembersOfGroups(Collection<String> groupNames,
int limit)
Returns a list of all active user names that are direct members in at least one of the supplied groups.
|
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<String> |
getUserNamesInGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups)
Returns the names of all the users in a collection of groups.
|
Collection<ApplicationUser> |
getUsersInGroup(com.atlassian.crowd.embedded.api.Group group)
Returns all the users in a group.
|
Collection<ApplicationUser> |
getUsersInGroup(String groupName)
Returns all the users in a group.
|
Page<ApplicationUser> |
getUsersInGroup(String groupName,
Boolean includeInactive,
PageRequest pageRequest)
Returns a page with users in a group.
|
int |
getUsersInGroupCount(com.atlassian.crowd.embedded.api.Group group)
Returns a count of all active users in a group.
|
int |
getUsersInGroupCount(String groupName)
Returns a count of all active users in a group.
|
boolean |
groupExists(com.atlassian.crowd.embedded.api.Group group)
Returns
true if the given group exists. |
boolean |
groupExists(String groupName)
Returns
true if the given group name exists. |
boolean |
isUserInGroup(ApplicationUser user,
com.atlassian.crowd.embedded.api.Group group)
Returns
true if the user is a member of the group. |
boolean |
isUserInGroup(ApplicationUser user,
String groupName)
Returns
true if the user is a member of the named group. |
boolean |
isUserInGroup(String username,
String groupname)
Deprecated.
Use one of the other
isUserInGroup methods that takes a concrete user object instead.
Since v6.4.8. |
boolean groupExists(String groupName)
true
if the given group name exists.groupName
- The group name.true
if the given group name exists.boolean groupExists(@Nonnull com.atlassian.crowd.embedded.api.Group group)
true
if the given group exists.group
- The group.true
if the given group exists.@Deprecated Collection<com.atlassian.crowd.embedded.api.Group> getAllGroups()
GroupPickerSearchService
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.@Deprecated com.atlassian.crowd.embedded.api.Group getGroupObject(String groupName)
getGroup(String)
instead. Since 6.5getGroup(String)
.groupName
- The group name.getGroup(String)
boolean isUserInGroup(@Nullable String username, @Nullable String groupname)
isUserInGroup
methods that takes a concrete user object instead.
Since v6.4.8.true
if the user is a member of the group.
Note that if the username or groupname is null, then it will return false.
Performance note: If you have a full user object, then calling one of the other
isUserInGroup()
methods directly is more efficient.
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(ApplicationUser, Group)
,
isUserInGroup(ApplicationUser, String)
boolean isUserInGroup(@Nullable ApplicationUser user, @Nullable 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.boolean isUserInGroup(@Nullable ApplicationUser user, @Nullable String groupName)
true
if the user is a member of the named group.
If you already have the user object, then this method is faster than the alternative of passing in the username because it saves on an unnecessary user lookup to find the correct User Directory.
user
- user to inspect.groupName
- group to inspect.true
if and only if the user is a direct or indirect (nested) member of the group.Collection<ApplicationUser> getUsersInGroup(String groupName)
groupName
- The group#getUsersInGroup(Group)}
Page<ApplicationUser> getUsersInGroup(String groupName, Boolean includeInactive, PageRequest pageRequest)
groupName
- name of the group for which users are returnedincludeInactive
- if set to true inactive users will be returned as wellpageRequest
- parameters of the page to returnCollection<ApplicationUser> getUsersInGroup(com.atlassian.crowd.embedded.api.Group group)
group
- The groupNullPointerException
- if the group is null#getUsersInGroup(String)}
int getUsersInGroupCount(com.atlassian.crowd.embedded.api.Group group)
group
- The group#getUsersInGroupCount(String)}
int getUsersInGroupCount(String groupName)
groupName
- The group name#getUsersInGroupCount(Group)}
Collection<String> getNamesOfDirectMembersOfGroups(Collection<String> groupNames, int limit)
groupNames
- A collection of group names to find direct members oflimit
- A maximum number of names to returnCollection<String> filterUsersInAllGroupsDirect(Collection<String> userNames, Collection<String> groupNames)
userNames
- A collection of user namesgroupNames
- A collection of groupsCollection<String> getUserNamesInGroup(com.atlassian.crowd.embedded.api.Group group)
group
- The groupNullPointerException
- if the group is null#getUsersInGroup(Group)}
Collection<String> getUserNamesInGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups)
groups
- The collection of groupsNullPointerException
- if a group is nullCollection<String> getUserNamesInGroup(String groupName)
groupName
- The groupNullPointerException
- if the group is null#getUsersInGroup(String)}
Collection<ApplicationUser> getDirectUsersInGroup(com.atlassian.crowd.embedded.api.Group group)
group
- The groupNullPointerException
- if the group is null#getUsersInGroup(String)}
Collection<com.atlassian.crowd.embedded.api.Group> getGroupsForUser(String userName)
userName
- The usergetGroupNamesForUser(String)
Collection<com.atlassian.crowd.embedded.api.Group> getGroupsForUser(ApplicationUser userName)
userName
- The usergetGroupNamesForUser(String)
Collection<String> getGroupNamesForUser(String userName)
userName
- The usergetGroupsForUser(String)
,
getGroupNamesForUser(com.atlassian.jira.user.ApplicationUser)
Collection<String> getGroupNamesForUser(@Nonnull ApplicationUser user)
user
- The usergetGroupsForUser(String)
void addUserToGroup(ApplicationUser 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 foundcom.atlassian.crowd.exception.GroupNotFoundException
- if the group
could not be foundcom.atlassian.crowd.exception.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedcom.atlassian.crowd.exception.OperationFailedException
- If the underlying directory implementation failed to execute the operation.Copyright © 2002-2015 Atlassian. All Rights Reserved.