Uses of Class
org.forgerock.http.protocol.Request

Packages that use Request

Package	Description
org.forgerock.am.oauth2	This package contains the client credentials OAuth2 API.
org.forgerock.caf.authentication.api	This package defines the core interfaces and classes to provide an asynchronous and improved JASPI-like message authentication API.
org.forgerock.caf.authentication.framework	This package defines the authentication framework classes for the authentication of messages via authentication contexts and modules.
org.forgerock.http	Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.filter	Core Filter implementations.
org.forgerock.http.filter.cors	Support for CORS.
org.forgerock.http.handler	Core Handler implementations.
org.forgerock.http.header	Processes HTTP message header fields.
org.forgerock.http.oauth2	This package provides APIs for OAuth 2.0 services implementations.
org.forgerock.http.oauth2.resolver	This package defines OpenAM specific logic needed to retrieve an AccessTokenInfo.
org.forgerock.http.protocol	Models and manages elements of the Hypertext Transfer Protocol.
org.forgerock.http.routing	Provides routing functionality for HTTP requests.
org.forgerock.http.session	Provides interfaces for managing and interacting with HTTP Sessions.
org.forgerock.http.spi	HTTP service provider API.
org.forgerock.http.util	Miscellaneous utility classes.
org.forgerock.oauth.clients.oauth2	OAuth 2.0 ForgeRock Client Implementation.
org.forgerock.oauth2.core	Defines the core classes to implement OAuth2 for OpenAM.
org.forgerock.secrets.oauth2	A Secrets API backend that can obtain OAuth 2 access tokens from a token endpoint, along with a collection of grant type handlers.

Uses of Request in org.forgerock.am.oauth2

Methods in org.forgerock.am.oauth2 that return Request

Modifier and Type	Method	Description
Request	AccessTokenRequest.getRequest()	Gets the original Request that prompted this request for an access token.

Methods in org.forgerock.am.oauth2 with parameters of type Request

Modifier and Type	Method	Description
AccessTokenRequest.Builder	AccessTokenRequest.Builder.request(Request request)	Adds the Request that initialised the access token request.

Uses of Request in org.forgerock.caf.authentication.api

Methods in org.forgerock.caf.authentication.api that return Request

Modifier and Type	Method	Description
Request	MessageInfoContext.getRequest()	Gets the request object from this MessageContextInfo.

Methods in org.forgerock.caf.authentication.api with parameters of type Request

Modifier and Type	Method	Description
void	MessageInfoContext.setRequest(Request request)	Sets the request object for this MessageContextInfo.

Uses of Request in org.forgerock.caf.authentication.framework

Methods in org.forgerock.caf.authentication.framework that return Request

Modifier and Type	Method	Description
Request	MessageContextImpl.getRequest()

Methods in org.forgerock.caf.authentication.framework with parameters of type Request

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	AuthenticationFilter.filter(Context context, Request request, Handler next)	Authenticates incoming request messages and if successful calls the downstream filter or handler and then secures the returned response.
void	MessageContextImpl.setRequest(Request request)

Uses of Request in org.forgerock.http

Methods in org.forgerock.http with parameters of type Request

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	Filter.filter(Context context, Request request, Handler next)	Filters the request and/or response of an exchange.
Promise<Response,NeverThrowsException>	Handler.handle(Context context, Request request)	Returns a Promise representing the asynchronous Response of the given request.
Promise<Response,NeverThrowsException>	Client.send(Request request)	Sends an HTTP request and returns a Promise representing the pending HTTP response.
Promise<Response,NeverThrowsException>	Client.send(Context context, Request request)	Sends an HTTP request and returns a Promise representing the pending HTTP response.
Promise<Response,NeverThrowsException>	Client.sendWithoutClose(Request request)	Sends an HTTP request and returns a Promise representing the pending HTTP response.
Promise<Response,NeverThrowsException>	Client.sendWithoutClose(Context context, Request request)	Sends an HTTP request and returns a Promise representing the pending HTTP response.

Uses of Request in org.forgerock.http.filter

Methods in org.forgerock.http.filter that return types with arguments of type Request

Modifier and Type	Method	Description
static BiPredicate<Context,Request>	Filters.matchRequestUriPath(String regex)	Returns a BiPredicate which will only match requests whose URI path matches the provided regular expression.
static BiPredicate<Context,Request>	Filters.matchRequestUriPath(Pattern regex)	Returns a BiPredicate which will only match requests whose URI path matches the provided regular expression.

Methods in org.forgerock.http.filter with parameters of type Request

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	CsrfFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	OptionsFilter.filter(Context context, Request request, Handler next)	Handles all OPTION requests to CREST resources, all other request methods are handled by the Handler.
Promise<Response,NeverThrowsException>	TransactionIdInboundFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	TransactionIdOutboundFilter.filter(Context context, Request request, Handler next)

Method parameters in org.forgerock.http.filter with type arguments of type Request

Modifier and Type	Method	Description
static Filter	Filters.conditionalFilter(Filter delegate, BiPredicate<Context,Request> condition)	Create a Filter decorator that only delegates to the decorated filter if the supplied predicate returns true.
CsrfFilter.Builder	CsrfFilter.Builder.excludeRequests(Predicate<Request> predicate)	Excludes requests that match the given predicate from the CSRF filter.
CsrfFilter.Builder	CsrfFilter.Builder.excludeRequests(Predicate<Request> predicate, String description)	Excludes requests that match the given predicate from the CSRF filter.

Uses of Request in org.forgerock.http.filter.cors

Methods in org.forgerock.http.filter.cors with parameters of type Request

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	CorsFilter.filter(Context context, Request request, Handler next)
Response	CorsPolicy.handlePreflight(Request request, String origin)	Produces the response for a CORS preflight request.

Uses of Request in org.forgerock.http.handler

Methods in org.forgerock.http.handler with parameters of type Request

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	HttpClientHandler.handle(Context context, Request request)	Sends an HTTP request to a remote server and returns a Promise representing the asynchronous response.

Uses of Request in org.forgerock.http.header

Methods in org.forgerock.http.header with parameters of type Request

Modifier and Type	Method	Description
static CookieHeader	CookieHeader.valueOf(Request message)	Constructs a new header, initialized from the specified request message.
static TransactionIdHeader	TransactionIdHeader.valueOf(Request request)	Constructs a new header, initialized from the specified request.

Uses of Request in org.forgerock.http.oauth2

Methods in org.forgerock.http.oauth2 with parameters of type Request

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	ClientSecretBasicAuthenticationFilter.filter(Context context, Request request, Handler next)	Deprecated.
Promise<Response,NeverThrowsException>	ClientSecretPostAuthenticationFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	PrivateKeyJwtClientAuthenticationFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	ResourceServerFilter.filter(Context context, Request request, Handler next)
Promise<Set<String>,ResponseException>	ResourceAccess.getRequiredScopes(Context context, Request request)	Returns the scopes required to access the resource.

Method parameters in org.forgerock.http.oauth2 with type arguments of type Request

Modifier and Type	Method	Description
default Promise<AccessTokenInfo,AccessTokenException>	AccessTokenResolver.resolve(Context context, Supplier<Request,IOException> request, String token)	Resolves a given access token against an authorization server.

Uses of Request in org.forgerock.http.oauth2.resolver

Method parameters in org.forgerock.http.oauth2.resolver with type arguments of type Request

Modifier and Type	Method	Description
Promise<AccessTokenInfo,AccessTokenException>	CachingAccessTokenResolver.resolve(Context context, Supplier<Request,IOException> request, String token)
Promise<AccessTokenInfo,AccessTokenException>	OpenAmAccessTokenResolver.resolve(Context context, Supplier<Request,IOException> request, String token)	Deprecated.
Promise<AccessTokenInfo,AccessTokenException>	TokenIntrospectionAccessTokenResolver.resolve(Context context, Supplier<Request,IOException> request, String token)

Uses of Request in org.forgerock.http.protocol

Methods in org.forgerock.http.protocol that return Request

Modifier and Type	Method	Description
Request	Request.setEntity(Object o)
Request	Request.setMethod(String method)	Sets the method to be performed on the resource.
Request	Request.setUri(String uri)	Sets the fully-qualified string URI of the resource being accessed.
Request	Request.setUri(URI uri)	Sets the fully-qualified URI of the resource being accessed.
Request	Request.setVersion(String version)

Methods in org.forgerock.http.protocol that return types with arguments of type Request

Modifier and Type	Method	Description
LazySupplier<Request,IOException>	Request.lazyCopy()	Returns a Supplier that will lazily copy the request object the first time it is accessed.

Methods in org.forgerock.http.protocol with parameters of type Request

Modifier and Type	Method	Description
void	Form.appendRequestQuery(Request request)	Appends the form as additional query parameters on an existing request URI.
Form	Form.fromRequestEntity(Request request)	Deprecated. Because Entity content should be read asynchronously.
Form	Form.fromRequestQuery(Request request)	Parses the query parameters of a request and stores them in this object.
void	Form.toRequestEntity(Request request)	Populates a request with the necessary headers and entity for the form to be submitted as a POST with application/x-www-form-urlencoded content type.
void	Form.toRequestQuery(Request request)	Sets a request URI with query parameters.

Constructors in org.forgerock.http.protocol with parameters of type Request

Modifier	Constructor	Description
	Request(Request request)	Creates a defensive copy of the given request message.
	RequestCookies(Request request)	Constructs a new request cookies object that reads cookies from the specified request.

Uses of Request in org.forgerock.http.routing

Methods in org.forgerock.http.routing that return types with arguments of type Request

Modifier and Type	Method	Description
protected Pair<RouteMatcher<Request>,Handler>	Router.getSelfApiHandler()
static RouteMatcher<Request>	RouteMatchers.requestResourceApiVersionMatcher(Version version)	Creates a RouteMatcher instance that matches the request resource API version with the provided version.
static RouteMatcher<Request>	RouteMatchers.requestUriMatcher(RoutingMode mode, String template)	Creates a RouteMatcher instance that matches Requests with the provided mode and template.
static RouteMatcher<Request>	RouteMatchers.selfApiMatcher()	A matcher to check if the request is for all versions of the API descriptor of the current path.
protected RouteMatcher<Request>	Router.uriMatcher(RoutingMode mode, String pattern)

Methods in org.forgerock.http.routing with parameters of type Request

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	ResourceApiVersionRoutingFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	Router.handle(Context context, Request request)

Uses of Request in org.forgerock.http.session

Methods in org.forgerock.http.session with parameters of type Request

Modifier and Type	Method	Description
Session	SessionManager.load(Request request)	Deprecated. Loads a new Session for the given Request.
Promise<Session,NeverThrowsException>	AsyncSessionManager.loadAsync(Request request)	Loads a new Session for the given Request.

Uses of Request in org.forgerock.http.spi

Methods in org.forgerock.http.spi with parameters of type Request

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	HttpClient.sendAsync(Request request)	Returns a Promise representing the asynchronous Response of the given request.

Uses of Request in org.forgerock.http.util

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

Modifier and Type	Method	Description
static com.fasterxml.jackson.databind.ObjectWriter	Json.makeLocalizingObjectWriter(com.fasterxml.jackson.databind.ObjectMapper mapper, Request request)	Make an object writer that contains the locales from the request for serialization of LocalizableString instances.

Uses of Request in org.forgerock.oauth.clients.oauth2

Methods in org.forgerock.oauth.clients.oauth2 that return Request

Modifier and Type	Method	Description
protected Request	OAuth2Client.createRequestForUserInfoEndpoint(String accessToken)	Creates a Request for the user information endpoint of an identity provider.

Methods in org.forgerock.oauth.clients.oauth2 that return types with arguments of type Request

Modifier and Type	Method	Description
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForIntrospectEndpoint(String accessToken)	Creates a Request for the introspect endpoint of an identity provider.
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForTokenEndpoint(String code)	Deprecated. Use OAuth2Client.createAuthRedirectUri(String, String) and specify a PKCE verifier.
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForTokenEndpoint(String code, String pkceVerifier)	Creates a Request for the token endpoint of an identity provider.
protected Promise<Request,OAuthException>	OAuth2Client.createRequestForTokenRefresh(JsonValue storedData)	Creates a Request for the token refresh endpoint of an identity provider.

Uses of Request in org.forgerock.oauth2.core

Methods in org.forgerock.oauth2.core that return Request

Modifier and Type	Method	Description
Request	OAuth2Request.getRequest()	Gets the actual underlying request.

Uses of Request in org.forgerock.secrets.oauth2

Methods in org.forgerock.secrets.oauth2 with parameters of type Request

Modifier and Type	Method	Description
protected Promise<Form,NoSuchSecretException>	AuthorizationCodeGrantTypeHandler.handle(Request tokenEndpointRequest, Form form)
protected Promise<Form,NoSuchSecretException>	GrantTypeHandler.handle(Request tokenEndpointRequest, Form form)	Handles the request by adding appropriate parameters to the OAuth 2.0 token endpoint request.
protected Promise<Form,NoSuchSecretException>	JwtBearerGrantTypeHandler.handle(Request tokenEndpointRequest, Form form)
protected Promise<Form,NoSuchSecretException>	RefreshTokenGrantTypeHandler.handle(Request tokenEndpointRequest, Form form)
protected Promise<Form,NoSuchSecretException>	ResourceOwnerPasswordGrantTypeHandler.handle(Request tokenEndpointRequest, Form form)