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

Packages that use Request

Package	Description
org.forgerock.audit.events	Package contains audit events.
org.forgerock.audit.util	This package contains utility classes used in the audit service.
org.forgerock.json.resource	Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.
org.forgerock.opendj.rest2ldap	APIs for implementing REST to LDAP gateways.

Uses of Request in org.forgerock.audit.events

Methods in org.forgerock.audit.events with parameters of type Request

Modifier and Type	Method	Description
T	AccessAuditEventBuilder.forHttpRequest(org.forgerock.services.context.Context context, Request request)	Sets common fields from CREST contexts and request.
T	AccessAuditEventBuilder.requestFromCrestRequest(Request request)	Sets request detail from Request.

Uses of Request in org.forgerock.audit.util

Methods in org.forgerock.audit.util with parameters of type Request

Modifier and Type	Method	Description
static ResourceException	ResourceExceptionsUtil.notSupported(Request request)	Creates a NotSupportedException.
static ResourceException	ResourceExceptionsUtil.notSupportedOnCollection(Request request)	Creates a NotSupportedException.
static ResourceException	ResourceExceptionsUtil.notSupportedOnInstance(Request request)	Creates a NotSupportedException.

Uses of Request in org.forgerock.json.resource

Subinterfaces of Request in org.forgerock.json.resource

Modifier and Type	Interface	Description
interface	ActionRequest	An implementation specific action, or operation, upon a JSON resource.
interface	CreateRequest	A request to create a new JSON resource.
interface	DeleteRequest	A request to delete a JSON resource.
interface	PatchRequest	A request to update a JSON resource by applying a set of changes to its existing content.
interface	QueryRequest	A request to search for all JSON resources matching a user specified set of criteria.
interface	ReadRequest	A request to read a single identified JSON resource.
interface	UpdateRequest	A request to update a JSON resource by replacing its existing content with new content.

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

Modifier and Type	Method	Description
Request	Request.addField(String... fields)	Adds one or more fields which should be included with each JSON resource returned by this request.
Request	Request.addField(JsonPointer... fields)	Adds one or more fields which should be included with each JSON resource returned by this request.
static Request	Requests.copyOfApiRequest(Request request)	Returns a copy of the provided api request.
static Request	Requests.newApiRequest(ResourcePath path)	Returns a new API request with the provided path.
Request	Request.setAdditionalParameter(String name, String value)	Sets an additional parameter which should be used to control the behavior of this action request.
Request	Request.setPreferredLocales(PreferredLocales preferredLocales)	Set the locale preference for the request.
Request	Request.setResourcePath(String path)	Sets the non-null path of the JSON resource to which this request should be targeted.
Request	Request.setResourcePath(ResourcePath path)	Sets the non-null path of the JSON resource to which this request should be targeted.
Request	Request.setResourceVersion(org.forgerock.http.routing.Version resourceVersion)	Sets the requested API version of the resource.

Methods in org.forgerock.json.resource that return types with arguments of type Request

Modifier and Type	Method	Description
org.forgerock.services.routing.RouteMatcher<Request>	Router.addRoute(org.forgerock.http.routing.RoutingMode mode, Router.UriTemplate uriTemplate, RequestHandler handler)	Adds a new route to this router for the provided request handler.
org.forgerock.services.routing.RouteMatcher<Request>	Router.addRoute(org.forgerock.http.routing.Version version, CollectionResourceProvider provider)	Adds a new route to this router for the provided collection resource provider.
org.forgerock.services.routing.RouteMatcher<Request>	Router.addRoute(org.forgerock.http.routing.Version version, RequestHandler handler)	Adds a new route to this router for the provided request handler.
org.forgerock.services.routing.RouteMatcher<Request>	Router.addRoute(org.forgerock.http.routing.Version version, SingletonResourceProvider provider)	Adds a new route to this router for the provided singleton resource provider.
org.forgerock.services.routing.RouteMatcher<Request>	Router.addRoute(Router.UriTemplate uriTemplate, CollectionResourceProvider provider)	Adds a new route to this router for the provided collection resource provider.
org.forgerock.services.routing.RouteMatcher<Request>	Router.addRoute(Router.UriTemplate uriTemplate, SingletonResourceProvider provider)	Adds a new route to this router for the provided singleton resource provider.
protected Pair<org.forgerock.services.routing.RouteMatcher<Request>,RequestHandler>	Router.getSelfApiHandler()
static org.forgerock.services.routing.RouteMatcher<Request>	RouteMatchers.requestResourceApiVersionMatcher(org.forgerock.http.routing.Version version)	Creates a RouteMatcher instance that matches the request resource API version with the provided version.
static org.forgerock.services.routing.RouteMatcher<Request>	RouteMatchers.requestUriMatcher(org.forgerock.http.routing.RoutingMode mode, String template)	Creates a RouteMatcher instance that matches Requests with the provided mode and template.
protected org.forgerock.services.routing.RouteMatcher<Request>	Router.uriMatcher(org.forgerock.http.routing.RoutingMode mode, String pattern)

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

Modifier and Type	Method	Description
static Request	Requests.copyOfApiRequest(Request request)	Returns a copy of the provided api request.
org.forgerock.api.models.ApiDescription	AbstractConnectionWrapper.handleApiRequest(org.forgerock.services.context.Context context, Request request)
org.forgerock.api.models.ApiDescription	DescribedSyncRequestHandlerAdapter.handleApiRequest(org.forgerock.services.context.Context context, Request request)
org.forgerock.api.models.ApiDescription	FilterChain.handleApiRequest(org.forgerock.services.context.Context context, Request request)
org.forgerock.api.models.ApiDescription	Router.handleApiRequest(org.forgerock.services.context.Context context, Request request)
boolean	FilterCondition.matches(org.forgerock.services.context.Context context, Request request)	Returns true if the conditional filter should be invoked, or false if processing should continue directly to the next filter in the filter chain.
Optional<org.forgerock.http.routing.Version>	ResourceApiVersionSpecificationFilter.ResourcePathAndVersionSpecification.matchVersion(Request request)
Optional<org.forgerock.http.routing.Version>	ResourceApiVersionSpecificationFilter.VersionSpecification.matchVersion(Request request)	Test the request to try to find a match based on version configuration.

Constructor parameters in org.forgerock.json.resource with type arguments of type Request

Constructor	Description
Router(org.forgerock.services.routing.AbstractRouter<Router,Request,RequestHandler,org.forgerock.api.models.ApiDescription> router)	Creates a new router containing the same routes and default route as the provided router.

Uses of Request in org.forgerock.opendj.rest2ldap

Methods in org.forgerock.opendj.rest2ldap with parameters of type Request

Modifier and Type	Method	Description
org.forgerock.api.models.ApiDescription	DescribableRequestHandler.handleApiRequest(org.forgerock.services.context.Context context, Request request)