Package org.forgerock.openig.heap

Class HeapImpl

java.lang.Object
org.forgerock.openig.heap.HeapImpl
All Implemented Interfaces:
Heap
Direct Known Subclasses:
EnvironmentHeap
public class HeapImpl extends Object implements Heap
The concrete implementation of a heap. Provides methods to initialize and destroy a heap. A Heap can be part of a heap hierarchy: if the queried object is not found locally, and if it has a parent, the parent will be queried (and this, recursively until there is no parent anymore).

  • Constructor Details

    • HeapImpl

      public HeapImpl(Name name)
      Builds a root heap (will be referenced by children but has no parent itself). Provides a no-op PropertyResolver.
      Parameters:
      name - local name of this heap

    • HeapImpl

      public HeapImpl(HeapImpl parent, Name name)
      Builds a new heap that is a child of the given heap.
      Parameters:
      parent - parent heap (never null).
      name - local name of this heap

    • HeapImpl

      public HeapImpl(Name name, org.forgerock.config.resolvers.PropertyResolver propertyResolver, StartupMetrics parentStartupMetrics)
      Builds a new heap.
      Parameters:
      name - local name of this heap
      propertyResolver - initial property resolver to use
      parentStartupMetrics - the StartupMetrics to use

  • Method Details

    • getName

      public Name getName()
      Description copied from interface: Heap
      Returns the name of this heap.
      Specified by:
      getName in interface Heap
      Returns:
      the name of this heap.

    • init

      public JsonValue init(JsonValue originalConfig) throws HeapException
      Initializes the heap using the given configuration. Once complete, all heaplets will be loaded.
      Parameters:
      originalConfig - the configuration root.
      Returns:
      the configuration updated to include any token substitutions found in the original configuration.
      Throws:
      HeapException - if an exception occurs initializing the heap.
      JsonValueException - if the configuration object is malformed.

    • addDefaultDeclaration

      public void addDefaultDeclaration(DefaultDeclarationProvider.Declaration declaration)
      Add a default object declaration in this heap. This method should only be called prior to init(JsonValue): values provided after init() has been called will be ignored. Notice that if the caller add 2 declarations with the same name, that will end up with an exception thrown when the heap will be initialized.
      Parameters:
      declaration - Object declaration

    • get

      public <T> T get(String name, Class<T> type) throws HeapException
      Description copied from interface: Heap
      Returns an object from the heap with a specified name, or null if no such object exists.
      Specified by:
      get in interface Heap
      Type Parameters:
      T - expected type of the heap object
      Parameters:
      name - the name of the object in the heap to be retrieved.
      type - expected type of the heap object
      Returns:
      the requested object from the heap, or null if no such object exists.
      Throws:
      HeapException - if an exception occurred during creation of the heap object or any of its dependencies.

    • resolve

      public <T> T resolve(JsonValue reference, Class<T> type) throws HeapException
      Description copied from interface: Heap
      Resolves a mandatory object with the specified reference. If the object does not exist or the inline declaration cannot be build, a JsonValueException is thrown. If the reference is an inline object declaration, an anonymous object is added to the heap and returned.

      Equivalent to: 

           
     heap.resolve(reference, type, false);
      Specified by:
      resolve in interface Heap
      Type Parameters:
      T - expected instance type
      Parameters:
      reference - a JSON value containing the name of the heap object to retrieve.
      type - the expected type of the heap object.
      Returns:
      the specified heap object.
      Throws:
      HeapException - if there was an exception creating the heap object or any of its dependencies.

    • resolve

      public <T> T resolve(JsonValue reference, Class<T> type, boolean optional) throws HeapException
      Description copied from interface: Heap
      Resolves an object with the specified reference, optionally or not. If the reference is an inline object declaration, an anonymous object is added to the heap and returned. If the inline declaration cannot be build, a JsonValueException is thrown.
      Specified by:
      resolve in interface Heap
      Type Parameters:
      T - expected instance type
      Parameters:
      reference - a JSON value containing either the name of the heap object to retrieve or an inline declaration.
      type - the expected type of the heap object.
      optional - Accept or not a JsonValue that contains null.
      Returns:
      the referenced heap object or null if name contains null.
      Throws:
      HeapException - if there was an exception creating the heap object or any of its dependencies.

    • resolve

      public <T> T resolve(JsonValue config, Class<T> type, JsonValue decorations) throws HeapException
      Same as resolve(JsonValue, Class) but with decorations to add.
      Type Parameters:
      T - the instance of the object to return
      Parameters:
      config - the configuration of the composant to create, can be a reference to an existing heap object.
      type - the type of the object
      decorations - the decorations to add to the object
      Returns:
      an instance of T.
      Throws:
      HeapException - in case of errors.

    • put

      public void put(String name, Object object)
      Puts an object into the heap. If an object already exists in the heap with the specified name, it is overwritten.
      Parameters:
      name - name of the object to be put into the heap.
      object - the object to be put into the heap.

    • destroy

      public void destroy()
      Destroys the objects on the heap and dereferences all associated objects. This method calls the heaplet destroy method for each object in the heap to provide a chance for system resources to be freed.

    • 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
      Returns:
      the properties from this heap and its parents if any.

    • startupMetrics

      public StartupMetrics startupMetrics()
      Description copied from interface: Heap
      The StartupMetrics associated with this heap.
      Specified by:
      startupMetrics in interface Heap
      Returns:
      the StartupMetrics associated with this heap.