Package org.forgerock.openig.heap

Class GenericHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

All Implemented Interfaces:

Heaplet

Direct Known Subclasses:

AbstractScriptableHeapObject.AbstractScriptableHeaplet, AssignmentFilter.Heaplet, AuditServiceObjectHeaplet, ChainFilterHeaplet, ChainHandlerHeaplet, ClientHandler.Heaplet, ClientRegistration.Heaplet, ConditionalFilterHeaplet, ConditionEnforcementFilter.Heaplet, CookieFilter.Heaplet, CryptoHeaderFilter.Heaplet, DefaultRateThrottlingPolicyHeaplet, DelegateHeaplet, DesKeyGenHandler.Heaplet, DispatchHandler.Heaplet, EmbeddedKafka, EntityExtractFilter.Heaplet, FileAttributesFilter.Heaplet, HeaderFilter.Heaplet, HttpBasicAuthFilter.Heaplet, ICAPFilter.Heaplet, Issuer.Heaplet, JwtBuilderFilter.Heaplet, JwtSessionManager.Heaplet, KeyManagerHeaplet, KeyStoreHeaplet, LLMProxyFilter.Heaplet, LocationHeaderFilter.Heaplet, MappedThrottlingPolicyHeaplet, MCPServerFeaturesFilter.Heaplet, MQ_IBM.Heaplet, MQ_Kafka.Heaplet, OAuth2ClientFilter.Heaplet, OAuth2ResourceServerFilterHeaplet, PasswordReplayFilterHeaplet, PolicyEnforcementFilter.Heaplet, RouterHandler.Heaplet, SamlFederationHandler.Heaplet, SampleFilter.Heaplet, ScheduledExecutorServiceHeaplet, SequenceHandler.Heaplet, SingleSignOnFilter.Heaplet, SqlAttributesFilter.Heaplet, StaticRequestFilter.Heaplet, StaticResponseHandler.Heaplet, SwitchFilter.Heaplet, SystemAndEnvSecretStore.Heaplet, TemporaryStorageHeaplet, ThrottlingFilterHeaplet, TokenTransformationFilter.Heaplet, TrustAllManager.Heaplet, TrustManagerHeaplet, UmaResourceServerFilter.Heaplet, UmaSharingService.Heaplet, WelcomeHandler.Heaplet

public abstract class GenericHeaplet
extends Object
implements Heaplet

A generic base class for heaplets with automatically injected fields.

If the object created is an instance of GenericHeapObject, it is then automatically injected with logger and storage objects.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.forgerock.json.JsonValue	config	The heaplet's object configuration object.
protected Heap	heap	Where objects should be put and where object dependencies should be retrieved.
protected String	name	The name of the object to be created and stored in the heap by this heaplet.
protected Object	object	The object created by the heaplet's create() method.
protected Name	qualified	The fully qualified name of the object to be created.

Constructor Summary

Constructors

Constructor	Description
GenericHeaplet()

Method Summary

Modifier and Type	Method	Description
abstract Object	create()	Called to request the heaplet create an object.
Object	create(Name name, org.forgerock.json.JsonValue config, Heap heap)	Called to request the heaplet to create an object.
void	destroy()	Called to indicate that the object created by the heaplet is going to be dereferenced.
protected EndpointRegistry	endpointRegistry()	Returns this object's EndpointRegistry, creating it lazily when requested for the first time.
protected org.forgerock.util.Function<org.forgerock.json.JsonValue,org.forgerock.json.JsonValue,org.forgerock.json.JsonValueException>	evaluatedWithHeapProperties()	Returns a function that will evaluate the expression hold by a JsonValue using the properties defined in the heap of this Heaplet.
protected <T> org.forgerock.util.Function<org.forgerock.json.JsonValue,Expression<T>,org.forgerock.json.JsonValueException>	expression(Class<T> type)	Returns a function that will create an Expression from the string by the JsonValue using the bindings defined in the heap of this Heaplet as initial bindings.
void	start()	Called to request the heaplet start an object.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

The name of the object to be created and stored in the heap by this heaplet.

qualified

protected Name qualified

The fully qualified name of the object to be created.

config

protected org.forgerock.json.JsonValue config

The heaplet's object configuration object.

heap

protected Heap heap

Where objects should be put and where object dependencies should be retrieved.

object

protected Object object

The object created by the heaplet's create() method.

Constructor Detail

GenericHeaplet

public GenericHeaplet()

Method Detail

create

public Object create(Name name,
                     org.forgerock.json.JsonValue config,
                     Heap heap)
              throws HeapException

Description copied from interface: Heaplet

Called to request the heaplet to create an object.

Specified by:

create in interface Heaplet

Parameters:

name - the name of the object to be created.

config - the heaplet's configuration object.

heap - the heap where object dependencies can be retrieved.

Returns:

the object created by the heaplet.

Throws:

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

endpointRegistry

protected EndpointRegistry endpointRegistry()
                                     throws HeapException

Returns this object's EndpointRegistry, creating it lazily when requested for the first time.

Returns:

this object's EndpointRegistry (/objects/[name])

Throws:

HeapException - should never be thrown

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

create

public abstract Object create()
                       throws HeapException

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 start() method.

Returns:

The created object.

Throws:

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

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

start

public void start()
           throws HeapException

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.

Throws:

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

evaluatedWithHeapProperties

protected org.forgerock.util.Function<org.forgerock.json.JsonValue,org.forgerock.json.JsonValue,org.forgerock.json.JsonValueException> evaluatedWithHeapProperties()

Returns a function that will evaluate the expression hold by a JsonValue using the properties defined in the heap of this Heaplet.

Returns:

a function that will evaluate the expression hold by a JsonValue using the properties defined in the heap of this Heaplet.

expression

protected <T> org.forgerock.util.Function<org.forgerock.json.JsonValue,Expression<T>,org.forgerock.json.JsonValueException> expression(Class<T> type)

Returns a function that will create an Expression from the string by the JsonValue using the bindings defined in the heap of this Heaplet as initial bindings.

Type Parameters:

T - The type of the expression's result.

Parameters:

type - The expected result type of the Expression

Returns:

a function that will create an Expression from the string by the JsonValue using the bindings defined in the heap of this Heaplet as initial bindings.