com.atlassian.jira.user.util

Interface UserUtil

All Known Implementing Classes:

UserUtilImpl

@PublicApi
public interface UserUtil

This is a back end service level interface that defines an API for user level operations.

In general, appropriate managers or services should be used in preference to this class, as it will be removed in some future revision of JIRA.

See Also:

UserService, UserManager, GroupService, GroupManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UserUtil.PasswordResetToken
static interface	UserUtil.PasswordResetTokenValidation

Field Summary

Fields

Modifier and Type	Field and Description
static String	META_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method and Description
void	addToJiraUsePermission(ApplicationUser user) Deprecated. Use UserService.validateAddUserToApplication(ApplicationUser, ApplicationKey) then UserService.addUserToApplication(AddUserToApplicationValidationResult) instead. Since v7.0.
void	addUserToGroup(com.atlassian.crowd.embedded.api.Group group, ApplicationUser userToAdd) This is used to add a specified user to a specified group.
void	addUserToGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups, ApplicationUser userToAdd) This is used to add a user to many groups at once.
boolean	canActivateNumberOfUsers(int numUsers) Deprecated. Use ApplicationRoleManager.hasSeatsAvailable(ApplicationKey, int) instead. Since v7.0
void	changePassword(ApplicationUser user, String newPassword) Can be called to set the password for a user.
void	clearActiveUserCount() Deprecated. since 6.5. Use LicenseCountService.flush() instead.
ApplicationUser	createUser(UserDetails userData, boolean sendEmail, int eventType, Set<com.atlassian.application.api.ApplicationKey> applicationKeys) Deprecated. Use UserService.createUser(CreateUserValidationResult) instead. Since v7.0.
ApplicationUser	createUserNoNotification(String username, String password, String emailAddress, String displayName) Deprecated. Use UserService.createUser(CreateUserValidationResult) instead. Since v7.0.
ApplicationUser	createUserNoNotification(String username, String password, String emailAddress, String displayName, Long directoryId) Deprecated. Use UserService.createUser(CreateUserValidationResult) instead. Since v7.0.
ApplicationUser	createUserWithNotification(String username, String password, String email, String fullname, int userEventType) Deprecated. Use UserService.createUser(CreateUserValidationResult) instead. Since v7.0.
ApplicationUser	createUserWithNotification(String username, String password, String email, String fullname, Long directoryId, int userEventType) Deprecated. Use UserService.createUser(CreateUserValidationResult) instead. Since v7.0.
UserUtil.PasswordResetToken	generatePasswordResetToken(ApplicationUser user) This is used to generate a reset password token that last a certain time and allows a person to access a page anonymously so they can reset their password.
int	getActiveUserCount() Deprecated. use LicenseCountService.totalBillableUsers(). since 6.5
Collection<ApplicationUser>	getAdministrators() Deprecated. Since v4.3. Use getJiraAdministrators().
Collection<ApplicationUser>	getAllApplicationUsers() Deprecated. Use UserManager.getAllApplicationUsers() instead. Since v6.5.
SortedSet<ApplicationUser>	getAllUsersInGroupNames(Collection<String> groupNames) Returns a collection of User objects that belong to any of the passed in collection of group names.
Set<ApplicationUser>	getAllUsersInGroupNamesUnsorted(Collection<String> groupNames) Returns a collection of User objects that belong to any of the passed in collection of group names.
SortedSet<ApplicationUser>	getAllUsersInGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups) Returns a collection of User objects that are found within the passed in collection of Group objects.
Collection<ProjectComponent>	getComponentsUserLeads(ApplicationUser user) Retrieve a collection of ProjectComponents - where the lead of each component is the specified user.
String	getDisplayableNameSafely(ApplicationUser user) Takes the given user and returns a "displayable name" by cautiously checking the different edge cases for users.
com.atlassian.crowd.embedded.api.Group	getGroup(String groupName) Deprecated. Since v4.3. Use GroupManager.getGroup(java.lang.String) instead.
SortedSet<String>	getGroupNamesForUser(String userName) Returns a collection of the names of the groups that the user belongs to.
com.atlassian.crowd.embedded.api.Group	getGroupObject(String groupName) Deprecated. since 6.5. Use GroupManager.getGroup(java.lang.String) instead.
SortedSet<com.atlassian.crowd.embedded.api.Group>	getGroupsForUser(String userName) Returns a collection of Group objects that the user belongs to.
Collection<ApplicationUser>	getJiraAdministrators() Returns a list of JIRA admin Users.
Collection<ApplicationUser>	getJiraSystemAdministrators() Returns a list of JIRA system admin Users.
long	getNumberOfAssignedIssuesIgnoreSecurity(ApplicationUser loggedInUser, ApplicationUser user) Returns number of issues assigned to user
long	getNumberOfReportedIssuesIgnoreSecurity(ApplicationUser loggedInUser, ApplicationUser user) Returns number of issues reported by user
Collection<Project>	getProjectsLeadBy(ApplicationUser user) Returns all the projects that leadUser is the project lead for.
Collection<ApplicationUser>	getSystemAdministrators() Deprecated. Since v4.3. Use getJiraSystemAdministrators() .
int	getTotalUserCount() Deprecated. Use UserManager.getTotalUserCount() instead. Since 7.0.
ApplicationUser	getUser(String userName) Deprecated. Use getUserByKey(String) or getUserByName(String) instead. Since v6.0.
ApplicationUser	getUserByKey(String userkey) Deprecated. use UserManager.getUserByKey(String). since 7.0
ApplicationUser	getUserByName(String username) Deprecated. use UserManager.getUserByName(String). since 7.0
ApplicationUser	getUserObject(String userName) Deprecated. Use getUserByKey(String) or getUserByName(String) instead. Since v6.0.
Collection<ApplicationUser>	getUsers() Deprecated. Use UserManager.getAllApplicationUsers() instead. Since v6.5.
SortedSet<ApplicationUser>	getUsersInGroupNames(Collection<String> groupNames) Deprecated. Use getAllUsersInGroupNames(java.util.Collection) instead. Since v4.3
SortedSet<ApplicationUser>	getUsersInGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups) Deprecated. Use getAllUsersInGroups(java.util.Collection) instead. Since v4.3
boolean	isNonSysAdminAttemptingToDeleteSysAdmin(ApplicationUser loggedInUser, ApplicationUser user) Checking if user without SYSTEM_ADMIN rights tries to remove user with SYSTEM_ADMIN rights.
void	removeUser(ApplicationUser loggedInUser, ApplicationUser user) This will remove the user and removes the user from all the groups.
void	removeUserFromGroup(com.atlassian.crowd.embedded.api.Group group, ApplicationUser userToRemove) This is used to remove a specified user from a specified group.
void	removeUserFromGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups, ApplicationUser userToRemove) This is used to remove a user from many groups at once.
boolean	userExists(String userName) Returns true if the a user exists with the specified userName
UserUtil.PasswordResetTokenValidation	validatePasswordResetToken(ApplicationUser user, String token) This can be called to validate a token against the user.

Field Detail

META_PROPERTY_PREFIX

static final String META_PROPERTY_PREFIX

See Also:

Constant Field Values

Method Detail

getTotalUserCount

@Deprecated
int getTotalUserCount()

Deprecated. Use UserManager.getTotalUserCount() instead. Since 7.0.

Returns the total number of users defined in JIRA, regardless of whether they are active or not.

Returns:

the total number of users defined in JIRA

Since:

v4.0

clearActiveUserCount

@Deprecated
void clearActiveUserCount()

Deprecated. since 6.5. Use LicenseCountService.flush() instead.

Clears the cache of the active user count so that it can be recalculated. This method should be used when performing operations that will modify the number of active users in the system.

Since:

v3.13

getUsers

@Deprecated
 @Nonnull
Collection<ApplicationUser> getUsers()

Deprecated. Use UserManager.getAllApplicationUsers() instead. Since v6.5.

Returns the all users defined in JIRA, regardless of whether they are active or not.

Returns:

the set of all users defined in JIRA

Since:

v4.3

getAllApplicationUsers

@Deprecated
 @Nonnull
Collection<ApplicationUser> getAllApplicationUsers()

Deprecated. Use UserManager.getAllApplicationUsers() instead. Since v6.5.

Returns the all users defined in JIRA, regardless of whether they are active or not.

Returns:

the set of all users defined in JIRA

Since:

v6.0

getGroup

@Deprecated
 @Nullable
com.atlassian.crowd.embedded.api.Group getGroup(@Nullable
                                                                       String groupName)

Deprecated. Since v4.3. Use GroupManager.getGroup(java.lang.String) instead.

Returns a Group based on group name.

Parameters:

groupName - the user name of the group

Returns:

the Group object, or null if the user cannot be found including null groupName.

Since:

v4.0

getGroupObject

@Deprecated
 @Nullable
com.atlassian.crowd.embedded.api.Group getGroupObject(@Nullable
                                                                             String groupName)

Deprecated. since 6.5. Use GroupManager.getGroup(java.lang.String) instead.

Returns a Group based on group name.

Parameters:

groupName - the user name of the group

Returns:

the Group object, or null if the user cannot be found including null groupName.

Since:

v4.3

createUserWithNotification

@Deprecated
 @Nonnull
ApplicationUser createUserWithNotification(String username,
                                                                 String password,
                                                                 String email,
                                                                 String fullname,
                                                                 int userEventType)
                                                          throws PermissionException,
                                                                 CreateException

Deprecated. Use UserService.createUser(CreateUserValidationResult) instead. Since v7.0.

Creates a User from supplied details.

Email notification will be send to created user.

Parameters:

username - The username of the new user. Needs to be lowercase and unique.

password - The password for the new user.

email - The email for the new user. Needs to be a valid email address.

fullname - The full name for the new user

userEventType - The event type dispatched on user creation. Either UserEventType.USER_CREATED or UserEventType.USER_SIGNUP

Returns:

The new user object that was created

Throws:

PermissionException - If the operation was not permitted.

CreateException

Since:

4.3

createUserWithNotification

@Deprecated
 @Nonnull
ApplicationUser createUserWithNotification(String username,
                                                                 String password,
                                                                 String email,
                                                                 String fullname,
                                                                 Long directoryId,
                                                                 int userEventType)
                                                          throws PermissionException,
                                                                 CreateException

Deprecated. Use UserService.createUser(CreateUserValidationResult) instead. Since v7.0.

Creates a User from supplied details.

Email notification will be send to created user.

Parameters:

username - The username of the new user. Needs to be lowercase and unique.

password - The password for the new user.

email - The email for the new user. Needs to be a valid email address.

fullname - The full name for the new user

directoryId - The directory to create the user in. Null means "first writable directory".

userEventType - The event type dispatched on user creation. Either UserEventType.USER_CREATED or UserEventType.USER_SIGNUP

Returns:

The new user object that was created

Throws:

PermissionException - If the operation was not permitted.

CreateException

Since:

4.3.2

createUserNoNotification

@Deprecated
 @Nonnull
ApplicationUser createUserNoNotification(String username,
                                                               String password,
                                                               String emailAddress,
                                                               String displayName)
                                                        throws PermissionException,
                                                               CreateException

Deprecated. Use UserService.createUser(CreateUserValidationResult) instead. Since v7.0.

Creates a User from supplied details.

No email notification will be send to created user.

Parameters:

username - The username of the new user. Needs to be lowercase and unique.

password - The password for the new user.

emailAddress - The email for the new user. Needs to be a valid email address.

displayName - The display name for the new user

Returns:

The new user object that was created

Throws:

PermissionException - If the operation was not permitted.

CreateException

Since:

4.3

createUserNoNotification

@Deprecated
 @Nonnull
ApplicationUser createUserNoNotification(String username,
                                                               String password,
                                                               String emailAddress,
                                                               String displayName,
                                                               Long directoryId)
                                                        throws PermissionException,
                                                               CreateException

Deprecated. Use UserService.createUser(CreateUserValidationResult) instead. Since v7.0.

Creates a User from supplied details.

No email notification will be send to created user.

Parameters:

username - The username of the new user. Needs to be lowercase and unique.

password - The password for the new user.

emailAddress - The email for the new user. Needs to be a valid email address.

displayName - The display name for the new user

directoryId - The directory to create the user in. Null means "first writable directory".

Returns:

The new user object that was created

Throws:

PermissionException - If the operation was not permitted.

CreateException

Since:

4.3.2

createUser

@Nonnull
 @Internal
 @ExperimentalApi
 @Deprecated
ApplicationUser createUser(@Nonnull
                                                                              UserDetails userData,
                                                                              boolean sendEmail,
                                                                              int eventType,
                                                                              @Nullable
                                                                              Set<com.atlassian.application.api.ApplicationKey> applicationKeys)
                                                                       throws PermissionException,
                                                                              CreateException

Deprecated. Use UserService.createUser(CreateUserValidationResult) instead. Since v7.0.

This method is being removed - Please use UserService. Creates a JIRA user.

Parameters:

userData - user request containing user details.

sendEmail - should send email notification.

eventType - notification event type (see to UserEventType).

applicationKeys - applications that user should be granted access to, null if instance default applications should be used, empty Set when user does not require access to any applications.

Returns:

The newly created user.

Throws:

PermissionException - If the operation was not permitted.

CreateException - Unable to create user.

Since:

v7.0

removeUser

void removeUser(ApplicationUser loggedInUser,
                ApplicationUser user)

This will remove the user and removes the user from all the groups. All components lead by user will have lead cleared.

Parameters:

loggedInUser - the user performing operation

user - the user to delete

addUserToGroup

void addUserToGroup(com.atlassian.crowd.embedded.api.Group group,
                    ApplicationUser userToAdd)
             throws PermissionException,
                    AddException

This is used to add a specified user to a specified group. The user will be added to the group if the user is not already a member of the group.

Parameters:

group - the group to add the user to.

userToAdd - the user to add to the group.

Throws:

PermissionException

AddException

addUserToGroups

void addUserToGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups,
                     ApplicationUser userToAdd)
              throws PermissionException,
                     AddException

This is used to add a user to many groups at once.

Parameters:

groups - a list containing the groups to add the user to.

userToAdd - the user to add to the group.

Throws:

PermissionException

AddException

removeUserFromGroup

void removeUserFromGroup(com.atlassian.crowd.embedded.api.Group group,
                         ApplicationUser userToRemove)
                  throws PermissionException,
                         RemoveException

This is used to remove a specified user from a specified group. The user will be removed from the group only if the user is already a member of the group.

Parameters:

group - the group to add the user to.

userToRemove - the user to add to the group.

Throws:

PermissionException

RemoveException

removeUserFromGroups

void removeUserFromGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups,
                          ApplicationUser userToRemove)
                   throws PermissionException,
                          RemoveException

This is used to remove a user from many groups at once.

Parameters:

groups - a list containing the groups to add the user to.

userToRemove - the user to add to the group.

Throws:

PermissionException

RemoveException

generatePasswordResetToken

UserUtil.PasswordResetToken generatePasswordResetToken(ApplicationUser user)

This is used to generate a reset password token that last a certain time and allows a person to access a page anonymously so they can reset their password.

The generated token will be associated with the named user so that that this information can be verified at a later time.

Parameters:

user - the user in question. This MUST not be null

Returns:

a newly generated token that will live for a certain time

validatePasswordResetToken

UserUtil.PasswordResetTokenValidation validatePasswordResetToken(ApplicationUser user,
                                                                 String token)

This can be called to validate a token against the user.

Parameters:

user - the user in play

token - the token they provided

Returns:

a Validation object that describes how the option went

changePassword

void changePassword(ApplicationUser user,
                    String newPassword)
             throws com.atlassian.crowd.exception.UserNotFoundException,
                    com.atlassian.crowd.exception.InvalidCredentialException,
                    com.atlassian.crowd.exception.OperationNotPermittedException,
                    PermissionException

Can be called to set the password for a user. This will delete any password request tokens associated with that user

Parameters:

user - the user in play

newPassword - their new password

Throws:

com.atlassian.crowd.exception.UserNotFoundException - if the user does not exist

com.atlassian.crowd.exception.InvalidCredentialException - if the password is invalid

com.atlassian.crowd.exception.OperationNotPermittedException - if the underlying User Directory is read-only

PermissionException

getActiveUserCount

@Deprecated
int getActiveUserCount()

Deprecated. use LicenseCountService.totalBillableUsers(). since 6.5

Gets the number of active users who currently count towards the license and should be charged for. This method should be used when determining user counts for billing purposes, such as purchase tier recommendations for plugins, and by plugins who wish to enforce tier-based licenses.

In all cases this method will exclude Connect users from the count. In Cloud this will also exclude users who exist for the purpose of providing support (such as the Atlassian sysadmin user).

Returns:

the active user count

Since:

v3.13

See Also:

Permissions

canActivateNumberOfUsers

@Deprecated
boolean canActivateNumberOfUsers(int numUsers)

Deprecated. Use ApplicationRoleManager.hasSeatsAvailable(ApplicationKey, int) instead. Since v7.0

Returns true if, after adding the specified number of users, the number of active users in JIRA does not exceed the user limit allowed by the license. If the license does not require a user limit, this method will return true immediately.

Parameters:

numUsers - the number of users to add to the JIRA instance. If 0, all things being equal, this method will return true. Must not be negative!

Returns:

False if the number of active users + the number of users to add is greater than the limit enforced by the license. True otherwise.

Since:

v3.13

getUser

@Deprecated
 @Nullable
ApplicationUser getUser(String userName)

Deprecated. Use getUserByKey(String) or getUserByName(String) instead. Since v6.0.

Returns a user based on user name.

Parameters:

userName - the user name of the user

Returns:

the User object, or null if the user cannot be found including null userName.

Since:

v3.13

getUserByKey

@Deprecated
 @Nullable
ApplicationUser getUserByKey(@Nullable
                                                    String userkey)

Deprecated. use UserManager.getUserByKey(String). since 7.0

Returns a user based on key.

Parameters:

userkey - the key of the user

Returns:

the User object, or null if the user cannot be found including null userkey.

Since:

v6.0

getUserByName

@Deprecated
 @Nullable
ApplicationUser getUserByName(String username)

Deprecated. use UserManager.getUserByName(String). since 7.0

Returns a user based on user name.

Parameters:

username - the user name of the user

Returns:

the User object, or null if the user cannot be found including null userName.

Since:

v6.0

getUserObject

@Deprecated
 @Nullable
ApplicationUser getUserObject(String userName)

Deprecated. Use getUserByKey(String) or getUserByName(String) instead. Since v6.0.

Returns a user based on user name.

Parameters:

userName - the user name of the user

Returns:

the User object, or null if the user cannot be found including null userName.

Since:

v4.3

userExists

boolean userExists(String userName)

Returns true if the a user exists with the specified userName

Parameters:

userName - the name of the user

Returns:

true if t a user exists with the specified name or false if not

getAdministrators

@Deprecated
Collection<ApplicationUser> getAdministrators()

Deprecated. Since v4.3. Use getJiraAdministrators().

Returns a list of JIRA admin Users.

WARNING: This method will be changed in the future to return a Collection of Crowd User objects. Since v4.3.

Returns:

a list of JIRA admin Users.

Since:

v3.13

getJiraAdministrators

Collection<ApplicationUser> getJiraAdministrators()

Returns a list of JIRA admin Users.

WARNING: This method will be changed in the future to return a Collection of Crowd User objects. Since v4.3.

Returns:

a list of JIRA admin Users.

Since:

v4.3

getSystemAdministrators

@Deprecated
Collection<ApplicationUser> getSystemAdministrators()

Deprecated. Since v4.3. Use getJiraSystemAdministrators() .

Returns a list of JIRA system admin Users.

WARNING: This method will be changed in the future to return a Collection of Crowd User objects. Since v4.3.

Returns:

a collection of User's that are associated with the Permissions.SYSTEM_ADMIN permission.

Since:

v3.13

getJiraSystemAdministrators

Collection<ApplicationUser> getJiraSystemAdministrators()

Returns a list of JIRA system admin Users.

WARNING: This method will be changed in the future to return a Collection of Crowd User objects. Since v4.3.

Returns:

a collection of User's that are associated with the Permissions.SYSTEM_ADMIN permission.

Since:

v4.3

addToJiraUsePermission

@Deprecated
void addToJiraUsePermission(ApplicationUser user)
                                 throws PermissionException

Deprecated. Use UserService.validateAddUserToApplication(ApplicationUser, ApplicationKey) then UserService.addUserToApplication(AddUserToApplicationValidationResult) instead. Since v7.0.

Takes the given user and adds him/her to all the groups that grant a user the global JIRA use permission. (see Permissions.USE) Note: operation is only performed if by doing so we will not exceed the user limit (if the current license happens to specify a limit)

Parameters:

user - The user to be added to the USE permission

Throws:

PermissionException

Since:

v3.13

getComponentsUserLeads

Collection<ProjectComponent> getComponentsUserLeads(ApplicationUser user)

Retrieve a collection of ProjectComponents - where the lead of each component is the specified user.

Parameters:

user - User leading components

Returns:

Collection of project components

getProjectsLeadBy

Collection<Project> getProjectsLeadBy(ApplicationUser user)

Returns all the projects that leadUser is the project lead for.

Parameters:

user - the user in play

Returns:

A collection of project GenericValues

isNonSysAdminAttemptingToDeleteSysAdmin

boolean isNonSysAdminAttemptingToDeleteSysAdmin(ApplicationUser loggedInUser,
                                                ApplicationUser user)

Checking if user without SYSTEM_ADMIN rights tries to remove user with SYSTEM_ADMIN rights.

Parameters:

loggedInUser - User performing operation

user - User for remove

Returns:

true if user without SYSTEM_ADMIN rights tries to remove user with SYSTEM_ADMIN rights

getNumberOfReportedIssuesIgnoreSecurity

long getNumberOfReportedIssuesIgnoreSecurity(ApplicationUser loggedInUser,
                                             ApplicationUser user)
                                      throws SearchException

Returns number of issues reported by user

Parameters:

loggedInUser - the logged in user

user - the user to find the issue count for

Returns:

number of issues reported by user

Throws:

SearchException - if something goes wrong

getNumberOfAssignedIssuesIgnoreSecurity

long getNumberOfAssignedIssuesIgnoreSecurity(ApplicationUser loggedInUser,
                                             ApplicationUser user)
                                      throws SearchException

Returns number of issues assigned to user

Parameters:

loggedInUser - the logged in user

user - the user to find the issue count for

Returns:

number of issues assigned to user

Throws:

SearchException - if something goes wrong

getDisplayableNameSafely

String getDisplayableNameSafely(ApplicationUser user)

Takes the given user and returns a "displayable name" by cautiously checking the different edge cases for users.

Parameters:

user - the user. May be null.

Returns:

The user's full name if present and not blank, the username if present, or null otherwise.

getGroupsForUser

SortedSet<com.atlassian.crowd.embedded.api.Group> getGroupsForUser(String userName)

Returns a collection of Group objects that the user belongs to.

Parameters:

userName - A User name

Returns:

the set of groups that the user belongs to

Since:

v4.3

getGroupNamesForUser

SortedSet<String> getGroupNamesForUser(String userName)

Returns a collection of the names of the groups that the user belongs to.

Parameters:

userName - A User name

Returns:

the set of groups that the user belongs to

Since:

v4.3

getAllUsersInGroupNames

SortedSet<ApplicationUser> getAllUsersInGroupNames(Collection<String> groupNames)

Returns a collection of User objects that belong to any of the passed in collection of group names. Prefer using getAllUsersInGroupNamesUnsorted(java.util.Collection) and sorting the list of users only if absolutely necessary rather than relying on this method to perform the sort.

Parameters:

groupNames - a collection of group name strings

Returns:

the set of users that are in the named groups, sorted in UserCachingComparator order

getAllUsersInGroupNamesUnsorted

Set<ApplicationUser> getAllUsersInGroupNamesUnsorted(Collection<String> groupNames)

Returns a collection of User objects that belong to any of the passed in collection of group names.

Parameters:

groupNames - a collection of group name strings

Returns:

the set of users that are in the named groups

Since:

5.1

getUsersInGroupNames

@Deprecated
SortedSet<ApplicationUser> getUsersInGroupNames(Collection<String> groupNames)

Deprecated. Use getAllUsersInGroupNames(java.util.Collection) instead. Since v4.3

Returns a collection of User objects that are found within the passed in collection of group names. Null users are excluded even if they exist in the underlying data.

Parameters:

groupNames - a collection of group name strings

Returns:

the set of users that are in the named groups.

getAllUsersInGroups

SortedSet<ApplicationUser> getAllUsersInGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups)

Returns a collection of User objects that are found within the passed in collection of Group objects.

Parameters:

groups - a collection of Group objects

Returns:

the set of users that are in the groups, sorted in UserCachingComparator order

getUsersInGroups

@Deprecated
SortedSet<ApplicationUser> getUsersInGroups(Collection<com.atlassian.crowd.embedded.api.Group> groups)

Deprecated. Use getAllUsersInGroups(java.util.Collection) instead. Since v4.3

Returns a collection of User objects that are found within the passed in collection of Group objects. Null users are excluded even if they exist in the underlying data.

Parameters:

groups - a collection of Group objects

Returns:

the set of users that are in the groups, sorted in UserCachingComparator order