Class SecretsProviderHeaplet

java.lang.Object
org.forgerock.openig.heap.GenericHeaplet
org.forgerock.openig.secrets.SecretsProviderHeaplet
All Implemented Interfaces:
Heaplet

public class SecretsProviderHeaplet extends GenericHeaplet
Creates and initializes a SecretsProvider in a heap environment.
  • Constructor Details

    • SecretsProviderHeaplet

      public SecretsProviderHeaplet()
  • Method Details

    • 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.
    • secretsProvider

      public static Function<JsonValue,SecretsProvider,HeapException> secretsProvider(Heap heap) throws HeapException
      Method supporting other client heaplets that wish to create a SecretsProvider using alternative compact configuration formats.

      Example compact configurations include:

      1. a single inlined SecretStore:
                     "secretsProvider": {
                       "type": "KeyStoreSecretStore",
                       "config": {...}
                     }
                 
      2. a single SecretStore reference:
                     "secretsProvider": "mySecretStore1"
                 
      3. an array containing one or more inlined SecretStores:
                     "secretsProvider": [
                       {
                         "type": "KeyStoreSecretStore",
                         "config": {...}
                       }
                     ]
                 
      4. an array containing one or more SecretStore references:
                     "secretsProvider": [
                       "mySecretStore1", "mySecretStore2"
                     ]
                 
      Parameters:
      heap - The Heap that this SecretsProvider will be created in.
      Returns:
      Transformer function able to create a SecretsProvider.
      Throws:
      HeapException - if an exception occurred during creation of the heap object or any of its dependencies.