Package org.forgerock.openig.handler

Class ClientHandler.Heaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.handler.ClientHandler.Heaplet

All Implemented Interfaces:

Heaplet

Direct Known Subclasses:

ReverseProxyHandler.Heaplet

Enclosing class:

ClientHandler

public static class ClientHandler.Heaplet
extends GenericHeaplet

Creates and initializes a client handler in a heap environment.

Field Summary

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

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
Heaplet()

Method Summary

Modifier and Type	Method	Description
Object	create()	Called to request the heaplet create an object.
protected String	defaultAsyncBehavior()	Returns default asyncBehavior value if undefined in configuration.
protected String	defaultSoTimeout()	Returns default soTimeout value if undefined in configuration.
void	destroy()	Called to indicate that the object created by the heaplet is going to be dereferenced.
protected String	getType()	Returns the type of the IG object.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Heaplet

public Heaplet()

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.

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

defaultSoTimeout

protected String defaultSoTimeout()

Returns default soTimeout value if undefined in configuration.

Returns:

default soTimeout value if undefined in configuration.

defaultAsyncBehavior

protected String defaultAsyncBehavior()

Returns default asyncBehavior value if undefined in configuration.

Returns:

default asyncBehavior value if undefined in configuration.

destroy

public void destroy()

Description copied from interface: Heaplet

Called to indicate that the object created by the heaplet is going to be dereferenced. This gives the heaplet an opportunity to free any resources that are being held prior to its dereference.

Specified by:

destroy in interface Heaplet

Overrides:

destroy in class GenericHeaplet