Uses of Interface
org.forgerock.http.Handler
Packages that use Handler
Package
Description
Models and manages elements of the Hypertext Transfer Protocol.
Core
Filter
implementations.Support for CORS.
Core
Handler
implementations.This package provides APIs for OAuth 2.0 services implementations.
This package defines OpenAM specific logic needed to retrieve an
AccessTokenInfo
.Provides routing functionality for HTTP requests.
Classes to support OpenAPI API Descriptions using Swagger.
JSON resource Commons HTTP Framework integration.
Identity Assertion handler.
Contains an abstract decorator dedicated to Filter and Handler.
Contains decorators that can wrap filters and handlers with tracing contexts.
Filters the requests and/or responses of HTTP.
Filters the HTTP request using a declarative configuration model based on a chain of predicates to validate.
This package contains the components used to implement circuit breaking.
Support for financial APIs (Open Banking, PSD2, Berlin Group, ...).
This package contains the components used to implement some JWT related filter.
This package contains the OAuth2 Token validation filter that acts as an OAuth 2 Resource Server.
OAuth 2.0 Client filter implementation.
JWT confirmation key support for access tokens.
This package contains the components used to implement a throttling rate support.
Handles HTTP requests by generating responses.
Handles the tech preview identity assertion processing.
Contains components and APIs used to serve static resources.
Provides automated router capability that loads its configurations files (called routes) from a given directory.
Integrates with the ForgeRock HTTP Framework.
Integration classes specifically for ForgeRock Access Management.
AM Session idle timeout tracking.
Contains Ping integration components.
This package contains the components used to integrate with PingOne Protect, to support risk evaluation and routing.
Contains every classes related to Ping's sideband API.
Scripting support.
Provides the Common Secrets API for accessing secrets of various kinds.
Provides SQL and JDBC support.
Common tools used in policy service.
Access Management Server.
AM authentication service.
This package contains the UMA (User Managed Access) components used to support the Uma Resource Server role.
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 Handler in org.forgerock.http
Methods in org.forgerock.http that return HandlerModifier and TypeMethodDescriptionHttpApplication.start()
Gets the rootHandler
that will handle all HTTP requests.Methods in org.forgerock.http with parameters of type HandlerModifier and TypeMethodDescriptionstatic DescribedHttpApplication
Applications.describedHttpApplication
(Handler handler, Factory<Buffer> storage, ApiProducer<io.swagger.models.Swagger> apiProducer) Create a simpleDescribedHttpApplication
that just returns the provided arguments from the appropriate methods.Filters the request and/or response of an exchange.static HttpApplication
Applications.simpleHttpApplication
(Handler handler, Factory<Buffer> storage) Create a simpleHttpApplication
that just returns the provided arguments from the appropriate methods.Constructors in org.forgerock.http with parameters of type HandlerModifierConstructorDescriptionCreates a newClient
which will route HTTP requests to the providedHandler
using aRootContext
allocated during construction when none is provided. -
Uses of Handler in org.forgerock.http.filter
Methods in org.forgerock.http.filter with parameters of type HandlerModifier and TypeMethodDescriptionCsrfFilter.Builder.failureHandler
(Handler failureHandler) Add a handler which will be responsible of creating a response in case of missing/wrong CSRF token.Handles all OPTION requests to CREST resources, all other request methods are handled by theHandler
. -
Uses of Handler in org.forgerock.http.filter.cors
Methods in org.forgerock.http.filter.cors with parameters of type HandlerModifier and TypeMethodDescriptionConstructors in org.forgerock.http.filter.cors with parameters of type HandlerModifierConstructorDescriptionCorsFilter
(CorsPolicyProvider provider, Handler failureHandler) Constructs a new CORS filter using the givenCorsPolicyProvider
andfailureHandler
. -
Uses of Handler in org.forgerock.http.handler
Subinterfaces of Handler in org.forgerock.http.handlerModifier and TypeInterfaceDescriptioninterface
A handler that both handlesRequest
s, and also supports querying for API Descriptors.Classes in org.forgerock.http.handler that implement HandlerModifier and TypeClassDescriptionfinal class
An HTTP client for sending requests to remote servers.Methods in org.forgerock.http.handler that return HandlerModifier and TypeMethodDescriptionstatic Handler
Handlers.forbiddenHandler()
A common HTTP FrameworkHandler
responding 403 Forbidden.static Handler
Handlers.internalServerErrorHandler
(Exception cause) A common HTTP FrameworkHandler
responding 500 Internal Server Error.Methods in org.forgerock.http.handler with parameters of type HandlerModifier and TypeMethodDescriptionstatic DescribableHandler
Handlers.asDescribableHandler
(Handler handler) Adapts aHandler
to aDescribableHandler
without adding support for API Descriptions if it is not already implemented.static DescribableHandler
Creates aHandler
which wraps the provided filters around the provided target handler.static DescribableHandler
Creates aHandler
which wraps the provided filters around the provided target handler.static DescribableHandler
Creates a "filtered handler" instance. -
Uses of Handler in org.forgerock.http.oauth2
Methods in org.forgerock.http.oauth2 with parameters of type HandlerModifier and TypeMethodDescriptionDeprecated. -
Uses of Handler in org.forgerock.http.oauth2.resolver
Constructors in org.forgerock.http.oauth2.resolver with parameters of type HandlerModifierConstructorDescriptionOpenAmAccessTokenResolver
(Handler client, Clock clock, String tokenInfoEndpoint) Deprecated.Creates a newOpenAmAccessTokenResolver
configured to access the given /oauth2/tokeninfo OpenAm endpoint.TokenIntrospectionAccessTokenResolver
(Handler client, URI introspectionEndpointUri) Creates a newTokenIntrospectionAccessTokenResolver
. -
Uses of Handler in org.forgerock.http.routing
Classes in org.forgerock.http.routing that implement HandlerModifier and TypeClassDescriptionfinal class
A router which routes requests based on route matchers.Methods in org.forgerock.http.routing that return types with arguments of type HandlerModifier and TypeMethodDescriptionprotected Pair<RouteMatcher<Request>,
Handler> Router.getSelfApiHandler()
Methods in org.forgerock.http.routing with parameters of type Handler -
Uses of Handler in org.forgerock.http.swagger
Methods in org.forgerock.http.swagger with parameters of type Handler -
Uses of Handler in org.forgerock.json.resource.http
Methods in org.forgerock.json.resource.http that return HandlerModifier and TypeMethodDescriptionstatic Handler
CrestHttp.newHttpHandler
(ConnectionFactory connectionFactory) Deprecated.static Handler
CrestHttp.newHttpHandler
(ConnectionFactory connectionFactory, HttpContextFactory contextFactory) Deprecated.UseCrestHttp.newHttpHandler(CrestApplication)
instead.static Handler
CrestHttp.newHttpHandler
(ConnectionFactory connectionFactory, Context parentContext) Deprecated.UseCrestHttp.newHttpHandler(CrestApplication)
instead.static Handler
CrestHttp.newHttpHandler
(CrestApplication application) Deprecated.Since 25.0.0.static Handler
CrestHttp.newHttpHandler
(CrestApplication application, HttpContextFactory factory) Deprecated.Since 25.0.0.static Handler
CrestHttp.newHttpHandler
(CrestApplication application, HttpContextFactory factory, Factory<Buffer> bufferFactory) Creates a new JSON resource HTTP handler with the provided CREST request handler.static Handler
CrestHttp.newHttpHandler
(CrestApplication application, Context context) Deprecated.Since 25.0.0.static Handler
CrestHttp.newHttpHandler
(CrestApplication application, Context context, Factory<Buffer> bufferFactory) Creates a new JSON resource HTTP handler with the provided CREST request handler.static Handler
CrestHttp.newHttpHandler
(CrestApplication application, Factory<Buffer> bufferFactory) Creates a new JSON resource HTTP handler with the provided CREST request handler.static Handler
CrestHttp.newHttpHandler
(RequestHandler handler) Deprecated.UseCrestHttp.newHttpHandler(CrestApplication)
instead.Methods in org.forgerock.json.resource.http with parameters of type HandlerModifier and TypeMethodDescriptionstatic ConnectionFactory
CrestHttp.newConnectionFactory
(Handler handler, URI uri) Creates a newConnectionFactory
that map back and forth JSON resource objects to CHF objects.static RequestHandler
CrestHttp.newRequestHandler
(Handler handler, URI uri) Creates a newRequestHandler
that map back and forth JSON resource objects to CHF objects. -
Uses of Handler in org.forgerock.openig.assertion.handler
Classes in org.forgerock.openig.assertion.handler that implement HandlerModifier and TypeClassDescriptionfinal class
Provides support to locally process a user and generate a JWT assertion that represents the user back to the calling party. -
Uses of Handler in org.forgerock.openig.decoration.helper
Methods in org.forgerock.openig.decoration.helper with parameters of type HandlerModifier and TypeMethodDescriptionprotected abstract DecorationHandle
AbstractHandlerAndFilterDecorator.decorateHandler
(Handler delegate, JsonValue decoratorConfig, Context context) Deprecated. -
Uses of Handler in org.forgerock.openig.decoration.tracing
Methods in org.forgerock.openig.decoration.tracing that return HandlerModifier and TypeMethodDescriptionTracingDecoratorFactory.HandlerFactory.wrap
(Handler delegate, String spanName, org.forgerock.openig.tracing.TracingProvider tracingProvider) Methods in org.forgerock.openig.decoration.tracing that return types with arguments of type HandlerMethods in org.forgerock.openig.decoration.tracing with parameters of type Handler -
Uses of Handler in org.forgerock.openig.filter
Methods in org.forgerock.openig.filter with parameters of type HandlerModifier and TypeMethodDescriptionSwitchFilter.addRequestCase
(Expression<Boolean> condition, Handler handler) Add a request switch case with a condition and the handler to execute if condition yields.SwitchFilter.addResponseCase
(Expression<Boolean> condition, Handler handler) Add a response switch case with a condition and the handler to execute if condition yields.Constructors in org.forgerock.openig.filter with parameters of type HandlerModifierConstructorDescriptionConditionEnforcementFilter
(Expression<Boolean> condition, Handler failureHandler) Creates a newConditionEnforcementFilter
.HttpBasicAuthFilter
(Expression<String> username, Expression<String> password, Handler failureHandler) Builds aHttpBasicAuthFilter
with required expressions and error handler. -
Uses of Handler in org.forgerock.openig.filter.allow
Methods in org.forgerock.openig.filter.allow with parameters of type HandlerModifier and TypeMethodDescriptionConstructors in org.forgerock.openig.filter.allow with parameters of type HandlerModifierConstructorDescriptionAllowOnlyFilter
(org.forgerock.openig.filter.allow.TraceablePredicate predicate, Handler failureHandler, org.forgerock.openig.filter.allow.ReporterFactory reporterFactory) Constructs anAllowOnlyFilter
. -
Uses of Handler in org.forgerock.openig.filter.circuitbreaker
Methods in org.forgerock.openig.filter.circuitbreaker with parameters of type Handler -
Uses of Handler in org.forgerock.openig.filter.finance
Methods in org.forgerock.openig.filter.finance with parameters of type Handler -
Uses of Handler in org.forgerock.openig.filter.jwt
Methods in org.forgerock.openig.filter.jwt with parameters of type HandlerModifier and TypeMethodDescriptionConstructors in org.forgerock.openig.filter.jwt with parameters of type HandlerModifierConstructorDescriptionJwtValidationFilter
(Expression<String> jwtResolver, JwtValidator validator, Handler failureHandler) Constructs a JwtValidationFilter. -
Uses of Handler in org.forgerock.openig.filter.oauth2
Methods in org.forgerock.openig.filter.oauth2 with parameters of type HandlerModifier and TypeMethodDescriptionConstructors in org.forgerock.openig.filter.oauth2 with parameters of type HandlerModifierConstructorDescriptionOAuth2TokenExchangeFilter
(URI endpoint, Handler handler, Expression<String> subjectTokenExpression, String subjectTokenType, String requestedTokenType, ResourceAccess scopesAccess, URI resource, String audience, Handler failureHandler) Construct a newOAuth2TokenExchangeFilter
. -
Uses of Handler in org.forgerock.openig.filter.oauth2.client
Methods in org.forgerock.openig.filter.oauth2.client that return HandlerModifier and TypeMethodDescriptionprotected Handler
ClientCredentialsOAuth2ClientFilterHeaplet.getOrDefaultEndpointHandler()
Methods in org.forgerock.openig.filter.oauth2.client with parameters of type HandlerModifier and TypeMethodDescriptionOAuth2ClientFilter.setFailureHandler
(Handler handler) Sets the handler which will be invoked when authentication fails.Constructors in org.forgerock.openig.filter.oauth2.client with parameters of type HandlerModifierConstructorDescriptionOAuth2ClientFilter
(org.forgerock.openig.filter.oauth2.client.ClientRegistrationRepository registrations, PerItemEvictionStrategyCache<String, Promise<Map<String, Object>, OAuth2ErrorException>> userInfoCache, String prompt, org.forgerock.openig.filter.oauth2.client.UriValidationService validationService, Clock clock, Handler discoveryAndDynamicRegistrationChain, Expression<String> clientEndpoint, Handler idpSelectionLoginPageHandler) Constructs anOAuth2ClientFilter
. -
Uses of Handler in org.forgerock.openig.filter.oauth2.cnf
Methods in org.forgerock.openig.filter.oauth2.cnf with parameters of type HandlerModifier and TypeMethodDescriptionConstructors in org.forgerock.openig.filter.oauth2.cnf with parameters of type HandlerModifierConstructorDescriptionCertificateThumbprintFilter
(Expression<Certificate> certExpr, Handler failureHandler) Build a CertificateThumbprintFilter that will compute a certificate thumbprint based on the givencertExpr
. -
Uses of Handler in org.forgerock.openig.filter.throttling
Methods in org.forgerock.openig.filter.throttling with parameters of type Handler -
Uses of Handler in org.forgerock.openig.handler
Classes in org.forgerock.openig.handler that implement HandlerModifier and TypeClassDescriptionclass
Dispatches to one of a list of handlers.class
Creates a JwkSetHandler to store the cryptographic keys.class
A scriptable handler.class
Processes a request through a sequence of handlers.class
Creates a static HTTP response.class
Creates a static response containing a simple HTML welcome page.Fields in org.forgerock.openig.handler declared as HandlerModifier and TypeFieldDescriptionstatic final Handler
Handlers.BAD_REQUEST
static final Handler
Handlers.FORBIDDEN
static final Handler
Handlers.INTERNAL_SERVER_ERROR
static final Handler
Handlers.NO_CONTENT
static final Handler
Handlers.UNAUTHORIZED
Methods in org.forgerock.openig.handler with parameters of type HandlerModifier and TypeMethodDescriptionDispatchHandler.addBinding
(Expression<Boolean> condition, Handler handler, Expression<String> baseURI) Binds an expression to the current handler to dispatch to.SequenceHandler.addBinding
(Handler handler, Expression<Boolean> postCondition) Binds sequenced handlers with sequence processing post-conditions.DispatchHandler.addUnconditionalBinding
(Handler handler, Expression<String> baseURI) Adds an unconditional bindings to the handler. -
Uses of Handler in org.forgerock.openig.handler.assertion
Classes in org.forgerock.openig.handler.assertion that implement HandlerModifier and TypeClassDescriptionfinal class
Provides support to locally process a user and generate a JWT assertion that represents the user back to the calling party. -
Uses of Handler in org.forgerock.openig.handler.resources
Classes in org.forgerock.openig.handler.resources that implement HandlerModifier and TypeClassDescriptionclass
AResourceHandler
is a handler that serves static content (content of a directory, or a zip). -
Uses of Handler in org.forgerock.openig.handler.router
Classes in org.forgerock.openig.handler.router that implement HandlerMethods in org.forgerock.openig.handler.router with parameters of type HandlerModifier and TypeMethodDescriptionConstructors in org.forgerock.openig.handler.router with parameters of type HandlerModifierConstructorDescriptionRouterHandler
(org.forgerock.openig.handler.router.RouteBuilder builder, org.forgerock.openig.handler.router.DirectoryMonitor directoryMonitor, org.forgerock.monitoring.api.instrument.MeterRegistry routerMeterRegistry, Handler defaultHandler) Builds a router that loads its configuration from the given directory. -
Uses of Handler in org.forgerock.openig.http
Methods in org.forgerock.openig.http that return HandlerModifier and TypeMethodDescriptionBaseAdminHttpApplication.start()
GatewayHttpApplication.start()
Methods in org.forgerock.openig.http with parameters of type HandlerModifier and TypeMethodDescriptionRegisters a new endpoint under the givenname
.Method parameters in org.forgerock.openig.http with type arguments of type HandlerModifier and TypeMethodDescription<E extends Exception>
Optional<EndpointRegistry.Registration>EndpointRegistry.tryRegister
(String name, Supplier<Handler, E> handler) Registers a new endpoint under the givenname
, but only if the registry is not restricted. -
Uses of Handler in org.forgerock.openig.openam
Methods in org.forgerock.openig.openam with parameters of type HandlerModifier and TypeMethodDescriptionprotected abstract Promise<Response,
NeverThrowsException> AbstractConditionAdviceFilter.doRedirect
(Context context, Request request, Handler next, List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices, URI originalUri) Handle redirect to theinstance
to verify the required advices.protected Promise<Response,
NeverThrowsException> CdSsoConditionAdviceFilter.doRedirect
(Context context, Request request, Handler next, List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices, URI originalUri) Constructors in org.forgerock.openig.openam with parameters of type HandlerModifierConstructorDescriptionPolicyEnforcementFilter
(RequestHandler requestHandler, Handler failureHandler, SessionService sessionService, ResourceUriProvider resourceUriProvider) Creates a new enforcement filter.TokenTransformationFilter
(Handler handler, URI endpoint, Expression<String> idToken) Constructs a new TokenTransformationFilter transforming the OpenID Connect id_token fromidToken
into a SAML 2.0 Assertions structure (intoStsContext
). -
Uses of Handler in org.forgerock.openig.openam.session
Methods in org.forgerock.openig.openam.session with parameters of type Handler -
Uses of Handler in org.forgerock.openig.ping
Methods in org.forgerock.openig.ping that return HandlerModifier and TypeMethodDescriptionPingOneService.getEndpointHandler()
Get theHandler
providing access to the service endpoint. -
Uses of Handler in org.forgerock.openig.ping.protect
Classes in org.forgerock.openig.ping.protect that implement HandlerModifier and TypeClassDescriptionclass
ThePingOneProtectThreatLevelRoutingHandler
routes the request to one of the configured handlers, based on thePingOneProtectEvaluationContext's level
, captured during evaluation.Methods in org.forgerock.openig.ping.protect with parameters of type HandlerModifier and TypeMethodDescription -
Uses of Handler in org.forgerock.openig.ping.sideband
Methods in org.forgerock.openig.ping.sideband with parameters of type HandlerModifier and TypeMethodDescriptionConstructors in org.forgerock.openig.ping.sideband with parameters of type HandlerModifierConstructorDescriptionSidebandApiFilter
(URI gatewayServiceUri, Handler sidebandApiHandler, List<String> sendBodyOnTheseContentTypes) Create a new Sideband API Filter. -
Uses of Handler in org.forgerock.openig.script
Methods in org.forgerock.openig.script with parameters of type HandlerModifier and TypeMethodDescriptionvoid
AbstractScriptableHeapObject.setClientHandler
(Handler clientHandler) Sets the HTTP client handler which should be made available to scripts. -
Uses of Handler in org.forgerock.openig.secrets
Methods in org.forgerock.openig.secrets with parameters of type HandlerModifier and TypeMethodDescriptionJwkSetSecretStoreHeaplet.jwkSetSecretProvider
(URI jwkUri, Handler handler, Clock clock) Create a Secrets provider backed by aJwkSetSecretStore
with default values.JwkSetSecretStoreHeaplet.jwkSetSecretStore
(URL jwkUrl, Handler handler, Clock clock) Create aJwkSetSecretStore
with default values. -
Uses of Handler in org.forgerock.openig.sql
Methods in org.forgerock.openig.sql with parameters of type Handler -
Uses of Handler in org.forgerock.openig.tools
Methods in org.forgerock.openig.tools with parameters of type HandlerModifier and TypeMethodDescription -
Uses of Handler in org.forgerock.openig.tools.am
Methods in org.forgerock.openig.tools.am that return HandlerModifier and TypeMethodDescriptionAmService.getAuthenticatedHandler()
Returns aHandler
that will perform automatic authentication with the provided agent credentials.AmService.getHandler()
Returns the handler to use with this configuration.AmService.withHeadlessAuthentication
(Handler delegate) Returns aHandler
which wraps theHeadlessAuthenticationFilter
.Methods in org.forgerock.openig.tools.am with parameters of type HandlerModifier and TypeMethodDescriptionstatic AmService.Discovery
AmService.discovery
(URI baseUri, Realm realm, String cookieName, Version versionHint, String agentId, SecretReference<GenericSecret> agentPassword, Handler amHandler, org.forgerock.openig.tracing.TracingProvider tracingProvider) Create an AM Discovery object which will get information from AM upon building.AmService.withHeadlessAuthentication
(Handler delegate) Returns aHandler
which wraps theHeadlessAuthenticationFilter
.Constructors in org.forgerock.openig.tools.am with parameters of type HandlerModifierConstructorDescriptionBuilder
(Handler amHandler, Clock clock, String agentId, String cookieName, AmVersion version, UriService uriService, AsyncRefreshableSupplier<SsoToken, AuthenticationException> tokenProvider, org.forgerock.openig.tracing.TracingProvider tracingProvider) Create a Builder instance with every mandatory parameters. -
Uses of Handler in org.forgerock.openig.tools.authentication
Methods in org.forgerock.openig.tools.authentication with parameters of type HandlerModifier and TypeMethodDescriptionstatic AuthenticationService
AuthenticatorAuthenticationService.createAgentAuthenticationService
(Handler amHandler, URI authenticateUri, AmVersion version) Return an instance of anAuthenticationService
for Agent authentication based on theAmVersion
. -
Uses of Handler in org.forgerock.openig.uma
Methods in org.forgerock.openig.uma with parameters of type HandlerModifier and TypeMethodDescriptionConstructors in org.forgerock.openig.uma with parameters of type HandlerModifierConstructorDescriptionUmaResourceServerFilter
(UmaSharingService umaService, Handler protectionApiHandler, String realm) Constructs a new UmaResourceServerFilter. -
Uses of Handler in org.forgerock.secrets.oauth2
Methods in org.forgerock.secrets.oauth2 with parameters of type HandlerModifier and TypeMethodDescriptionAccessTokenSecretStore.Builder.withHandler
(Handler handler) Configures theHandler
to use for sending requests to the token endpoint.
CrestHttp.newHttpHandler(CrestApplication)
instead.