Package | Description |
---|---|
org.forgerock.http |
Models and manages elements of the Hypertext Transfer Protocol.
|
org.forgerock.http.apache |
Base classes for Apache HttpClient (synchronous and asynchronous)
HttpClientProvider implementations. |
org.forgerock.http.apache.async |
Provides
HttpClientHandler client integration with
Apache HttpComponents Http Async Client. |
org.forgerock.http.filter |
Core
Filter implementations. |
org.forgerock.http.filter.throttling |
This package contains the components used to implement a throttling rate support.
|
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.swagger |
Classes to support OpenAPI API Descriptions using Swagger.
|
org.forgerock.http.util |
Miscellaneous utility classes.
|
org.forgerock.json.resource.http |
JSON resource Commons HTTP Framework integration.
|
org.forgerock.monitoring.http |
Common utility classes for monitoring.
|
org.forgerock.openig.doc |
Files for the Sample Application used in the product documentation.
|
org.forgerock.openig.el |
Integrates with the Java Enterprise Edition Unified Expression Language API.
|
org.forgerock.openig.filter |
Filters the requests and/or responses of HTTP.
|
org.forgerock.openig.filter.oauth2 |
This package contains the OAuth2 Token validation filter that acts as an OAuth 2 Resource Server.
|
org.forgerock.openig.filter.oauth2.client |
OAuth 2.0 Client filter implementation.
|
org.forgerock.openig.filter.throttling |
This package contains the components used to implement a throttling rate support.
|
org.forgerock.openig.handler |
Handles HTTP requests by generating responses.
|
org.forgerock.openig.handler.resources |
Contains components and APIs used to serve static resources.
|
org.forgerock.openig.handler.router |
Provides automated router capability that loads its configurations files (called routes) from a given directory.
|
org.forgerock.openig.handler.saml |
Identity Gateway SAML support.
|
org.forgerock.openig.jwt |
Provides JWT capabilities to the Identity Gateway.
|
org.forgerock.openig.openam |
Integration classes specifically for ForgeRock Access Management.
|
org.forgerock.openig.tools |
Common tools used in policy service.
|
org.forgerock.openig.uma |
This package contains the UMA (User Managed Access) components used to support the Uma Resource Server role.
|
org.forgerock.openig.util |
Miscellaneous utility classes.
|
org.forgerock.openig.websocket |
WebSocket proxy support.
|
org.forgerock.openig.websocket.grizzly |
Grizzly filters for WebSocket proxy support.
|
Modifier and Type | Method and Description |
---|---|
Request |
ContextAndRequest.getRequest()
Returns the 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. |
Constructor and Description |
---|
ContextAndRequest(Context context,
Request request)
Constructs a new ContextAndRequest.
|
Modifier and Type | Method and Description |
---|---|
protected org.apache.http.client.methods.HttpUriRequest |
AbstractHttpClient.createHttpUriRequest(Request request)
Creates a new
HttpUriRequest populated from the given request . |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
AsyncStreamingHttpClient.sendAsync(Request request) |
Promise<Response,NeverThrowsException> |
AsyncResponseHttpClient.sendAsync(Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ConditionalFilter.filter(Context context,
Request request,
Handler next) |
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> |
ThrottlingFilter.filter(Context context,
Request request,
Handler next) |
Promise<ThrottlingRate,Exception> |
ThrottlingPolicy.lookup(Context context,
Request request)
Returns the
ThrottlingRate that should be used for the provided request. |
Promise<ThrottlingRate,Exception> |
MappedThrottlingPolicy.lookup(Context context,
Request request) |
Promise<ThrottlingRate,Exception> |
FixedRateThrottlingPolicy.lookup(Context context,
Request request) |
Promise<ThrottlingRate,Exception> |
DefaultRateThrottlingPolicy.lookup(Context context,
Request request) |
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 |
---|---|
Promise<Response,NeverThrowsException> |
OpenApiRequestFilter.filter(Context context,
Request request,
Handler next) |
protected io.swagger.models.Swagger |
OpenApiRequestFilter.setUriDetailsIfNotPresent(Request request,
Context context,
io.swagger.models.Swagger descriptor)
Deduce and set the base URI of the request for the OpenAPI descriptor from the request context.
|
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 |
---|---|
SecurityContext |
SecurityContextFactory.createContext(Context context,
Request request)
Deprecated.
Creates a new
SecurityContext using the attributes contained in
the provided HTTP request. |
Context |
HttpContextFactory.createContext(Context parent,
Request request)
Returns the context which should be used for the provided HTTP request.
|
static RequestType |
HttpUtils.determineRequestType(Request request)
Determines which CREST operation (CRUDPAQ) of the incoming request.
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
PrometheusHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
SampleFilter.filter(Context context,
Request request,
Handler next)
Set a header in the incoming request and in the outgoing response.
|
Modifier and Type | Method and Description |
---|---|
static Bindings |
Bindings.bindings(Context context,
Request request)
|
static Bindings |
Bindings.bindings(Context context,
Request request,
Response response)
|
Modifier and Type | Method and Description |
---|---|
Promise<Set<String>,ResponseException> |
ScriptableResourceAccess.getRequiredScopes(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
OAuth2ClientFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
DiscoveryFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
ClientRegistrationFilter.filter(Context context,
Request request,
Handler next) |
Modifier and Type | Method and Description |
---|---|
Promise<ThrottlingRate,Exception> |
ScriptableThrottlingPolicy.lookup(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
WelcomeHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
StaticResponseHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
SequenceHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
ScriptableHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
ReverseProxyHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
DispatchHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
DesKeyGenHandler.handle(Context context,
Request request) |
Promise<Response,NeverThrowsException> |
ClientHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
ResourceHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
RouterHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
SamlFederationHandler.handle(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Session |
JwtSessionManager.load(Request request) |
Constructor and Description |
---|
JwtCookieSession(Request request,
KeyPair pair,
CookieBuilder cookieBuilder,
Clock clock,
Duration sessionTimeout,
boolean persistentCookie,
SigningHandler signingHandler)
Builds a new JwtCookieSession that will manage the given Request's session.
|
Modifier and Type | Method and Description |
---|---|
protected Promise<Response,NeverThrowsException> |
CdSsoConditionAdviceFilter.doRedirect(Context context,
Request request,
Handler next,
List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices) |
protected abstract Promise<Response,NeverThrowsException> |
AbstractConditionAdviceFilter.doRedirect(Context context,
Request request,
Handler next,
List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices)
Handle redirect to the
instance to verify the required advices. |
Promise<Response,NeverThrowsException> |
UserProfileFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
TokenTransformationFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
SingleSignOnFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
SessionInfoFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
PolicyEnforcementFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
DeprecatedUserProfileFilter.filter(Context context,
Request request,
Handler next)
Deprecated.
|
Promise<Response,NeverThrowsException> |
CrossDomainSingleSignOnFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
CapturedUserPasswordFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
AbstractConditionAdviceFilter.filter(Context context,
Request request,
Handler next) |
String |
ScriptableResourceUriProvider.resourceUri(Context context,
Request request) |
String |
ResourceUriProvider.resourceUri(Context context,
Request request)
Returns the resource URI as a
String to be used when making policy requests. |
String |
RequestResourceUriProvider.resourceUri(Context context,
Request request) |
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
InsertSsoTokenHeaderFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
HeadlessAuthenticationFilter.filter(Context context,
Request request,
Handler next) |
Promise<Response,NeverThrowsException> |
ApiVersionProtocolHeaderFilter.filter(Context context,
Request request,
Handler next) |
static Optional<String> |
JwtUtil.getCookieJwt(Request request,
String name)
Get a JWT from a request, with a given cookie name.
|
static Optional<String> |
JwtUtil.getFormJwt(Request request,
String param)
Get the JWT from a request form parameter.
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
UmaResourceServerFilter.filter(Context context,
Request request,
Handler next) |
org.forgerock.openig.uma.Share |
UmaSharingService.findShare(Request request)
Find a
Share . |
Modifier and Type | Method and Description |
---|---|
static Request |
BaseUriUtil.rebaseRequest(Expression<String> baseUri,
Bindings bindings,
Request request)
Rebase the URI of the request based on the evaluation of the baseUri expression.
|
Modifier and Type | Method and Description |
---|---|
static Request |
BaseUriUtil.rebaseRequest(Expression<String> baseUri,
Bindings bindings,
Request request)
Rebase the URI of the request based on the evaluation of the baseUri expression.
|
Modifier and Type | Method and Description |
---|---|
Promise<Response,NeverThrowsException> |
WebSocketProxyFilter.filter(Context context,
Request request,
Handler next) |
Constructor and Description |
---|
WebSocketExchange(Request request,
PromiseImpl<Response,NeverThrowsException> response,
javax.servlet.http.HttpServletRequest upgrader)
Constructs a new exchange.
|
Copyright 2011-2017 ForgeRock AS.