Package org.forgerock.openig.heap

Class EnvironmentHeap

java.lang.Object

org.forgerock.openig.heap.HeapImpl

org.forgerock.openig.heap.EnvironmentHeap

All Implemented Interfaces:

Heap

public class EnvironmentHeap
extends HeapImpl

The root Heap that includes access to the environment additional information. The default name to access the environment is environment. It is possible to provide an alias.

Constructor Summary

Constructors

Constructor	Description
EnvironmentHeap(Name name, String bindingName, Environment environment, org.forgerock.config.resolvers.PropertyResolver propertyResolver, StartupMetrics parentStartupMetrics)	Builds a new EnvironmentHeap with the given name and environment.
EnvironmentHeap(Name name, Environment environment, org.forgerock.config.resolvers.PropertyResolver propertyResolver)	Builds a new EnvironmentHeap with the given name and environment.

Method Summary

Modifier and Type	Method	Description
Bindings	getProperties()	Returns the properties from this heap and its parents if any.

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

addDefaultDeclaration, destroy, get, getName, init, put, resolve, resolve, resolve, startupMetrics

Methods inherited from class java.lang.Object

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

Constructor Details

EnvironmentHeap

public EnvironmentHeap(Name name,
 Environment environment,
 org.forgerock.config.resolvers.PropertyResolver propertyResolver)

Builds a new EnvironmentHeap with the given name and environment.

Parameters:

name - name of this heap

environment - environment to expose in properties

propertyResolver - Root property resolver (not null)

EnvironmentHeap

public EnvironmentHeap(Name name,
 String bindingName,
 Environment environment,
 org.forgerock.config.resolvers.PropertyResolver propertyResolver,
 StartupMetrics parentStartupMetrics)

Builds a new EnvironmentHeap with the given name and environment.

Parameters:

name - name of this heap

bindingName - The name of the environment in the bindings

environment - environment to expose in properties (not null)

propertyResolver - Root property resolver (not null)

parentStartupMetrics - The parent StartupMetrics

Method Details

getProperties

public Bindings getProperties()

Description copied from interface: Heap

Returns the properties from this heap and its parents if any.

Specified by:

getProperties in interface Heap

Overrides:

getProperties in class HeapImpl

Returns:

the properties from this heap and its parents if any.