Uses of Interface
org.forgerock.json.resource.QueryRequest

Packages that use QueryRequest

Package	Description
org.forgerock.authz.filter.crest.api	This package defines the authorization API interfaces for use in a CREST environment.
org.forgerock.json.resource	Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.
org.forgerock.openam.rest.resource	This package contains classes for the handling of REST request to CREST Resource endpoints with the concept of realms in OpenAM built in.

Uses of QueryRequest in org.forgerock.authz.filter.crest.api

Methods in org.forgerock.authz.filter.crest.api with parameters of type QueryRequest

Modifier and Type	Method and Description
Promise<AuthorizationResult,ResourceException>	CrestAuthorizationModule.authorizeQuery(Context context, QueryRequest request) Authorizes a received REST query request.

Uses of QueryRequest in org.forgerock.json.resource

Methods in org.forgerock.json.resource that return QueryRequest

Modifier and Type	Method and Description
QueryRequest	QueryRequest.addField(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(PreferredLocales preferredLocales)
QueryRequest	QueryRequest.setQueryExpression(String expression) Sets the native query expression which will be used for processing the query request.
QueryRequest	QueryRequest.setQueryFilter(QueryFilter<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(Version resourceVersion)
QueryRequest	QueryRequest.setTotalPagedResultsPolicy(CountPolicy policy) Sets the policy for calculating the total number of paged results.

Methods in org.forgerock.json.resource with parameters of type QueryRequest

Modifier and Type	Method and Description
static QueryRequest	Requests.copyOfQueryRequest(QueryRequest request) Returns a copy of the provided query request.
Promise<QueryResponse,ResourceException>	ResourceApiVersionRoutingFilter.filterQuery(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next)
Promise<QueryResponse,ResourceException>	Filter.filterQuery(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next) Filters a query request.
QueryResponse	SynchronousRequestHandler.handleQuery(Context context, QueryRequest request, Collection<ResourceResponse> resources) Searches for all JSON resources matching a user specified set of criteria.
Promise<QueryResponse,ResourceException>	Router.handleQuery(Context context, QueryRequest request, QueryResourceHandler handler)
default Promise<QueryResponse,ResourceException>	RequestHandler.handleQuery(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.
Promise<QueryResponse,ResourceException>	FilterChain.handleQuery(Context context, QueryRequest request, QueryResourceHandler handler)
QueryResponse	Connection.query(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	AbstractConnectionWrapper.query(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(Context context, QueryRequest request, Collection<? super ResourceResponse> results)
QueryResponse	Connection.query(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	AbstractConnectionWrapper.query(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(Context context, QueryRequest request, QueryResourceHandler handler)
Promise<QueryResponse,ResourceException>	Connection.queryAsync(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.
Promise<QueryResponse,ResourceException>	AbstractConnectionWrapper.queryAsync(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.
Promise<QueryResponse,ResourceException>	MemoryBackend.queryCollection(Context context, QueryRequest request, QueryResourceHandler handler) Searches the collection for all resources which match the query request criteria.
default Promise<QueryResponse,ResourceException>	CollectionResourceProvider.queryCollection(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.

Uses of QueryRequest in org.forgerock.openam.rest.resource

Methods in org.forgerock.openam.rest.resource with parameters of type QueryRequest

Modifier and Type	Method and Description
Promise<QueryResponse,ResourceException>	RestrictedTokenContextFilter.filterQuery(Context context, QueryRequest request, QueryResourceHandler handler, RequestHandler next)