Package org.forgerock.openig.security

Class KeyStoreHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.security.KeyStoreHeaplet

All Implemented Interfaces:

Heaplet

public class KeyStoreHeaplet
extends GenericHeaplet

This heaplet creates and initializes instances of Java KeyStore.

 {
       "type": "KeyStore",
       "config": {
         "url":                     expression        [ REQUIRED - URL to the target key store file. ]
         "type":                    expression        [ OPTIONAL - key store type (defaults to "PKCS12"). ]
         "passwordSecretId":        secret            [ REQUIRED - a label of a {@link org.forgerock.secrets.Purpose},
                                                                   required to read private keys from the key store,
                                                                   not needed when the key store is used for
                                                                   a trust store.]
         "secretsProvider":         Secrets Provider  [ OPTIONAL - resolve keystore passwords.]
       }
    }
 

Example:

     
     {
         "name": "LocalKeyStore",
         "type": "KeyStore",
         "config": {
             "url": "file://${env['HOME']}/keystore.jceks",
             "passwordSecretId": "keystore.secret.id"
             "type": "JCEKS"
         }
     }
     
 

• password [Deprecated since 6.5 in favor of passwordSecretId]: credential required to read private keys from the key store (expression, optional), not needed when the key store is used for a trust store. NOTE: If both password and passwordSecretId are provided, the passwordSecretId has precedence.

Since:

3.1

Field Summary

Fields inherited from class org.forgerock.openig.heap.GenericHeaplet

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
KeyStoreHeaplet()

Method Summary

Modifier and Type	Method	Description
Object	create()	Called to request the heaplet create an object.

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

create, destroy, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getSecretService, getType, meterRegistryHolder, start

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyStoreHeaplet

public KeyStoreHeaplet()

Method Detail

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.