Package org.forgerock.openig.http

Class GatewayHttpApplication

java.lang.Object

org.forgerock.openig.http.GatewayHttpApplication

All Implemented Interfaces:

HttpApplication

public final class GatewayHttpApplication
extends Object
implements HttpApplication

Configuration class for configuring the Identity Gateway.

Since:

3.1.0

Constructor Summary

Constructors

Constructor

Description

GatewayHttpApplication(Environment environment, JsonValue config, EndpointRegistry registry, RunMode mode, org.forgerock.monitoring.api.instrument.MeterRegistry meterRegistry, StartupMetrics parentStartupMetrics, org.forgerock.config.resolvers.PropertyResolver propertyResolver, HttpClientProvider httpClientProvider, WebSocketClientProvider webSocketClientProvider, WebSocketProxyFilterProvider webSocketProxyFilterProvider, Clock clock, IgTicker ticker, AsyncSessionManager sessionManager, ProductInfo productInfo)

Construct a GatewayHttpApplication.

Method Summary

Modifier and Type	Method	Description
Factory<Buffer>	getBufferFactory()	Gets the Factory that will create temporary storage Buffers to handle the processing of requests.
Handler	start()	Gets the root Handler that will handle all HTTP requests.
void	stop()	Called when HTTP application is shutdown.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GatewayHttpApplication

public GatewayHttpApplication(Environment environment,
 JsonValue config,
 EndpointRegistry registry,
 RunMode mode,
 org.forgerock.monitoring.api.instrument.MeterRegistry meterRegistry,
 StartupMetrics parentStartupMetrics,
 org.forgerock.config.resolvers.PropertyResolver propertyResolver,
 HttpClientProvider httpClientProvider,
 WebSocketClientProvider webSocketClientProvider,
 WebSocketProxyFilterProvider webSocketProxyFilterProvider,
 Clock clock,
 IgTicker ticker,
 AsyncSessionManager sessionManager,
 ProductInfo productInfo)

Construct a GatewayHttpApplication.

Parameters:

environment - the environment to lookup for configuration

config - the gateway configuration

registry - the endpoint registry to bind the API endpoints

mode - IG run mode

meterRegistry - The meter registry

parentStartupMetrics - the parent StartupMetrics

propertyResolver - Root property resolver (not null)

httpClientProvider - The provider of HttpClient

webSocketClientProvider - The notification service provider

webSocketProxyFilterProvider - The WebSocket proxy filter provider

clock - The clock to use

ticker - The ticker to use

sessionManager - The sessionManager to use

productInfo - The product information

Method Details

start

public Handler start()
              throws HttpApplicationException

Description copied from interface: HttpApplication

Gets the root Handler that will handle all HTTP requests.

The Handler returned from this method MUST be a singleton.

Specified by:

start in interface HttpApplication

Returns:

The Handler to handle HTTP requests.

Throws:

HttpApplicationException - If there is a problem constructing the root application Handler.

getBufferFactory

public Factory<Buffer> getBufferFactory()

Description copied from interface: HttpApplication

Gets the Factory that will create temporary storage Buffers to handle the processing of requests.

May return null indicating that the container should provide a default buffer factory.

Specified by:

getBufferFactory in interface HttpApplication

Returns:

A Buffer Factory or null.

stop

public void stop()

Description copied from interface: HttpApplication

Called when HTTP application is shutdown.

Implementation should use this method to clear up all remaining resources.

Specified by:

stop in interface HttpApplication