Uses of Interface
org.forgerock.openig.heap.Heap

Packages that use Heap

Package	Description
org.forgerock.openig.decoration	Decorator API to ease heap object customization and transformation.
org.forgerock.openig.decoration.global	This package contains a special decorator that is responsible to invoke other decorators.
org.forgerock.openig.decoration.helper	Contains an abstract decorator dedicated to Filter and Handler.
org.forgerock.openig.filter	Filters the requests and/or responses of HTTP.
org.forgerock.openig.filter.circuitbreaker	This package contains the components used to implement circuit breaking.
org.forgerock.openig.filter.jwt	This package contains the components used to implement some JWT related filter.
org.forgerock.openig.filter.oauth2	This package contains the OAuth2 Token validation filter that acts as an OAuth 2 Resource Server.
org.forgerock.openig.filter.throttling	This package contains the components used to implement a throttling rate support.
org.forgerock.openig.handler	Handles HTTP requests by generating responses.
org.forgerock.openig.heap	Manages collections or "heaps" of associated objects, initialized from declarative configuration artifacts.
org.forgerock.openig.http	Integrates with the ForgeRock HTTP Framework.
org.forgerock.openig.openam	Integration classes specifically for ForgeRock Access Management.
org.forgerock.openig.script	Scripting support.
org.forgerock.openig.secrets	Provides the Common Secrets API for accessing secrets of various kinds.
org.forgerock.openig.util	Miscellaneous utility classes.

Uses of Heap in org.forgerock.openig.decoration

Methods in org.forgerock.openig.decoration that return Heap

Modifier and Type	Method	Description
Heap	Context.getHeap()	Returns the heap that spawned the decorated heap object.

Uses of Heap in org.forgerock.openig.decoration.global

Constructors in org.forgerock.openig.decoration.global with parameters of type Heap

Constructor	Description
GlobalDecorator(Decorator parent, JsonValue config, Heap heap, String... reservedFieldNames)	Builds a new GlobalDecorator using given decorators JSON object element.

Uses of Heap in org.forgerock.openig.decoration.helper

Fields in org.forgerock.openig.decoration.helper declared as Heap

Modifier and Type	Field	Description
protected Heap	DecoratorHeaplet.heap	Where objects should be put and where object dependencies should be retrieved.

Methods in org.forgerock.openig.decoration.helper with parameters of type Heap

Modifier and Type	Method	Description
Object	DecoratorHeaplet.create(Name name, JsonValue config, Heap heap)
static <R> LazyReference<R>	LazyReference.newReference(Heap heap, JsonValue reference, Class<R> type, boolean optional)	Builds a LazyReference dedicated to resolve the given (optional or not) reference of type type from the given heap.

Uses of Heap in org.forgerock.openig.filter

Methods in org.forgerock.openig.filter with parameters of type Heap

Modifier and Type	Method	Description
ScriptableFilter	ScriptableFilter.Heaplet.newInstance(Script script, Heap heap)

Uses of Heap in org.forgerock.openig.filter.circuitbreaker

Methods in org.forgerock.openig.filter.circuitbreaker with parameters of type Heap

Modifier and Type	Method	Description
static CircuitBreakerFilter	CircuitBreakerFilter.Heaplet.newInstance(JsonValue config, Heap heap)	Create a new instance of a CircuitBreakerFilter.

Uses of Heap in org.forgerock.openig.filter.jwt

Methods in org.forgerock.openig.filter.jwt with parameters of type Heap

Modifier and Type	Method	Description
ScriptableJwtValidatorCustomizer	ScriptableJwtValidatorCustomizer.Heaplet.newInstance(Script script, Heap heap)

Uses of Heap in org.forgerock.openig.filter.oauth2

Methods in org.forgerock.openig.filter.oauth2 with parameters of type Heap

Modifier and Type	Method	Description
ScriptableAccessTokenResolver	ScriptableAccessTokenResolver.Heaplet.newInstance(Script script, Heap heap)
ScriptableResourceAccess	ScriptableResourceAccess.Heaplet.newInstance(Script script, Heap heap)

Uses of Heap in org.forgerock.openig.filter.throttling

Methods in org.forgerock.openig.filter.throttling with parameters of type Heap

Modifier and Type	Method	Description
ScriptableThrottlingPolicy	ScriptableThrottlingPolicy.Heaplet.newInstance(Script script, Heap heap)

Uses of Heap in org.forgerock.openig.handler

Methods in org.forgerock.openig.handler with parameters of type Heap

Modifier and Type	Method	Description
ScriptableHandler	ScriptableHandler.Heaplet.newInstance(Script script, Heap heap)

Uses of Heap in org.forgerock.openig.heap

Classes in org.forgerock.openig.heap that implement Heap

Modifier and Type	Class	Description
class	EnvironmentHeap	The root Heap that includes access to the environment additional information.
class	HeapImpl	The concrete implementation of a heap.

Fields in org.forgerock.openig.heap declared as Heap

Modifier and Type	Field	Description
protected Heap	GenericHeaplet.heap	Where objects should be put and where object dependencies should be retrieved.

Methods in org.forgerock.openig.heap that return Heap

Modifier and Type	Method	Description
Heap	GenericHeaplet.getHeap()	Returns the heap associated to that Heaplet.

Methods in org.forgerock.openig.heap with parameters of type Heap

Modifier and Type	Method	Description
Object	GenericHeaplet.create(Name name, JsonValue config, Heap heap)
Object	Heaplet.create(Name name, JsonValue config, Heap heap)	Called to request the heaplet to create an object.

Uses of Heap in org.forgerock.openig.http

Methods in org.forgerock.openig.http that return Heap

Modifier and Type	Method	Description
Heap	AdminHttpApplication.getHeap()	Returns the heap based on the contents of the admin configuration.

Uses of Heap in org.forgerock.openig.openam

Methods in org.forgerock.openig.openam with parameters of type Heap

Modifier and Type	Method	Description
ScriptableResourceUriProvider	ScriptableResourceUriProvider.Heaplet.newInstance(Script script, Heap heap)

Uses of Heap in org.forgerock.openig.script

Methods in org.forgerock.openig.script with parameters of type Heap

Modifier and Type	Method	Description
protected abstract AbstractScriptableHeapObject<V>	AbstractScriptableHeapObject.AbstractScriptableHeaplet.newInstance(Script script, Heap heap)	Creates the new heap object instance using the provided script.

Constructors in org.forgerock.openig.script with parameters of type Heap

Constructor	Description
AbstractScriptableHeapObject(Script compiledScript, Heap heap, String name)	Creates a new scriptable heap object using the provided compiled script.

Uses of Heap in org.forgerock.openig.secrets

Methods in org.forgerock.openig.secrets with parameters of type Heap

Modifier and Type	Method	Description
static SecretsProvider	SecretsUtils.getSecretsProviderOrSecretsService(org.slf4j.Logger logger, JsonValue node, Heap heap)	Returns a SecretsProvider as specified with the SecretsUtils.CONFIG_SECRETS_PROVIDER attribute or falling back to a new SecretsProvider wrapping the SecretsService found in the heap.
static Function<JsonValue,SecretsProvider,HeapException>	SecretsProviderHeaplet.secretsProvider(Heap heap)	Method supporting other client heaplets that wish to create a SecretsProvider using alternative compact configuration formats.

Uses of Heap in org.forgerock.openig.util

Methods in org.forgerock.openig.util with parameters of type Heap

Modifier and Type	Method	Description
static <T> Function<JsonValue,T,HeapException>	JsonValues.lookupOrCreateHeapObject(Heap heap, Class<T> type)	Returns a Function that will lookup into the provided heap and its parents for an object named by the provided JsonValue declaration.
static <T> Function<JsonValue,T,HeapException>	JsonValues.optionalHeapObject(Heap heap, Class<T> type)	Returns a Function to transform a list of String-based JsonValues into a list of optional heap objects.
static <T> Function<JsonValue,T,HeapException>	JsonValues.requiredHeapObject(Heap heap, Class<T> type)	Returns a Function to transform a list of String-based JsonValues into a list of required heap objects.
static Function<JsonValue,SecretPropertyFormat,JsonValueException>	JsonValues.secretPropertyFormat(Heap heap)	Returns a SecretPropertyFormat object from a JsonValue.