@Component public class

UserPickerResourceHelperImpl

extends Object
implements UserPickerResourceHelper
java.lang.Object
   ↳ com.atlassian.jira.rest.v2.issue.users.UserPickerResourceHelperImpl

Class Overview

A helper for finding users

Summary

Public Constructors
UserPickerResourceHelperImpl(UserPickerSearchService userPickerSearchService, I18nHelper i18n, AvatarService avatarService, JiraAuthenticationContext authContext, PermissionManager permissionManager)
Public Methods
List<User> findActiveUsers(String searchString)
Finds active users, throws exception if search string is null
List<User> findUsers(String searchString, Boolean includeActive, Boolean includeInactive, boolean allowEmptySearchString)
Finds users, throws exception if search string is null
List<User> findUsers(String searchString, Boolean includeActive, Boolean includeInactive)
Finds users, throws exception if search string is null
List<User> findUsers(String searchString, UserSearchParams userSearchParams)
Finds users, throws exception if search string is null
UserPickerResultsBean findUsersAsBean(String query, Integer maxResults, Boolean showAvatar, List<String> excludeUsers)
Returns a list of users matching query with highlighting.
UserPickerResultsBean findUsersAsBean(String query, Integer maxResults, Boolean showAvatar, List<String> excludeUsers, UserSearchParams userSearchParams)
Returns a list of users matching query with highlighting.
User getUserByName(String userName)
Returns a user if supplied userName is exact match to their username.
List<User> limitUserSearch(Integer startAt, Integer maxResults, Iterable<User> users, Iterable<String> excludeUsers)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.rest.v2.issue.users.UserPickerResourceHelper

Public Constructors

public UserPickerResourceHelperImpl (UserPickerSearchService userPickerSearchService, I18nHelper i18n, AvatarService avatarService, JiraAuthenticationContext authContext, PermissionManager permissionManager)

Public Methods

public List<User> findActiveUsers (String searchString)

Finds active users, throws exception if search string is null

Parameters
searchString user query
Returns
  • List of matching users

public List<User> findUsers (String searchString, Boolean includeActive, Boolean includeInactive, boolean allowEmptySearchString)

Finds users, throws exception if search string is null

Parameters
searchString user query
includeActive whether to include active users (null implies true)
includeInactive whether to include inactive users (null implies false)
allowEmptySearchString controls whether users are returned if searchString is empty
Returns
  • List of matching users

public List<User> findUsers (String searchString, Boolean includeActive, Boolean includeInactive)

Finds users, throws exception if search string is null

Parameters
searchString user query, no users returned if empty
includeActive whether to include active users (null implies true)
includeInactive whether to include inactive users (null implies false)
Returns
  • List of matching users

public List<User> findUsers (String searchString, UserSearchParams userSearchParams)

Finds users, throws exception if search string is null

Parameters
searchString user query
userSearchParams search parameters, including "includeActive", "includeInactive", etc. allowEmptyQuery is ignored, always treated as false.
Returns
  • List of matching users

public UserPickerResultsBean findUsersAsBean (String query, Integer maxResults, Boolean showAvatar, List<String> excludeUsers)

Returns a list of users matching query with highlighting. This resource cannot be accessed anonymously.

Parameters
query A string used to search username, Name or e-mail address
maxResults the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated.
showAvatar get avatar url
excludeUsers exclude these users from search results
Returns
  • An object containing list of matched user objects, with html representing highlighting.

public UserPickerResultsBean findUsersAsBean (String query, Integer maxResults, Boolean showAvatar, List<String> excludeUsers, UserSearchParams userSearchParams)

Returns a list of users matching query with highlighting. This resource cannot be assessed anonymously.

Parameters
query A string used to search username, Name or e-mail address. Empty query is not allowed.
maxResults the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated.
showAvatar get avatar url
excludeUsers exclude these users from search results
userSearchParams additional search parameters. allowEmptyQuery is ignored, always treated as false.
Returns
  • An object containing list of matched user objects, with html representing highlighting.

public User getUserByName (String userName)

Returns a user if supplied userName is exact match to their username.

Parameters
userName The username query
Returns
  • User The exact user or null if not found.

public List<User> limitUserSearch (Integer startAt, Integer maxResults, Iterable<User> users, Iterable<String> excludeUsers)