Package org.forgerock.openig.handler.router

Class RouterHandler.Heaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.handler.router.RouterHandler.Heaplet

All Implemented Interfaces:

Heaplet

Enclosing class:

RouterHandler

public static class RouterHandler.Heaplet
extends GenericHeaplet

Creates and initializes a routing handler in a heap environment.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	Public name used by resolver.
static final String	NAME_DEPRECATED	Deprecated Public name used by resolver.

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
RouterHandler	create()	Called to request the heaplet create an object.
void	destroy()	Releases observability resources: deregisters the HTTP endpoint, all meters, and startup metrics.
protected String	getType()	Returns the type of the IG object.
void	start()	Called to request the heaplet start an object.

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

create, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, initialBindings, meterRegistryHolder

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

Public name used by resolver.

See Also:

• Constant Field Values

NAME_DEPRECATED

public static final String NAME_DEPRECATED

Deprecated Public name used by resolver.

See Also:

• Constant Field Values

Constructor Details

Heaplet

public Heaplet()

Method Details

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

create

public RouterHandler 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.

start

public void start()
           throws HeapException

Description copied from class: GenericHeaplet

Called to request the heaplet start an object. Called by Heaplet.create(Name, JsonValue, Heap) after creating and configuring the object and once the object's logger and storage have been configured. Implementations should override this method if they need to acquire resources, start threads, or log any initialization messages.

Overrides:

start in class GenericHeaplet

Throws:

HeapException - if an exception occurred while starting the heap object or any of its dependencies.

destroy

public void destroy()

Description copied from class: GenericHeaplet

Releases observability resources: deregisters the HTTP endpoint, all meters, and startup metrics.

Subclasses that override this method must call super.destroy() last, after releasing their own domain resources. This ensures that monitoring remains active for the full lifetime of those resources and that any metrics emitted during shutdown are not lost.

Specified by:

destroy in interface Heaplet

Overrides:

destroy in class GenericHeaplet