com.absio.crypto.key

Enum KeyFileSettings

java.lang.Object

java.lang.Enum<KeyFileSettings>

com.absio.crypto.key.KeyFileSettings

All Implemented Interfaces:

Serializable, Comparable<KeyFileSettings>

public enum KeyFileSettings
extends Enum<KeyFileSettings>

This enumeration represents the specification for performing PBKDF2 Key File encoding for a KeyRing.

Enum Constant Summary

Enum Constants

Enum Constant and Description
VERSION1

Field Summary

Fields

Modifier and Type	Field and Description
static KeyFileSettings	DEFAULT This is the default settings.

Method Summary

Modifier and Type	Method and Description
CipherTransformation	getCipherTransformation() Get the CipherTransformation to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.
int	getDefaultSaltLength() Get the default salt length to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.
String	getEncoding() Get the encoding to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.
int	getIterations() Get the iterations to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.
AESKeyStrength	getKeyStrength() Get the AESKeyStrength to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.
MacAlgorithm	getMacAlgorithm() Get the MacAlgorithm to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.
static KeyFileSettings	getSettings(long version) Get the settings with the matching version.
long	getVersion() Get the version of the key file.
static KeyFileSettings	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyFileSettings[]	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

VERSION1

public static final KeyFileSettings VERSION1

Field Detail

DEFAULT

public static KeyFileSettings DEFAULT

This is the default settings.

Method Detail

values

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

Returns:

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

valueOf

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

getSettings

public static KeyFileSettings getSettings(long version)

Get the settings with the matching version. An exception is thrown if the Settings is not found.

Parameters:

version - the version of the settings to find

Returns:

the KeyFileSettings with the matching version

Throws:

IllegalArgumentException - thrown if there is no settings with the matching version

getCipherTransformation

public CipherTransformation getCipherTransformation()

Get the CipherTransformation to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.

Returns:

the CipherTransformation to use for the PBKDF2

getDefaultSaltLength

public int getDefaultSaltLength()

Get the default salt length to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.

Returns:

the default salt length to use for the PBKDF2

getEncoding

public String getEncoding()

Get the encoding to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.

Returns:

the encoding to use for the PBKDF2

getIterations

public int getIterations()

Get the iterations to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.

Returns:

the iterations to use for the PBKDF2

getKeyStrength

public AESKeyStrength getKeyStrength()

Get the AESKeyStrength to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.

Returns:

the AESKeyStrength to use for the PBKDF2

getMacAlgorithm

public MacAlgorithm getMacAlgorithm()

Get the MacAlgorithm to use for the PBKDF2 of the KeyRing to encrypt/decrypt a key file.

Returns:

the MacAlgorithm to use for the PBKDF2

getVersion

public long getVersion()

Get the version of the key file.

Returns:

the version of the key file