Package | Description |
---|---|
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.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.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.
|
Modifier and Type | Method and Description |
---|---|
Request |
MessageInfoContext.getRequest()
Gets the request object from this
MessageContextInfo . |
Modifier and Type | Method and Description |
---|---|
void |
MessageInfoContext.setRequest(Request request)
Sets the request object for this
MessageContextInfo . |
Modifier and Type | Method and Description |
---|---|
Request |
MessageContextImpl.getRequest() |
Modifier and Type | Method and 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) |
Modifier and Type | Method and 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)
|
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.send(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. |
Promise<Response,NeverThrowsException> |
Client.sendWithoutClose(Request request)
Sends an HTTP request and returns a
Promise representing the
pending HTTP response. |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
TransactionIdOutboundFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
TransactionIdInboundFilter.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> |
CsrfFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
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.
|
Modifier and Type | Method and 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. |
Modifier and Type | Method and Description |
---|---|
static TransactionIdHeader |
TransactionIdHeader.valueOf(Request request)
Constructs a new header, initialized from the specified request.
|
static CookieHeader |
CookieHeader.valueOf(Request message)
Constructs a new header, initialized from the specified request message.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Modifier and Type | Method and 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) |
Modifier and Type | Method and Description |
---|---|
void |
Form.appendRequestQuery(Request request)
Appends the form as additional query parameters on an existing request
URI.
|
Form |
Form.fromRequestEntity(Request request)
Parses the URL-encoded form entity of a request and stores them in this
object.
|
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.
|
Constructor and 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.
|
Modifier and Type | Method and 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 Request s
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) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ResourceApiVersionRoutingFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
Router.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Session |
SessionManager.load(Request request)
Loads a new Session for the given
Request . |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
HttpClient.sendAsync(Request request)
|
Modifier and Type | Method and 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. |
Modifier and Type | Method and Description |
---|---|
protected Request |
OAuth2Client.createRequestForTokenEndpoint(String code)
Deprecated.
Use
OAuth2Client.createAuthRedirectUri(String, String) and specify a PKCE verifier. |
protected Request |
OAuth2Client.createRequestForTokenEndpoint(String code,
String pkceVerifier)
Creates a
Request for the token endpoint of an identity provider. |
protected Request |
OAuth2Client.createRequestForTokenRefresh(JsonValue storedData)
Creates a
Request for the token refresh endpoint of an identity provider. |
protected Request |
OAuth2Client.createRequestForUserInfoEndpoint(String accessToken)
Creates a
Request for the user information endpoint of an identity provider. |
Modifier and Type | Method and Description |
---|---|
protected void |
OAuth2Client.addClientIdAndSecret(Request request,
Form form)
Adds the client id and client secret to a request
based on the determined type of authentication scheme.
|
Copyright © 2010-2018, ForgeRock All Rights Reserved.