| Package | Description |
|---|---|
| org.forgerock.json.resource |
| Modifier and Type | Method and Description |
|---|---|
QueryRequest |
QueryRequest.addField(org.forgerock.json.JsonPointer... fields) |
QueryRequest |
QueryRequest.addField(String... fields) |
QueryRequest |
QueryRequest.addSortKey(SortKey... keys)
Adds one or more sort keys which will be used for ordering the JSON resources returned by this query request.
|
QueryRequest |
QueryRequest.addSortKey(String... keys)
Adds one or more sort keys which will be used for ordering the JSON resources returned by this query request.
|
static QueryRequest |
Requests.copyOfQueryRequest(QueryRequest request)
Returns a copy of the provided query request.
|
static QueryRequest |
Requests.newQueryRequest(ResourcePath resourceContainer)
Returns a new query request with the provided resource container path.
|
static QueryRequest |
Requests.newQueryRequest(String resourceContainer)
Returns a new query request with the provided resource container path.
|
QueryRequest |
QueryRequest.setAdditionalParameter(String name,
String value) |
QueryRequest |
QueryRequest.setPagedResultsCookie(String cookie)
Sets the opaque cookie which is used by the resource provider to track its position in the set of query results.
|
QueryRequest |
QueryRequest.setPagedResultsOffset(int offset)
Sets the zero-based index of the first resource which should be included in the query results.
|
QueryRequest |
QueryRequest.setPageSize(int size)
Sets the requested page results page size or
0 if paged results are not required. |
QueryRequest |
QueryRequest.setPreferredLocales(org.forgerock.util.i18n.PreferredLocales preferredLocales) |
QueryRequest |
QueryRequest.setQueryExpression(String expression)
Sets the native query expression which will be used for processing the query request.
|
QueryRequest |
QueryRequest.setQueryFilter(org.forgerock.util.query.QueryFilter<org.forgerock.json.JsonPointer> filter)
Sets the query filter which will be used for selecting which JSON resources will be returned.
|
QueryRequest |
QueryRequest.setQueryId(String id)
Sets the query identifier for pre-defined queries.
|
QueryRequest |
QueryRequest.setResourcePath(ResourcePath path) |
QueryRequest |
QueryRequest.setResourcePath(String path) |
QueryRequest |
QueryRequest.setResourceVersion(org.forgerock.http.routing.Version resourceVersion) |
QueryRequest |
QueryRequest.setTotalPagedResultsPolicy(CountPolicy policy)
Sets the policy for calculating the total number of paged results.
|
| Modifier and Type | Method and Description |
|---|---|
static QueryRequest |
Requests.copyOfQueryRequest(QueryRequest request)
Returns a copy of the provided query request.
|
org.forgerock.util.promise.Promise<QueryResponse,ResourceException> |
Filter.filterQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler,
RequestHandler next)
Filters a query request.
|
org.forgerock.util.promise.Promise<QueryResponse,ResourceException> |
ResourceApiVersionRoutingFilter.filterQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler,
RequestHandler next) |
QueryResponse |
SynchronousRequestHandler.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
Collection<ResourceResponse> resources)
Searches for all JSON resources matching a user specified set of
criteria.
|
org.forgerock.util.promise.Promise<QueryResponse,ResourceException> |
AbstractRequestHandler.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of
criteria, returning a
Promise that will be completed when the
search has completed. |
org.forgerock.util.promise.Promise<QueryResponse,ResourceException> |
FilterChain.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler) |
org.forgerock.util.promise.Promise<QueryResponse,ResourceException> |
RequestHandler.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of
criteria, returning a
Promise that will be completed when the
search has completed. |
org.forgerock.util.promise.Promise<QueryResponse,ResourceException> |
Router.handleQuery(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler) |
QueryResponse |
Connection.query(org.forgerock.services.context.Context context,
QueryRequest request,
Collection<? super ResourceResponse> results)
Searches for all JSON resources matching a user specified set of
criteria, and places the results in the provided collection.
|
QueryResponse |
AbstractAsynchronousConnection.query(org.forgerock.services.context.Context context,
QueryRequest request,
Collection<? super ResourceResponse> results) |
QueryResponse |
AbstractConnectionWrapper.query(org.forgerock.services.context.Context context,
QueryRequest request,
Collection<? super ResourceResponse> results)
Searches for all JSON resources matching a user specified set of
criteria, and places the results in the provided collection.
|
QueryResponse |
Connection.query(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of
criteria, and returns a
Promise that will be completed with the
results of the search. |
QueryResponse |
AbstractAsynchronousConnection.query(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler) |
QueryResponse |
AbstractConnectionWrapper.query(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches for all JSON resources matching a user specified set of
criteria, and returns a
Promise that will be completed with the
results of the search. |
org.forgerock.util.promise.Promise<QueryResponse,ResourceException> |
Connection.queryAsync(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Asynchronously searches for all JSON resources matching a user specified
set of criteria, and returns a
Promise that will be completed with the
results of the search. |
org.forgerock.util.promise.Promise<QueryResponse,ResourceException> |
AbstractConnectionWrapper.queryAsync(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Asynchronously searches for all JSON resources matching a user specified
set of criteria, and returns a
Promise that will be completed with the
results of the search. |
org.forgerock.util.promise.Promise<QueryResponse,ResourceException> |
MemoryBackend.queryCollection(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches the collection for all resources which match the query request
criteria. |
org.forgerock.util.promise.Promise<QueryResponse,ResourceException> |
CollectionResourceProvider.queryCollection(org.forgerock.services.context.Context context,
QueryRequest request,
QueryResourceHandler handler)
Searches the collection for all resources which match the query request
criteria. |
R |
RequestVisitor.visitQueryRequest(P p,
QueryRequest request)
Visits a query request.
|
Copyright © 2021 Open Identity Platform Community. All rights reserved.