Uses of Interface
org.forgerock.http.Handler

Packages that use Handler

Package	Description
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.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.routing	Provides routing functionality for HTTP requests.
org.forgerock.oauth.clients.apple	Forgerock Apple Client implementation.
org.forgerock.oauth.clients.facebook	Forgerock Facebook Client Implementation.
org.forgerock.oauth.clients.linkedin	Forgerock LinkedIn Client Implementation.
org.forgerock.oauth.clients.linkedinv2	LinkedIn V2 ForgeRock Client Implementation.
org.forgerock.oauth.clients.oauth2	OAuth 2.0 ForgeRock Client Implementation.
org.forgerock.oauth.clients.oidc	OpenID Connect ForgeRock Client Implementation.
org.forgerock.opentelemetry.trace.chf	Integration of distributed tracing into CHF using OpenTelemetry.
org.forgerock.secrets.gcpkms	A secret store implementation that can retrieve keys from a Google Cloud Platform Key Management Service.
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.
org.forgerock.secrets.vault	Secrets backend that reads secrets from a remote Hashicorp Vault server.

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

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

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.

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

Modifier	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
CsrfFilter.Builder	CsrfFilter.Builder.failureHandler(Handler failureHandler)	Add a handler which will be responsible of creating a response in case of missing/wrong CSRF token.
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)

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

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

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

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

Modifier	Constructor	Description
	CorsFilter(CorsPolicyProvider provider, Handler failureHandler)	Constructs a new CORS filter using the given CorsPolicyProvider and failureHandler.

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
final 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.forbiddenHandler()	A common HTTP Framework Handler responding 403 Forbidden.
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.oauth2

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

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)

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

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

Modifier	Constructor	Description
	OpenAmAccessTokenResolver(Handler client, Clock clock, String tokenInfoEndpoint)	Deprecated. Creates a new OpenAmAccessTokenResolver configured to access the given /oauth2/tokeninfo OpenAm endpoint.
	TokenIntrospectionAccessTokenResolver(Handler client, URI introspectionEndpointUri)	Creates a new TokenIntrospectionAccessTokenResolver.

Uses of Handler in org.forgerock.http.routing

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

Modifier and Type	Class	Description
final 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.oauth.clients.apple

Constructors in org.forgerock.oauth.clients.apple with parameters of type Handler

Modifier	Constructor	Description
	AppleClient(Handler httpHandler, AppleClientConfiguration config, Clock clock, SecureRandom random)	Constructs a AppleClient.
	AppleClient(Handler httpHandler, AppleClientConfiguration config, Clock clock, SecureRandom random, OpenIdResolverService resolverService, OpenIdResolverServiceConfigurator serviceConfigurator)	Constructs a AppleClient.
	AppleClient(Handler httpHandler, OpenIDConnectClientConfiguration config, Clock clock, SecureRandom random, OpenIdResolverService resolverService, OpenIdResolverServiceConfigurator serviceConfigurator)	Deprecated, for removal: This API element is subject to removal in a future version. use AppleClient(Handler, AppleClientConfiguration, Clock, SecureRandom, OpenIdResolverService, OpenIdResolverServiceConfigurator) instead.

Uses of Handler in org.forgerock.oauth.clients.facebook

Constructors in org.forgerock.oauth.clients.facebook with parameters of type Handler

Modifier	Constructor	Description
	FacebookClient(Handler httpHandler, FacebookClientConfiguration config, Clock clock, SecureRandom random)	Constructs an FacebookClient using a provided Handler and FacebookClientConfiguration.

Uses of Handler in org.forgerock.oauth.clients.linkedin

Constructors in org.forgerock.oauth.clients.linkedin with parameters of type Handler

Modifier	Constructor	Description
	LinkedInClient(Handler httpHandler, LinkedInClientConfiguration config, Clock clock, SecureRandom random)	Constructs a LinkedInClient.

Uses of Handler in org.forgerock.oauth.clients.linkedinv2

Constructors in org.forgerock.oauth.clients.linkedinv2 with parameters of type Handler

Modifier	Constructor	Description
	LinkedInV2Client(Handler httpHandler, LinkedInV2ClientConfiguration config, Clock clock, SecureRandom random, OpenIdResolverService resolverService, OpenIdResolverServiceConfigurator serviceConfigurator)	Constructs a LinkedInV2Client.

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

Fields in org.forgerock.oauth.clients.oauth2 declared as Handler

Modifier and Type	Field	Description
protected final Handler	OAuth2Client.httpHandler	Handler to be used to make http requests.

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

Modifier and Type	Method	Description
protected Handler	OAuth2Client.getTokenEndpointHandler()	The token endpoint handler which wraps the client authentication filter which is capable of adding the client credentials to the request.

Constructors in org.forgerock.oauth.clients.oauth2 with parameters of type Handler

Modifier	Constructor	Description
	OAuth2Client(Handler httpHandler, T config, Clock clock, SecureRandom random)	Constructs an OAuth2Client using a provided Handler and OAuthClientConfiguration.

Uses of Handler in org.forgerock.oauth.clients.oidc

Constructors in org.forgerock.oauth.clients.oidc with parameters of type Handler

Modifier	Constructor	Description
	OpenIDConnectClient(Handler httpHandler, OpenIDConnectClientConfiguration config, Clock clock, SecureRandom random)	Constructs an OpenIDConnectClient using a provided Handler and OpenIDConnectClientConfiguration.
	OpenIDConnectClient(Handler httpHandler, OpenIDConnectClientConfiguration config, Clock clock, SecureRandom random, OpenIdResolverService resolverService, OpenIdResolverServiceConfigurator serviceConfigurator)	Constructs an OpenIDConnectClient using a provided Handler, OpenIDConnectClientConfiguration, OpenIdResolverService and OpenIdResolverServiceConfigurator.

Uses of Handler in org.forgerock.opentelemetry.trace.chf

Methods in org.forgerock.opentelemetry.trace.chf with parameters of type Handler

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

Uses of Handler in org.forgerock.secrets.gcpkms

Constructors in org.forgerock.secrets.gcpkms with parameters of type Handler

Modifier	Constructor	Description
	ChfHttpTransport(Handler httpHandler, Supplier<Context> context)	Initialises the transport with the given CHF client handler and context supplier.

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.

Uses of Handler in org.forgerock.secrets.vault

Methods in org.forgerock.secrets.vault that return Handler

Modifier and Type	Method	Description
Handler	VaultConfig.getHttpClient()	Returns the CHF HTTP client handler to use for connections to Vault.

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

Modifier and Type	Method	Description
static VaultConfig.Builder	VaultConfig.builder(Handler httpClient, URI baseUri)	Returns a new VaultConfig.Builder to construct the configuration.