public final class SearchRequestBuilder extends ResourceReturningRequestBuilder<SearchRequestBuilder>
attributes, excludedheaders, queryParams| Constructor and Description |
|---|
SearchRequestBuilder(javax.ws.rs.client.WebTarget target)
Create a new search request builder.
|
| Modifier and Type | Method and Description |
|---|---|
SearchRequestBuilder |
filter(String filter)
Request filtering of resources.
|
<T> ListResponse<T> |
invoke(Class<T> cls)
Invoke the SCIM retrieve request using GET.
|
<T> void |
invoke(SearchResultHandler<T> resultHandler,
Class<T> cls)
Invoke the SCIM retrieve request using GET.
|
<T extends ScimResource> |
invokePost(Class<T> cls)
Invoke the SCIM retrieve request using POST.
|
<T> void |
invokePost(SearchResultHandler<T> resultHandler,
Class<T> cls)
Invoke the SCIM retrieve request using POST.
|
SearchRequestBuilder |
page(int startIndex,
int count)
Request pagination of resources.
|
SearchRequestBuilder |
sort(String sortBy,
SortOrder sortOrder)
Request sorting of resources.
|
attributes, excludedAttributesaccept, contentType, getAccept, getContentType, header, queryParam, targetpublic SearchRequestBuilder(javax.ws.rs.client.WebTarget target)
target - The WebTarget to search.public SearchRequestBuilder filter(String filter)
filter - the filter string used to request a subset of resources.public SearchRequestBuilder sort(String sortBy, SortOrder sortOrder)
sortBy - the string indicating the attribute whose value shall be used
to order the returned responses.sortOrder - the order in which the sortBy parameter is applied.public SearchRequestBuilder page(int startIndex, int count)
startIndex - the 1-based index of the first query result.count - the desired maximum number of query results per page.public <T> ListResponse<T> invoke(Class<T> cls) throws ScimException
T - The type of objects to return.cls - The Java class object used to determine the type to return.ScimException - If an error occurred.public <T> void invoke(SearchResultHandler<T> resultHandler, Class<T> cls) throws ScimException
T - The type of objects to return.resultHandler - The search result handler that should be used to
process the resources.cls - The Java class object used to determine the type to return.ScimException - If an error occurred.public <T extends ScimResource> ListResponse<T> invokePost(Class<T> cls) throws ScimException
T - The type of objects to return.cls - The Java class object used to determine the type to return.ScimException - If an error occurred.public <T> void invokePost(SearchResultHandler<T> resultHandler, Class<T> cls) throws ScimException
T - The type of objects to return.resultHandler - The search result handler that should be used to
process the resources.cls - The Java class object used to determine the type to return.ScimException - If an error occurred.Copyright © 2015–2021 Ping Identity Corporation. All rights reserved.