public class UserSearchParams extends Object
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.
Modifier and Type | Class and Description |
---|---|
static class |
UserSearchParams.Builder |
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 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.
|
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() |
public static final int MAXIMUM_RESULTS
@Deprecated public static final UserSearchParams ACTIVE_USERS_IGNORE_EMPTY_QUERY
@Deprecated public static final UserSearchParams ACTIVE_USERS_ALLOW_EMPTY_QUERY
public static final UserSearchParams LIMITED_ACTIVE_USERS_IGNORE_EMPTY_QUERY
public static final UserSearchParams LIMITED_ACTIVE_USERS_ALLOW_EMPTY_QUERY
@Deprecated public UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive)
allowEmptyQuery
- if true, empty queries that would retrieve all results are allowed.includeActive
- active users are searched.includeInactive
- inactive users are searched.@Deprecated public UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds)
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.@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)
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.@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)
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.@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)
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.@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)
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.public UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, int limit, boolean sorted, boolean ignorePermissionCheck)
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.public UserSearchParams(boolean allowEmptyQuery, boolean includeActive, boolean includeInactive, boolean canMatchEmail, UserFilter userFilter, Set<Long> projectIds, int limit, boolean sorted, boolean ignorePermissionCheck, boolean forceStrongConsistency)
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.public boolean allowEmptyQuery()
public boolean includeActive()
public boolean includeInactive()
public boolean canMatchEmail()
public UserFilter getUserFilter()
public boolean ignorePermissionCheck()
@Nonnull @Deprecated public com.google.common.base.Predicate<com.atlassian.crowd.embedded.api.User> getPostProcessingFilter()
public Integer getMaxResults()
public boolean isSorted()
public boolean isForcingStrongConsistency()
@Deprecated public static UserSearchParams.Builder builder()
public static UserSearchParams.Builder builder(int limit)
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.public static UserSearchParams.Builder builder(UserSearchParams prototype)
Copyright © 2002-2024 Atlassian. All Rights Reserved.