org.forgerock.secrets.keys

Enum KeyFormatRaw

java.lang.Object

java.lang.Enum<KeyFormatRaw>

org.forgerock.secrets.keys.KeyFormatRaw

All Implemented Interfaces:

Serializable, Comparable<KeyFormatRaw>, KeyFormat<Key>

public enum KeyFormatRaw
extends Enum<KeyFormatRaw>
implements KeyFormat<Key>

Exports the raw key.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The singleton instance of this formatter.

Method Summary

Modifier and Type	Method and Description
Key	export(CryptoKey key, Key rawKey) Exports the given crypto key and raw key material.
static KeyFormatRaw	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyFormatRaw[]	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

Enum Constant Detail

INSTANCE

public static final KeyFormatRaw INSTANCE

The singleton instance of this formatter.

Method Detail

values

public static KeyFormatRaw[] 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 (KeyFormatRaw c : KeyFormatRaw.values())
    System.out.println(c);

Returns:

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

valueOf

public static KeyFormatRaw 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

export

public Key export(CryptoKey key,
                  Key rawKey)

Description copied from interface: KeyFormat

Exports the given crypto key and raw key material.

Specified by:

export in interface KeyFormat<Key>

Parameters:

key - the crypto key.

rawKey - the raw key material.

Returns:

the exported key material in the given format.