Package org.forgerock.secrets.vault

Enum VaultKeyValueSecretStore.SecretField

java.lang.Object

java.lang.Enum<VaultKeyValueSecretStore.SecretField>

org.forgerock.secrets.vault.VaultKeyValueSecretStore.SecretField

All Implemented Interfaces:

Serializable, Comparable<VaultKeyValueSecretStore.SecretField>, BiFunction<SecretBuilder,JsonValue,Promise<SecretBuilder,NoSuchSecretException>>, VaultKeyValueSecretStore.SecretFieldDecoder

Enclosing class:

VaultKeyValueSecretStore

public static enum VaultKeyValueSecretStore.SecretField
extends Enum<VaultKeyValueSecretStore.SecretField>
implements VaultKeyValueSecretStore.SecretFieldDecoder

Standard implementations of VaultKeyValueSecretStore.SecretFieldDecoder for common fields.

Enum Constant Summary

Enum Constants

Enum Constant	Description
KEY_USAGE	Populates key usage constraints from a JSON array of WebCrypto key usage names.
PASSWORD	Populates the raw data of a secret as a UTF-8 password using the string value of the JSON.
PEM	The PEM property format can populate multiple fields of a SecretBuilder using the Privacy Enhanced Mail (PEM) format for keys and certificates.
RAW_DATA_BASE64	Populates the raw data of a secret as the binary data resulting from Base64-decoding the string JSON value.
STABLE_ID	Populates the SecretBuilder.stableId(String) of the secret based on the JSON string value.

Method Summary

Modifier and Type	Method	Description
static VaultKeyValueSecretStore.SecretField	valueOf(String name)	Returns the enum constant of this type with the specified name.
static VaultKeyValueSecretStore.SecretField[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface org.forgerock.secrets.vault.VaultKeyValueSecretStore.SecretFieldDecoder

apply

Enum Constant Detail

PEM

public static final VaultKeyValueSecretStore.SecretField PEM

The PEM property format can populate multiple fields of a SecretBuilder using the Privacy Enhanced Mail (PEM) format for keys and certificates. If multiple PEM objects are present in the data then then will all be decoded.

STABLE_ID

public static final VaultKeyValueSecretStore.SecretField STABLE_ID

Populates the SecretBuilder.stableId(String) of the secret based on the JSON string value.

PASSWORD

public static final VaultKeyValueSecretStore.SecretField PASSWORD

Populates the raw data of a secret as a UTF-8 password using the string value of the JSON.

RAW_DATA_BASE64

public static final VaultKeyValueSecretStore.SecretField RAW_DATA_BASE64

Populates the raw data of a secret as the binary data resulting from Base64-decoding the string JSON value.

KEY_USAGE

public static final VaultKeyValueSecretStore.SecretField KEY_USAGE

Populates key usage constraints from a JSON array of WebCrypto key usage names.

Method Detail

values

public static VaultKeyValueSecretStore.SecretField[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VaultKeyValueSecretStore.SecretField c : VaultKeyValueSecretStore.SecretField.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VaultKeyValueSecretStore.SecretField valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null