Uses of Interface
org.forgerock.http.Handler

Packages that use Handler

Package	Description
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.routing	Provides routing functionality for HTTP requests.
org.forgerock.http.swagger	Classes to support OpenAPI API Descriptions using Swagger.
org.forgerock.json.resource.http	JSON resource Commons HTTP Framework integration.
org.forgerock.microservices.tokenvalidation	This package will hold the classes need to implement the Token Validation Microservice.
org.forgerock.openig.decoration.baseuri	Contains a decorator which overrides the existing request URI, making requests relative to a new base URI.
org.forgerock.openig.decoration.capture	Capture decoration classes that prints filters and handlers input and output messages.
org.forgerock.openig.decoration.helper	Contains an abstract decorator dedicated to Filter and Handler.
org.forgerock.openig.decoration.timer	Contains a decorator that log time elapsed in a Filter or a Handler.
org.forgerock.openig.filter	Filters the requests and/or responses of HTTP.
org.forgerock.openig.filter.finance	Support for financial APIs (Open Banking, PSD2, Berlin Group, ...).
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.heap	Manages collections or "heaps" of associated objects, initialized from declarative configuration artifacts.
org.forgerock.openig.http	Integrates with the ForgeRock HTTP Framework.
org.forgerock.openig.openam	Integration classes specifically for ForgeRock Access Management.
org.forgerock.openig.script	Scripting support.
org.forgerock.openig.sql	Provides SQL and JDBC support.
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 Handler in org.forgerock.http

Methods in org.forgerock.http that return Handler

Modifier and Type	Method	Description
Handler	HttpApplication.start()	Gets the root Handler that will handle all HTTP requests.

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

Modifier and Type	Method	Description
static DescribedHttpApplication	Applications.describedHttpApplication(Handler handler, Factory<Buffer> storage, ApiProducer<io.swagger.models.Swagger> apiProducer)	Create a simple DescribedHttpApplication that just returns the provided arguments from the appropriate methods.
Promise<Response,NeverThrowsException>	Filter.filter(Context context, Request request, Handler next)	Filters the request and/or response of an exchange.
static HttpApplication	Applications.simpleHttpApplication(Handler handler, Factory<Buffer> storage)	Create a simple HttpApplication that just returns the provided arguments from the appropriate methods.

Constructors in org.forgerock.http with parameters of type Handler

Constructor	Description
Client(Handler handler)	Creates a new Client which will route HTTP requests to the provided Handler using a RootContext allocated during construction when none is provided.
Client(Handler handler, Context defaultContext)	Creates a new Client which will route HTTP requests to the provided Handler using the specified Context if none is provided.

Uses of Handler in org.forgerock.http.filter

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

Modifier and Type	Method	Description
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)

Uses of Handler in org.forgerock.http.handler

Subinterfaces of Handler in org.forgerock.http.handler

Modifier and Type	Interface	Description
interface	DescribableHandler	A handler that both handles Requests, and also supports querying for API Descriptors.

Classes in org.forgerock.http.handler that implement Handler

Modifier and Type	Class	Description
class	HttpClientHandler	An HTTP client for sending requests to remote servers.

Methods in org.forgerock.http.handler that return Handler

Modifier and Type	Method	Description
static Handler	Handlers.internalServerErrorHandler(Exception cause)	A common HTTP Framework Handler responding 500 Internal Server Error.

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

Modifier and Type	Method	Description
static DescribableHandler	Handlers.asDescribableHandler(Handler handler)	Adapts a Handler to a DescribableHandler without adding support for API Descriptions if it is not already implemented.
static DescribableHandler	Handlers.chainOf(Handler handler, List<Filter> filters)	Creates a Handler which wraps the provided filters around the provided target handler.
static DescribableHandler	Handlers.chainOf(Handler handler, Filter... filters)	Creates a Handler which wraps the provided filters around the provided target handler.
static DescribableHandler	Handlers.filtered(Handler handler, Filter filter)	Creates a "filtered handler" instance.

Uses of Handler in org.forgerock.http.routing

Classes in org.forgerock.http.routing that implement Handler

Modifier and Type	Class	Description
class	Router	A router which routes requests based on route matchers.

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

Modifier and Type	Method	Description
protected Pair<RouteMatcher<Request>,Handler>	Router.getSelfApiHandler()

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

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

Uses of Handler in org.forgerock.http.swagger

Methods in org.forgerock.http.swagger with parameters of type Handler

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

Uses of Handler in org.forgerock.json.resource.http

Methods in org.forgerock.json.resource.http that return Handler

Modifier and Type	Method	Description
static Handler	CrestHttp.newHttpHandler(ConnectionFactory connectionFactory)	Deprecated. Use CrestHttp.newHttpHandler(CrestApplication) instead.
static Handler	CrestHttp.newHttpHandler(ConnectionFactory connectionFactory, HttpContextFactory contextFactory)	Deprecated. Use CrestHttp.newHttpHandler(CrestApplication) instead.
static Handler	CrestHttp.newHttpHandler(ConnectionFactory connectionFactory, Context parentContext)	Deprecated. Use CrestHttp.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. Use CrestHttp.newHttpHandler(CrestApplication) instead.

Methods in org.forgerock.json.resource.http with parameters of type Handler

Modifier and Type	Method	Description
static ConnectionFactory	CrestHttp.newConnectionFactory(Handler handler, URI uri)	Creates a new ConnectionFactory that map back and forth JSON resource objects to CHF objects.
static RequestHandler	CrestHttp.newRequestHandler(Handler handler, URI uri)	Creates a new RequestHandler that map back and forth JSON resource objects to CHF objects.

Uses of Handler in org.forgerock.microservices.tokenvalidation

Classes in org.forgerock.microservices.tokenvalidation that implement Handler

Modifier and Type	Class	Description
class	IntrospectHandler	This Handler will provide an introspection feature for the provided OAuth2 access tokens.

Uses of Handler in org.forgerock.openig.decoration.baseuri

Methods in org.forgerock.openig.decoration.baseuri with parameters of type Handler

Modifier and Type	Method	Description
protected DecorationHandle	BaseUriDecorator.decorateHandler(Handler delegate, JsonValue decoratorConfig, Context context)

Uses of Handler in org.forgerock.openig.decoration.capture

Methods in org.forgerock.openig.decoration.capture with parameters of type Handler

Modifier and Type	Method	Description
protected DecorationHandle	CaptureDecorator.decorateHandler(Handler delegate, JsonValue decoratorConfig, Context context)

Uses of Handler in org.forgerock.openig.decoration.helper

Methods in org.forgerock.openig.decoration.helper with parameters of type Handler

Modifier and Type	Method	Description
protected abstract DecorationHandle	AbstractHandlerAndFilterDecorator.decorateHandler(Handler delegate, JsonValue decoratorConfig, Context context)	Decorates the provided delegate Handler instance with the provided decoratorConfig configuration.

Uses of Handler in org.forgerock.openig.decoration.timer

Methods in org.forgerock.openig.decoration.timer with parameters of type Handler

Modifier and Type	Method	Description
protected DecorationHandle	TimerDecorator.decorateHandler(Handler delegate, JsonValue decoratorConfig, Context context)

Uses of Handler in org.forgerock.openig.filter

Methods in org.forgerock.openig.filter with parameters of type Handler

Modifier and Type	Method	Description
SwitchFilter	SwitchFilter.addRequestCase(Expression<Boolean> condition, Handler handler)	Add a request switch case with a condition and the handler to execute if condition yields.
SwitchFilter	SwitchFilter.addResponseCase(Expression<Boolean> condition, Handler handler)	Add a response switch case with a condition and the handler to execute if condition yields.
Promise<Response,NeverThrowsException>	AssignmentFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	ConditionalFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	ConditionEnforcementFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	CookieFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	CryptoHeaderFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	DateHeaderFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	EntityExtractFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	FileAttributesFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	HeaderFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	HttpAccessAuditFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	HttpBasicAuthFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	JwtBuilderFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	LocationHeaderFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	LogAttachedExceptionFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	MdcRouteIdFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	MetricsFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	RetryFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	RuntimeExceptionFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	ScriptableFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	StaticRequestFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	SwitchFilter.filter(Context context, Request request, Handler next)

Constructors in org.forgerock.openig.filter with parameters of type Handler

Constructor	Description
ConditionEnforcementFilter(Expression<Boolean> condition, Handler failureHandler)	Creates a new ConditionEnforcementFilter.
HttpBasicAuthFilter(Expression<String> username, Expression<String> password, Handler failureHandler)	Builds a HttpBasicAuthFilter with required expressions and error handler.

Uses of Handler in org.forgerock.openig.filter.finance

Methods in org.forgerock.openig.filter.finance with parameters of type Handler

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

Uses of Handler in org.forgerock.openig.filter.oauth2.client

Methods in org.forgerock.openig.filter.oauth2.client with parameters of type Handler

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	ClientRegistrationFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	DiscoveryFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	IdTokenValidationFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	OAuth2ClientFilter.filter(Context context, Request request, Handler next)
Promise<Issuer,DiscoveryException>	IssuerRepository.findOrCreateFromWellKnownUri(String issuerName, URI wellKnownUri, List<Pattern> supportedDomains, Handler handler)	Tries to find an already registered Issuer named issuerName.
OAuth2ClientFilter	OAuth2ClientFilter.setFailureHandler(Handler handler)	Sets the handler which will be invoked when authentication fails.
OAuth2ClientFilter	OAuth2ClientFilter.setLoginHandler(Handler handler)	Sets the handler which will be invoked when the user needs to authenticate.

Constructors in org.forgerock.openig.filter.oauth2.client with parameters of type Handler

Constructor	Description
ClientRegistration(String clientId, String name, List<String> scopes, Issuer issuer, Handler registrationHandler, org.forgerock.openig.filter.oauth2.client.ClientAuthentication clientAuthentication)	Creates a Client Registration.
IdTokenValidationFilter(Expression<String> idToken, Clock clock, String audience, String issuer, TemporalAmount skewAllowance, org.forgerock.openig.tools.jwt.JwsSignatureVerifier verifier, Handler failureHandler)	Constructs a IdTokenValidationFilter.
IssuerRepository(Handler defaultIssuerHandler)	Creates an IssuerRepository.
OAuth2ClientFilter(org.forgerock.openig.filter.oauth2.client.ClientRegistrationRepository registrations, PerItemEvictionStrategyCache<String,Promise<Map<String,Object>,OAuth2ErrorException>> userInfoCache, Clock clock, Handler discoveryAndDynamicRegistrationChain, Expression<String> clientEndpoint)	Constructs an OAuth2ClientFilter.

Uses of Handler in org.forgerock.openig.filter.throttling

Methods in org.forgerock.openig.filter.throttling with parameters of type Handler

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

Uses of Handler in org.forgerock.openig.handler

Classes in org.forgerock.openig.handler that implement Handler

Modifier and Type	Class	Description
class	ClientHandler	Submits requests to remote servers.
class	DesKeyGenHandler	Creates a static response with a generated DES key.
class	DispatchHandler	Dispatches to one of a list of handlers.
class	ReverseProxyHandler	A ReverseProxyHandler is a ClientHandler that is also responsible to turn RuntimeException into Status.BAD_GATEWAY response, as expected on the normal flow of request reaching the application when the proxy fails to connect to the backend application.
class	ScriptableHandler	A scriptable handler.
class	SequenceHandler	Processes a request through a sequence of handlers.
class	StaticResponseHandler	Creates a static HTTP response.
class	WelcomeHandler	Creates a static response containing a simple HTML welcome page.

Fields in org.forgerock.openig.handler declared as Handler

Modifier and Type	Field	Description
static Handler	Handlers.FORBIDDEN	A default Handler implementation that returns an empty (403 Forbidden) Response.
static Handler	Handlers.NO_CONTENT	A default Handler implementation that returns an empty (204 No Content) Response.

Methods in org.forgerock.openig.handler with parameters of type Handler

Modifier and Type	Method	Description
DispatchHandler	DispatchHandler.addBinding(Expression<Boolean> condition, Handler handler, Expression<String> baseURI)	Binds an expression to the current handler to dispatch to.
SequenceHandler	SequenceHandler.addBinding(Handler handler, Expression<Boolean> postcondition)	Binds sequenced handlers with sequence processing postconditions.
DispatchHandler	DispatchHandler.addUnconditionalBinding(Handler handler, Expression<String> baseURI)	Adds an unconditional bindings to the handler.

Constructors in org.forgerock.openig.handler with parameters of type Handler

Constructor	Description
ClientHandler(Handler delegate)	Creates a new client handler.

Uses of Handler in org.forgerock.openig.handler.resources

Classes in org.forgerock.openig.handler.resources that implement Handler

Modifier and Type	Class	Description
class	ResourceHandler	A ResourceHandler 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 Handler

Modifier and Type	Class	Description
class	RouterHandler	Auto-configured DispatchHandler.

Methods in org.forgerock.openig.handler.router with parameters of type Handler

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

Constructors in org.forgerock.openig.handler.router with parameters of type Handler

Constructor	Description
RouterHandler(org.forgerock.openig.handler.router.RouteBuilder builder, org.forgerock.openig.handler.router.DirectoryMonitor directoryMonitor, org.forgerock.monitoring.api.instrument.MeterRegistry routerMeterRegistry, Handler defaultHandler, Factory<Buffer> bufferFactory)	Builds a router that loads its configuration from the given directory.

Uses of Handler in org.forgerock.openig.heap

Methods in org.forgerock.openig.heap that return Handler

Modifier and Type	Method	Description
Handler	HeapImpl.getHandler()	Returns the Handler object referenced by the handler top-level attribute.

Uses of Handler in org.forgerock.openig.http

Methods in org.forgerock.openig.http that return Handler

Modifier and Type	Method	Description
Handler	AdminHttpApplication.start()
Handler	GatewayHttpApplication.start()

Methods in org.forgerock.openig.http with parameters of type Handler

Modifier and Type	Method	Description
EndpointRegistry.Registration	EndpointRegistry.register(String name, Handler handler)	Registers a new endpoint under the given name.

Uses of Handler in org.forgerock.openig.openam

Methods in org.forgerock.openig.openam with parameters of type Handler

Modifier and Type	Method	Description
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.
protected Promise<Response,NeverThrowsException>	CdSsoConditionAdviceFilter.doRedirect(Context context, Request request, Handler next, List<org.forgerock.openig.openam.AbstractConditionAdviceFilter.Advice> advices)
Promise<Response,NeverThrowsException>	AbstractConditionAdviceFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	CapturedUserPasswordFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	CrossDomainSingleSignOnFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	DeprecatedUserProfileFilter.filter(Context context, Request request, Handler next)	Deprecated.
Promise<Response,NeverThrowsException>	PolicyEnforcementFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	SessionInfoFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	SingleSignOnFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	TokenTransformationFilter.filter(Context context, Request request, Handler next)
Promise<Response,NeverThrowsException>	UserProfileFilter.filter(Context context, Request request, Handler next)

Constructors in org.forgerock.openig.openam with parameters of type Handler

Constructor	Description
CrossDomainSingleSignOnFilter(org.forgerock.openig.tools.am.AmService amService, String clientId, String redirectEndpoint, CookieBuilder cookieBuilder, Supplier<String> idSupplier, org.forgerock.openig.tools.jwt.JwsSignatureVerifier verifier, Clock clock, Handler failureHandler)	Creates a new CrossDomainSingleSignOnFilter.
PolicyEnforcementFilter(RequestHandler requestHandler, Handler failureHandler, org.forgerock.openig.tools.session.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 from idToken into a SAML 2.0 Assertions structure (into StsContext).

Uses of Handler in org.forgerock.openig.script

Methods in org.forgerock.openig.script with parameters of type Handler

Modifier and Type	Method	Description
void	AbstractScriptableHeapObject.setClientHandler(Handler clientHandler)	Sets the HTTP client handler which should be made available to scripts.

Uses of Handler in org.forgerock.openig.sql

Methods in org.forgerock.openig.sql with parameters of type Handler

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

Uses of Handler in org.forgerock.secrets.oauth2

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

Modifier and Type	Method	Description
AccessTokenSecretStore.Builder	AccessTokenSecretStore.Builder.withHandler(Handler handler)	Configures the Handler to use for sending requests to the token endpoint.