Package org.forgerock.openig.filter

Class ChainHandlerHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.filter.ChainHandlerHeaplet

All Implemented Interfaces:

Heaplet

public class ChainHandlerHeaplet
extends GenericHeaplet

A chain of zero or more filters and one handler. The chain is responsible for dispatching the request to each filter in the chain, and finally the handler.

When a chain dispatches a request to a filter, it creates a "subchain" (a subset of this chain, which contains the remaining downstream filters and handler), and passes it as a parameter to the filter. For this reason, a filter should make no assumptions or correlations using the chain it is supplied with when invoked.

A filter may elect to terminate dispatching of the request to the rest of the chain by not calling chain.handle(Context, Request) and generate its own response or dispatch to a completely different handler.

See Also:

Filter

Field Summary

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

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
ChainHandlerHeaplet()

Method Summary

Modifier and Type	Method	Description
Object	create()	Called to request the heaplet create an object.

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

create, destroy, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getSecretService, getType, meterRegistryHolder, start

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainHandlerHeaplet

public ChainHandlerHeaplet()

Method Detail

create

public Object create()
              throws HeapException

Description copied from class: GenericHeaplet

Called to request the heaplet create an object. Called by Heaplet.create(Name, JsonValue, Heap) after initializing the protected field members. Implementations should parse configuration but not acquire resources, start threads, or log any initialization messages. These tasks should be performed by the GenericHeaplet.start() method.

Specified by:

create in class GenericHeaplet

Returns:

The created object.

Throws:

HeapException - if an exception occurred during creation of the heap object or any of its dependencies.