org.forgerock.openig.script

Class AbstractScriptableHeapObject.AbstractScriptableHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.script.AbstractScriptableHeapObject.AbstractScriptableHeaplet

All Implemented Interfaces:

Heaplet

Direct Known Subclasses:

ScriptableAccessTokenResolver.Heaplet, ScriptableFilter.Heaplet, ScriptableHandler.Heaplet, ScriptableResourceAccess.Heaplet, ScriptableResourceUriProvider.Heaplet, ScriptableThrottlingPolicy.Heaplet

Enclosing class:

AbstractScriptableHeapObject<V>

protected abstract static class AbstractScriptableHeapObject.AbstractScriptableHeaplet
extends GenericHeaplet

Creates and initializes a capture filter in a heap environment.

Field Summary

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

config, heap, name, object, qualified

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScriptableHeaplet()

Method Summary

Modifier and Type	Method and Description
Object	create() Called to request the heaplet create an object.
void	destroy() Called to indicate that the object created by the heaplet is going to be dereferenced.
protected abstract AbstractScriptableHeapObject<?>	newInstance(Script script, Heap heap) Creates the new heap object instance using the provided script.

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

create, 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

AbstractScriptableHeaplet

protected AbstractScriptableHeaplet()

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.

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

newInstance

protected abstract AbstractScriptableHeapObject<?> newInstance(Script script,
                                                               Heap heap)
                                                        throws HeapException

Creates the new heap object instance using the provided script.

Parameters:

script - The compiled script.

heap - The heap to look for bindings

Returns:

The new heap object instance using the provided script.

Throws:

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

JsonValueException - if the heaplet (or one of its dependencies) has a malformed configuration.