Package org.forgerock.openig.secrets

Class SecretKeyPropertyFormatHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.secrets.SecretKeyPropertyFormatHeaplet

All Implemented Interfaces:

Heaplet

public class SecretKeyPropertyFormatHeaplet
extends GenericHeaplet

It builds a SecretPropertyFormat that can be use with SecretStore mappings configuration.

 {
       "type": "SecretKeyPropertyFormat",
       "config": {
         "format":                 SecretPropertyFormat       [REQUIRED - The format of the secret.]
         "algorithm":              expression                 [REQUIRED - the algorithm used for the key.]
       }
    }
 

Example:

 {
       "type": "SecretKeyPropertyFormat",
       "config": {
         "format": "PLAIN",
         "algorithm": "AES"
       }
    }
 

Note: the format attribute is a SecretPropertyFormat such as: SecretPropertyFormat.PLAIN, Base64PropertyFormat. The algorithm attribute value is defined in Standard Names Algorithm Parameters.

See Also:

// @Checkstyle:off LineLength, algorithm parameters // @Checkstyle:on LineLength

Field Summary

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

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
SecretKeyPropertyFormatHeaplet()

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, 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

SecretKeyPropertyFormatHeaplet

public SecretKeyPropertyFormatHeaplet()

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.