org.apache.nifi.security.util

Enum KeyDerivationFunction

java.lang.Object

java.lang.Enum<KeyDerivationFunction>

org.apache.nifi.security.util.KeyDerivationFunction

All Implemented Interfaces:

Serializable, Comparable<KeyDerivationFunction>

public enum KeyDerivationFunction
extends Enum<KeyDerivationFunction>

Enumeration capturing essential information about the various key derivation functions that might be supported.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARGON2
BCRYPT
NIFI_LEGACY
NONE
OPENSSL_EVP_BYTES_TO_KEY
PBKDF2
SCRYPT

Field Summary

Fields

Modifier and Type	Field and Description
private String	description
private String	kdfName

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getKdfName()
boolean	hasFormattedSalt()
boolean	isStrongKDF()
String	toString()
static KeyDerivationFunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyDerivationFunction[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final KeyDerivationFunction NONE

NIFI_LEGACY

public static final KeyDerivationFunction NIFI_LEGACY

OPENSSL_EVP_BYTES_TO_KEY

public static final KeyDerivationFunction OPENSSL_EVP_BYTES_TO_KEY

BCRYPT

public static final KeyDerivationFunction BCRYPT

SCRYPT

public static final KeyDerivationFunction SCRYPT

PBKDF2

public static final KeyDerivationFunction PBKDF2

ARGON2

public static final KeyDerivationFunction ARGON2

Field Detail

kdfName

private final String kdfName

description

private final String description

Method Detail

values

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

Returns:

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

valueOf

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

getKdfName

public String getKdfName()

getDescription

public String getDescription()

isStrongKDF

public boolean isStrongKDF()

hasFormattedSalt

public boolean hasFormattedSalt()

toString

public String toString()

Overrides:

toString in class Enum<KeyDerivationFunction>