Package org.forgerock.openig.secrets

Class PemPropertyFormatHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.secrets.PemPropertyFormatHeaplet

All Implemented Interfaces:

Heaplet

public class PemPropertyFormatHeaplet
extends GenericHeaplet

Builds a PemPropertyFormat used to decode keys and certificates in a PEM format that can be used with SecretStore mappings configuration.

 {
       "type": "PemPropertyFormat",
       "config": {
         "decryptionSecretId":           Secret ID              [OPTIONAL - used to decrypt password-encrypted
                                                                            PEM files.
                                                                            REQUIRES a "secretsProvider".]
         "secretsProvider":              Secrets Provider       [OPTIONAL - secrets provider used to retrieve
                                                                            the decryption secret.
                                                                            REQUIRED if "decryptionSecretId" is used.]
       }
    }
 

Example:

 {
       "type": "PemPropertyFormat",
       "config": {
         "decryptionSecretId": "my.decryption.secret.id",
         "secretsProvider": "mySecretProvider"
       }
    }
 
 

See Also:

PemPropertyFormat, PropertyResolverSecretStoreHeaplet

Field Summary

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

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
PemPropertyFormatHeaplet()

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

PemPropertyFormatHeaplet

public PemPropertyFormatHeaplet()

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.