com.atlassian.jira.bc.user.search

Class UserSearchParams

java.lang.Object

com.atlassian.jira.bc.user.search.UserSearchParams

public class UserSearchParams
extends Object

Optional parameters to restrict or control a user search.

This allows you to include or exclude active and inactive users, allow or disallow empty search queries and avoid returning stale data.

Implementations which use this class may return "eventually consistent"/stale/cached data to improve performance.
If that's not what you expect as for example you don't want to return stale data in:
- security/permission context to avoid security problems,
- notification context to avoid sending-off notification to users who should not get information about something
you can set forceStrongConsistency to true to force the conforming implementation to return "strongly consistent"/fresh data.

Since:

v5.1.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserSearchParams.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static UserSearchParams	ACTIVE_USERS_ALLOW_EMPTY_QUERY Deprecated.
static UserSearchParams	ACTIVE_USERS_IGNORE_EMPTY_QUERY Deprecated.
static UserSearchParams	LIMITED_ACTIVE_USERS_ALLOW_EMPTY_QUERY
static UserSearchParams	LIMITED_ACTIVE_USERS_IGNORE_EMPTY_QUERY
static int	MAXIMUM_RESULTS

Constructor Summary

Constructors

Constructor and Description
UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive) Deprecated. Using constructor without maxResults param is discouraged.
UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds) Deprecated. Using constructor without limit parameter is discouraged.
UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, int limit, boolean sorted, boolean ignorePermissionCheck) Creates user search params.
UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, int limit, boolean sorted, boolean ignorePermissionCheck, boolean forceStrongConsistency) Creates user search params.
UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter) Deprecated. Using constructor without maxResults param is discouraged. Using postProcessingFilter parameter may cause performance issues. postProcessingFilter parameter will be removed in Jira version 9.
UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter, Integer maxResults) Deprecated. Using postProcessingFilter parameter may cause performance issues. It will be removed in Jira version 9. Passing null as maxResults param is discouraged. maxResults parameter will be removed as of Jira version 9. Please use constructor with limit parameter instead.
UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter, Integer maxResults, boolean sorted) Deprecated. Using postProcessingFilter parameter may cause performance issues. It will be removed in Jira version 9. Passing null as maxResults param is discouraged. maxResults parameter will be removed as of Jira version 9. Please use constructor with limit parameter instead.
UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter, Integer maxResults, boolean sorted, boolean ignorePermissionCheck) Deprecated. Using postProcessingFilter parameter may cause performance issues. It will be removed in Jira version 9. Passing null as maxResults param is discouraged. maxResults parameter will be removed as of Jira version 9. Please use constructor with limit parameter instead.

Method Summary

Modifier and Type	Method and Description
boolean	allowEmptyQuery()
static UserSearchParams.Builder	builder() Deprecated.
static UserSearchParams.Builder	builder(int limit)
static UserSearchParams.Builder	builder(UserSearchParams prototype)
boolean	canMatchEmail()
boolean	equals(Object o)
Integer	getMaxResults()
com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User>	getPostProcessingFilter() Deprecated. Using postProcessingFilter field may cause performance issues. It will be removed in Jira version 9.
Set<Long>	getProjectIds()
UserFilter	getUserFilter()
int	hashCode()
boolean	ignorePermissionCheck()
boolean	includeActive()
boolean	includeInactive()
boolean	isForcingStrongConsistency()
boolean	isSorted()

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMUM_RESULTS

public static final int MAXIMUM_RESULTS

See Also:

Constant Field Values

ACTIVE_USERS_IGNORE_EMPTY_QUERY

@Deprecated
public static final UserSearchParams ACTIVE_USERS_IGNORE_EMPTY_QUERY

Deprecated.

ACTIVE_USERS_ALLOW_EMPTY_QUERY

@Deprecated
public static final UserSearchParams ACTIVE_USERS_ALLOW_EMPTY_QUERY

Deprecated.

LIMITED_ACTIVE_USERS_IGNORE_EMPTY_QUERY

public static final UserSearchParams LIMITED_ACTIVE_USERS_IGNORE_EMPTY_QUERY

LIMITED_ACTIVE_USERS_ALLOW_EMPTY_QUERY

public static final UserSearchParams LIMITED_ACTIVE_USERS_ALLOW_EMPTY_QUERY

Constructor Detail

UserSearchParams

@Deprecated
public UserSearchParams(boolean allowEmptyQuery,
                                    boolean includeActive,
                                    boolean includeInactive)

Deprecated. Using constructor without maxResults param is discouraged.

Creates user search params.

Parameters:

allowEmptyQuery - if true, empty queries that would retrieve all results are allowed.

includeActive - active users are searched.

includeInactive - inactive users are searched.

UserSearchParams

@Deprecated
public UserSearchParams(boolean allowEmptyQuery,
                                    boolean includeActive,
                                    boolean includeInactive,
                                    boolean canMatchEmail,
                                    UserFilter userFilter,
                                    Set<Long> projectIds)

Deprecated. Using constructor without limit parameter is discouraged.

Creates user search params.

Parameters:

allowEmptyQuery - if true, empty queries that would retrieve all results are allowed.

includeActive - active users are searched.

includeInactive - inactive users are searched.

canMatchEmail - if search applies to email address as well.

userFilter - filter users by groups or roles.

projectIds - the list of project ids to be used in conjunction with the roles in user filter.

Since:

v6.2

UserSearchParams

@Deprecated
public UserSearchParams(boolean allowEmptyQuery,
                                    boolean includeActive,
                                    boolean includeInactive,
                                    boolean canMatchEmail,
                                    UserFilter userFilter,
                                    Set<Long> projectIds,
                                    com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter)

Deprecated. Using constructor without maxResults param is discouraged. Using postProcessingFilter parameter may cause performance issues. postProcessingFilter parameter will be removed in Jira version 9.

Creates user search params.

Parameters:

allowEmptyQuery - if true, empty queries that would retrieve all results are allowed.

includeActive - active users are searched.

includeInactive - inactive users are searched.

canMatchEmail - if search applies to email address as well.

userFilter - filter users by groups or roles.

projectIds - the list of project ids to be used in conjunction with the roles in user filter.

postProcessingFilter - a filter applied after search results are retrieved. Use this for more complex filter logic that can't be expressed in userFilter and the other parameters.

Since:

v7.0

UserSearchParams

@Deprecated
public UserSearchParams(boolean allowEmptyQuery,
                                    boolean includeActive,
                                    boolean includeInactive,
                                    boolean canMatchEmail,
                                    UserFilter userFilter,
                                    Set<Long> projectIds,
                                    com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter,
                                    Integer maxResults)

Deprecated. Using postProcessingFilter parameter may cause performance issues. It will be removed in Jira version 9. Passing null as maxResults param is discouraged. maxResults parameter will be removed as of Jira version 9. Please use constructor with limit parameter instead.

Creates user search params.

Parameters:

allowEmptyQuery - if true, empty queries that would retrieve all results are allowed.

includeActive - active users are searched.

includeInactive - inactive users are searched.

canMatchEmail - if search applies to email address as well.

userFilter - filter users by groups or roles.

projectIds - the list of project ids to be used in conjunction with the roles in user filter.

postProcessingFilter - a filter applied after search results are retrieved. Use this for more complex filter logic that can't be expressed in userFilter and the other parameters.

maxResults - the maximum number of results to retrieve. Use null for unlimited results.

Since:

v7.0

UserSearchParams

@Deprecated
public UserSearchParams(boolean allowEmptyQuery,
                                    boolean includeActive,
                                    boolean includeInactive,
                                    boolean canMatchEmail,
                                    UserFilter userFilter,
                                    Set<Long> projectIds,
                                    com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter,
                                    Integer maxResults,
                                    boolean sorted)

Deprecated. Using postProcessingFilter parameter may cause performance issues. It will be removed in Jira version 9. Passing null as maxResults param is discouraged. maxResults parameter will be removed as of Jira version 9. Please use constructor with limit parameter instead.

Creates user search params.

Parameters:

allowEmptyQuery - if true, empty queries that would retrieve all results are allowed.

includeActive - active users are searched.

includeInactive - inactive users are searched.

canMatchEmail - if search applies to email address as well.

userFilter - filter users by groups or roles.

projectIds - the list of project ids to be used in conjunction with the roles in user filter.

postProcessingFilter - a filter applied after search results are retrieved. Use this for more complex filter logic that can't be expressed in userFilter and the other parameters.

maxResults - the maximum number of results to retrieve. Use null for unlimited results.

sorted - if true, results are guaranteed to be sorted. If false, results may be unsorted which might have better performance.

Since:

v7.0

UserSearchParams

@Deprecated
public UserSearchParams(boolean allowEmptyQuery,
                                    boolean includeActive,
                                    boolean includeInactive,
                                    boolean canMatchEmail,
                                    UserFilter userFilter,
                                    Set<Long> projectIds,
                                    com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> postProcessingFilter,
                                    Integer maxResults,
                                    boolean sorted,
                                    boolean ignorePermissionCheck)

Deprecated. Using postProcessingFilter parameter may cause performance issues. It will be removed in Jira version 9. Passing null as maxResults param is discouraged. maxResults parameter will be removed as of Jira version 9. Please use constructor with limit parameter instead.

Creates user search params.

Parameters:

allowEmptyQuery - if true, empty queries that would retrieve all results are allowed.

includeActive - active users are searched.

includeInactive - inactive users are searched.

canMatchEmail - if search applies to email address as well.

userFilter - filter users by groups or roles.

projectIds - the list of project ids to be used in conjunction with the roles in user filter.

postProcessingFilter - a filter applied after search results are retrieved. Use this for more complex filter logic that can't be expressed in userFilter and the other parameters.

maxResults - the maximum number of results to retrieve. Use null for unlimited results.

sorted - if true, results are guaranteed to be sorted. If false, results may be unsorted which might have better performance.

ignorePermissionCheck - a flag that indicates whether a browser users permission check will be performed.

Since:

v7.0

UserSearchParams

public UserSearchParams(boolean allowEmptyQuery,
                        boolean includeActive,
                        boolean includeInactive,
                        boolean canMatchEmail,
                        UserFilter userFilter,
                        Set<Long> projectIds,
                        int limit,
                        boolean sorted,
                        boolean ignorePermissionCheck)

Creates user search params.

Parameters:

allowEmptyQuery - if true, empty queries that would retrieve all results are allowed.

includeActive - active users are searched.

includeInactive - inactive users are searched.

canMatchEmail - if search applies to email address as well.

userFilter - filter users by groups or roles.

projectIds - the list of project ids to be used in conjunction with the roles in user filter.

limit - the maximum number of results to retrieve. The maximum allowed is 100. If higher number is provided it will be set to 100.

sorted - if true, results are guaranteed to be sorted. If false, results may be unsorted which might have better performance.

ignorePermissionCheck - a flag that indicates whether a browser users permission check will be performed.

Since:

v8.20

UserSearchParams

public UserSearchParams(boolean allowEmptyQuery,
                        boolean includeActive,
                        boolean includeInactive,
                        boolean canMatchEmail,
                        UserFilter userFilter,
                        Set<Long> projectIds,
                        int limit,
                        boolean sorted,
                        boolean ignorePermissionCheck,
                        boolean forceStrongConsistency)

Creates user search params.

Parameters:

allowEmptyQuery - if true, empty queries that would retrieve all results are allowed.

includeActive - active users are searched.

includeInactive - inactive users are searched.

canMatchEmail - if search applies to email address as well.

userFilter - filter users by groups or roles.

projectIds - the list of project ids to be used in conjunction with the roles in user filter.

limit - the maximum number of results to retrieve. The maximum allowed is 100. If higher number is provided it will be set to 100.

sorted - if true, results are guaranteed to be sorted. If false, results may be unsorted which might have better performance.

ignorePermissionCheck - a flag that indicates whether a browser users permission check will be performed.

forceStrongConsistency - whether the search must avoid returning stale data. Use only if really necessary as it may cripple performance.

Since:

v9.0

Method Detail

allowEmptyQuery

public boolean allowEmptyQuery()

includeActive

public boolean includeActive()

includeInactive

public boolean includeInactive()

canMatchEmail

public boolean canMatchEmail()

getUserFilter

public UserFilter getUserFilter()

getProjectIds

public Set<Long> getProjectIds()

ignorePermissionCheck

public boolean ignorePermissionCheck()

Since:

v7.0

getPostProcessingFilter

@Nonnull
 @Deprecated
public com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> getPostProcessingFilter()

Deprecated. Using postProcessingFilter field may cause performance issues. It will be removed in Jira version 9.

Since:

v7.0

getMaxResults

public Integer getMaxResults()

Since:

v7.0

isSorted

public boolean isSorted()

Since:

v7.0

isForcingStrongConsistency

public boolean isForcingStrongConsistency()

Since:

v9.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

@Deprecated
public static UserSearchParams.Builder builder()

Deprecated.

builder

public static UserSearchParams.Builder builder(int limit)

Parameters:

limit - the maximum number of results to retrieve using constructed UserSearchParams. The maximum allowed is 100. If higher number is provided it will be set to 100 in resulting UserSearchParams.

Since:

v8.20

builder

public static UserSearchParams.Builder builder(UserSearchParams prototype)