Package org.forgerock.openig.security

Class KeyManagerHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.security.KeyManagerHeaplet

All Implemented Interfaces:

Heaplet

@Deprecated(since="2023.2")
public class KeyManagerHeaplet
extends GenericHeaplet

Deprecated.

Use SecretsKeyManagerHeaplet instead.

This heaplet creates and initializes instances of an SSL Java KeyManager.

 {
         "type": "KeyManager",
         "config": {
             "keystore":                reference         [ REQUIRED - Reference a KeyStore heap object. ]
             "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.]
             "alg"                      expression        [ OPTIONAL - key manager algorithm (defaults to platform's
                                                                       default type).]
             "secretsProvider":         Secrets Provider  [ OPTIONAL - resolve keystore passwords.]
          }
    }
 

Example:

 {
         "name": "MyKeyManager",
         "type": "KeyManager",
         "config": {
             "keystore": "MyKeyStore",
             "passwordSecretId": "password.secret.id",
             "alg": "SunX509"
         }
 }
 

• password: [Deprecated since 6.5 in favor of passwordSecretId] credential required to read private keys from the key store (expression, required). 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
KeyManagerHeaplet()	Deprecated.

Method Summary

Modifier and Type	Method	Description
Object	create()	Deprecated. 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, getSecretsProvider, getType, initialBindings, meterRegistryHolder, start

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyManagerHeaplet

public KeyManagerHeaplet()

Deprecated.

Method Detail

create

public Object create()
              throws HeapException

Deprecated.

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.