Package org.forgerock.openig.handler

Class ClientHandlerHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.handler.HttpClientHandlerHeaplet

org.forgerock.openig.handler.ClientHandlerHeaplet

All Implemented Interfaces:

Heaplet

public class ClientHandlerHeaplet
extends HttpClientHandlerHeaplet

Creates and initializes a ClientHandler in a heap environment.

A ClientHandler serves the purpose of communicating from IG to a remote server. N.B. It should not be used as a Handler to proxy requests to the protected application.

Field Summary

Fields inherited from class org.forgerock.openig.handler.HttpClientHandlerHeaplet

CONFIG_ASYNC_BEHAVIOR, CONFIG_ENABLE_CONNECTION_STATE, CONFIG_HTTP2_PRIOR_KNOWLEDGE, CONFIG_NUMBER_OF_WORKERS, CONFIG_PROTOCOL_VERSION, CONFIG_WAIT_QUEUE_SIZE

Fields inherited from class org.forgerock.openig.heap.GenericHeaplet

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
ClientHandlerHeaplet()

Method Summary

Modifier and Type	Method	Description
protected List<Filter>	filters(org.forgerock.openig.http.spi.HttpClientLoader loader, Options options)	Returns a list of Filter that will be executed on every request before the HttpClientHandler.
protected String	getType()	Returns the type of the IG object.

Methods inherited from class org.forgerock.openig.handler.HttpClientHandlerHeaplet

circuitBreakerFilter, configurationSupported, create, destroy, retryFilter

Methods inherited from class org.forgerock.openig.heap.GenericHeaplet

create, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getSecretService, getSecretsProvider, initialBindings, meterRegistryHolder, start

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientHandlerHeaplet

public ClientHandlerHeaplet()

Method Detail

filters

protected List<Filter> filters(org.forgerock.openig.http.spi.HttpClientLoader loader,
                               Options options)
                        throws HeapException

Description copied from class: HttpClientHandlerHeaplet

Returns a list of Filter that will be executed on every request before the HttpClientHandler.

Specified by:

filters in class HttpClientHandlerHeaplet

Parameters:

loader - the HttpClientLoader associated to that instance.

options - the options that will be used to create the HttpClientHandler.

Returns:

A list of Filter that will be executed on every request before the HttpClientHandler.

Throws:

HeapException - if any error occurs during the setup of the filters.

getType

protected String getType()

Description copied from class: GenericHeaplet

Returns the type of the IG object.

Overrides:

getType in class GenericHeaplet

Returns:

the type of the IG object