com.atlassian.jira.bc.user.search

Class DefaultUserPickerSearchService

java.lang.Object

com.atlassian.jira.bc.user.search.DefaultUserPickerSearchService

All Implemented Interfaces:

UserPickerSearchService, UserSearchService

public class DefaultUserPickerSearchService
extends Object
implements UserPickerSearchService, UserSearchService

Constructor Summary

Constructors

Constructor and Description

DefaultUserPickerSearchService(UserManager userManager, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, GroupManager groupManager, ProjectManager projectManager, ProjectRoleManager projectRoleManager, com.atlassian.crowd.embedded.api.CrowdService crowdService, com.atlassian.crowd.manager.directory.DirectoryManager directoryManager, com.atlassian.crowd.embedded.api.ApplicationFactory applicationFactory, UserKeyStore userKeyStore)

Method Summary

Modifier and Type	Method and Description
boolean	canPerformAjaxSearch(ApplicationUser user) Determines whether the given user could perform AJAX search.
boolean	canPerformAjaxSearch(JiraServiceContext jiraServiceContext) Returns true only if UserPicker Ajax search is enabled AND the user in the context has com.atlassian.jira.user.ApplicationUser Browse permission.
boolean	canShowEmailAddresses(JiraServiceContext jiraServiceContext) Whether or not the UserPicker Ajax should search or show email addresses
List<ApplicationUser>	filterUsers(List<ApplicationUser> applicationUsers, String nameQuery, String emailQuery, UserSearchParams userSearchParams) Filter a list of ApplicationUser based on provided criteria and return only those users that match.
List<ApplicationUser>	filterUsers(List<ApplicationUser> applicationUsers, String nameQuery, UserSearchParams userSearchParams) Filter a list of ApplicationUser based on provided criteria and return only those users that match.
Iterable<String>	findUserKeysByEmail(String email) Searches for a user with the specified e-mail address.
Iterable<String>	findUserKeysByFullName(String fullName) Searches for a user with the specified full name.
List<String>	findUserNames(String nameQuery, String emailQuery, UserSearchParams userSearchParams) Get user names based on query strings.
List<String>	findUserNames(String query, UserSearchParams userSearchParams) Get user names based on a query string.
List<ApplicationUser>	findUsers(JiraServiceContext jiraServiceContext, String query) Get Users based on a query string.
List<ApplicationUser>	findUsers(JiraServiceContext jiraServiceContext, String query, UserSearchParams userSearchParams) Get Users based on a query string.
List<ApplicationUser>	findUsers(String nameQuery, String emailQuery, UserSearchParams userSearchParams) Get Users based on query strings.
List<ApplicationUser>	findUsers(String query, UserSearchParams userSearchParams) Get Users based on a query string.
List<ApplicationUser>	findUsersAllowEmptyQuery(JiraServiceContext jiraServiceContext, String query) Get Users based on a query string.
Iterable<ApplicationUser>	findUsersByEmail(String email) Searches for a user with the specified e-mail address.
Iterable<ApplicationUser>	findUsersByFullName(String fullName) Searches for a user with the specified full name.
ApplicationUser	getUserByName(JiraServiceContext jiraServiceContext, String query) Returns a user by exact username
boolean	userMatches(ApplicationUser user, UserSearchParams userSearchParams) Determine whether a user matches the search criteria specified in the userSearchParams parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultUserPickerSearchService

public DefaultUserPickerSearchService(UserManager userManager,
                                      ApplicationProperties applicationProperties,
                                      JiraAuthenticationContext authenticationContext,
                                      PermissionManager permissionManager,
                                      GroupManager groupManager,
                                      ProjectManager projectManager,
                                      ProjectRoleManager projectRoleManager,
                                      com.atlassian.crowd.embedded.api.CrowdService crowdService,
                                      com.atlassian.crowd.manager.directory.DirectoryManager directoryManager,
                                      com.atlassian.crowd.embedded.api.ApplicationFactory applicationFactory,
                                      UserKeyStore userKeyStore)

Method Detail

findUsers

public List<ApplicationUser> findUsers(JiraServiceContext jiraServiceContext,
                                       String query)

Description copied from interface: UserPickerSearchService

Get Users based on a query string.

Matches on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words Only returns active users.

Results are sorted according to the UserCachingComparator.

Specified by:

findUsers in interface UserPickerSearchService

Specified by:

findUsers in interface UserSearchService

Parameters:

jiraServiceContext - Jira Service Context

query - String to search for.

Returns:

List of ApplicationUser objects that match criteria.

See Also:

UserPickerSearchService.findUsers(JiraServiceContext, String, UserSearchParams)

getUserByName

public ApplicationUser getUserByName(JiraServiceContext jiraServiceContext,
                                     String query)

Description copied from interface: UserPickerSearchService

Returns a user by exact username

Specified by:

getUserByName in interface UserPickerSearchService

Specified by:

getUserByName in interface UserSearchService

Parameters:

jiraServiceContext - Jira Service Context

query - String to search for.

Returns:

The ApplicationUser object with supplied username.

findUsersAllowEmptyQuery

public List<ApplicationUser> findUsersAllowEmptyQuery(JiraServiceContext jiraServiceContext,
                                                      String query)

Description copied from interface: UserPickerSearchService

Get Users based on a query string.

Matches on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words This will search even if the query passed is null or empty. Only returns active users.

Results are sorted according to the UserCachingComparator.

Specified by:

findUsersAllowEmptyQuery in interface UserPickerSearchService

Specified by:

findUsersAllowEmptyQuery in interface UserSearchService

Parameters:

jiraServiceContext - Jira Service Context

query - String to search for.

Returns:

List of ApplicationUser objects that match criteria.

See Also:

UserPickerSearchService.findUsers(JiraServiceContext, String, UserSearchParams)

findUsers

public List<ApplicationUser> findUsers(JiraServiceContext jiraServiceContext,
                                       String query,
                                       UserSearchParams userSearchParams)

Description copied from interface: UserPickerSearchService

Get Users based on a query string.

Matches on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words

Results are sorted according to the UserCachingComparator.

If the users in the database change during this call results might not be consistent if a post processing filter and a result limit is used.

Specified by:

findUsers in interface UserPickerSearchService

Specified by:

findUsers in interface UserSearchService

Parameters:

jiraServiceContext - Jira Service Context

query - String to search for.

userSearchParams - Additional search parameters

Returns:

List of ApplicationUser objects that match criteria.

findUsers

public List<ApplicationUser> findUsers(String query,
                                       UserSearchParams userSearchParams)

Description copied from interface: UserPickerSearchService

Get Users based on a query string.

Matches on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words

Matches email only when userSearchParams.canMatchEmail() is true.

Results are sorted according to the userSearchParams.comparator. If userSearchParams.comparator is null, no sorting will be performed.

If the users in the database change during this call results might not be consistent if a post processing filter and a result limit is used.

Specified by:

findUsers in interface UserPickerSearchService

Specified by:

findUsers in interface UserSearchService

Parameters:

query - the query to search username, display name and email address

userSearchParams - the search criteria

Returns:

the list of matched users

findUsers

public List<ApplicationUser> findUsers(String nameQuery,
                                       String emailQuery,
                                       UserSearchParams userSearchParams)

Description copied from interface: UserPickerSearchService

Get Users based on query strings.

Matches nameQuery on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words

Matches emailQuery on start of email, as well as the tokenised words. Email matching is performed only when userSearchParams.canMatchEmail() is true.

Results are sorted according to the userSearchParams.comparator. If userSearchParams.comparator is null, no sorting will be performed.

If the users in the database change during this call results might not be consistent if a post processing filter and a result limit is used.

Specified by:

findUsers in interface UserPickerSearchService

Specified by:

findUsers in interface UserSearchService

Parameters:

nameQuery - the query to search username and display name.

emailQuery - the query to search email address, subject to userSearchParams.canMatchEmail.

userSearchParams - the search criteria

Returns:

the list of matched users

findUserNames

public List<String> findUserNames(String query,
                                  UserSearchParams userSearchParams)

Description copied from interface: UserSearchService

Get user names based on a query string.

Matches on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words

Matches email only when userSearchParams.canMatchEmail() is true.

If the users in the database change during this call results might not be consistent if a post processing filter and a result limit is used.

Specified by:

findUserNames in interface UserSearchService

Parameters:

query - the query to search username, display name and email address

userSearchParams - the search criteria

Returns:

the list of matched user names

findUserNames

public List<String> findUserNames(String nameQuery,
                                  String emailQuery,
                                  UserSearchParams userSearchParams)

Description copied from interface: UserSearchService

Get user names based on query strings.

Matches nameQuery on start of username, full name and email as well as all the tokenised (on spaces, '.', '@' etc) words

Matches emailQuery on start of email, as well as the tokenised words. Email matching is performed only when userSearchParams.canMatchEmail() is true. If email matching is enabled, nameQuery AND emailQuery criteria must match returned users.

If the users in the database change during this call results might not be consistent if a post processing filter and a result limit is used.

Specified by:

findUserNames in interface UserSearchService

Parameters:

nameQuery - the query to search username and display name.

emailQuery - the query to search email address, subject to userSearchParams.canMatchEmail.

userSearchParams - the search criteria

Returns:

the list of matched users

userMatches

public boolean userMatches(ApplicationUser user,
                           UserSearchParams userSearchParams)

Description copied from interface: UserPickerSearchService

Determine whether a user matches the search criteria specified in the userSearchParams parameter.

allowEmptyQuery in userSearchParams is ignored.

Specified by:

userMatches in interface UserPickerSearchService

Specified by:

userMatches in interface UserSearchService

Parameters:

user - the user to be matched

userSearchParams - the search criteria

Returns:

true if the user matches the search criteria

canShowEmailAddresses

public boolean canShowEmailAddresses(JiraServiceContext jiraServiceContext)

Description copied from interface: UserPickerSearchService

Whether or not the UserPicker Ajax should search or show email addresses

Specified by:

canShowEmailAddresses in interface UserPickerSearchService

Specified by:

canShowEmailAddresses in interface UserSearchService

Parameters:

jiraServiceContext - Jira Service Context

Returns:

True if email addresses can be shown, otherwise false

See Also:

UserSearchService.canShowEmailAddresses(com.atlassian.jira.bc.JiraServiceContext)

canPerformAjaxSearch

public boolean canPerformAjaxSearch(JiraServiceContext jiraServiceContext)

Description copied from interface: UserPickerSearchService

Returns true only if UserPicker Ajax search is enabled AND the user in the context has com.atlassian.jira.user.ApplicationUser Browse permission.

Specified by:

canPerformAjaxSearch in interface UserPickerSearchService

Specified by:

canPerformAjaxSearch in interface UserSearchService

Parameters:

jiraServiceContext - Jira Service Context

Returns:

True if enabled, otherwise false

canPerformAjaxSearch

public boolean canPerformAjaxSearch(ApplicationUser user)

Description copied from interface: UserPickerSearchService

Determines whether the given user could perform AJAX search.

Specified by:

canPerformAjaxSearch in interface UserPickerSearchService

Specified by:

canPerformAjaxSearch in interface UserSearchService

findUserKeysByFullName

@Nonnull
public Iterable<String> findUserKeysByFullName(@Nullable
                                                        String fullName)

Description copied from interface: UserSearchService

Searches for a user with the specified full name.

Specified by:

findUserKeysByFullName in interface UserSearchService

Parameters:

fullName - the full name to search for.

Returns:

a collection of user keys with the specified full name, empty if none were found.

findUserKeysByEmail

@Nonnull
public Iterable<String> findUserKeysByEmail(@Nullable
                                                     String email)

Description copied from interface: UserSearchService

Searches for a user with the specified e-mail address.

Specified by:

findUserKeysByEmail in interface UserSearchService

Parameters:

email - the e-mail address to search.

Returns:

collection of found user keys, empty if none were found.

findUsersByFullName

@Nonnull
public Iterable<ApplicationUser> findUsersByFullName(@Nullable
                                                              String fullName)

Description copied from interface: UserSearchService

Searches for a user with the specified full name.

Specified by:

findUsersByFullName in interface UserSearchService

Parameters:

fullName - the full name to search for.

Returns:

a collection of users with the specified full name, empty if none were found.

findUsersByEmail

@Nonnull
public Iterable<ApplicationUser> findUsersByEmail(@Nullable
                                                           String email)

Description copied from interface: UserSearchService

Searches for a user with the specified e-mail address.

Specified by:

findUsersByEmail in interface UserSearchService

Parameters:

email - the e-mail address to search.

Returns:

collection of found users, empty if none were found.

filterUsers

@Nonnull
public List<ApplicationUser> filterUsers(List<ApplicationUser> applicationUsers,
                                                  String nameQuery,
                                                  UserSearchParams userSearchParams)

Description copied from interface: UserSearchService

Filter a list of ApplicationUser based on provided criteria and return only those users that match.

NB: The resultant list will be sorted and duplicates removed, if the UserSearchParams.isSorted() value is true. If this is set to false, then the resultant list will not be sorted and no duplicate checks performed, which may provide some better performance in specific scenarios, as the source list will be filtered as-is and all valid results returned in the order they were initially. If a max results value is provided (>= 0) in the UserSearchParams then it will be limited in size to that value.

Specified by:

filterUsers in interface UserSearchService

Parameters:

applicationUsers - the user to be filtered

nameQuery - the query to search username and display name.

userSearchParams - the search criteria

Returns:

a new list of users from provided list that match the filter criteria

filterUsers

@Nonnull
public List<ApplicationUser> filterUsers(List<ApplicationUser> applicationUsers,
                                                  String nameQuery,
                                                  String emailQuery,
                                                  UserSearchParams userSearchParams)

Description copied from interface: UserSearchService

Filter a list of ApplicationUser based on provided criteria and return only those users that match.

NB: The resultant list will be sorted and duplicates removed, if the UserSearchParams.isSorted() value is true. If this is set to false, then the resultant list will not be sorted and no duplicate checks performed, which may provide some better performance in specific scenarios, as the source list will be filtered as-is and all valid results returned in the order they were initially. If a max results value is provided (>= 0) in the UserSearchParams then it will be limited in size to that value.

Specified by:

filterUsers in interface UserSearchService

Parameters:

applicationUsers - the user to be filtered

nameQuery - the query to search username and display name.

emailQuery - the query to search email address, subject to userSearchParams.canMatchEmail.

userSearchParams - the search criteria

Returns:

a new list of users from provided list that match the filter criteria