com.absio.crypto.mac

Enum MacAlgorithm

java.lang.Object

java.lang.Enum<MacAlgorithm>

com.absio.crypto.mac.MacAlgorithm

All Implemented Interfaces:

Serializable, Comparable<MacAlgorithm>

public enum MacAlgorithm
extends Enum<MacAlgorithm>

This enumeration represents the MAC algorithms that Absio knowingly supports. By default Absio uses HMACSHA384.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HMACSHA384 HMAC with SHA384

Field Summary

Fields

Modifier and Type	Field and Description
static MacAlgorithm	DEFAULT The default MAC algorithm is HMACSHA384.

Method Summary

Modifier and Type	Method and Description
static MacAlgorithm	getByIndex(long index) Gets the algorithm by index.
int	getDefaultKeySizeInBytes() Get the default key size in bytes.
int	getIndex() Get the index of the enumeration value.
static MacAlgorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static MacAlgorithm[]	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

HMACSHA384

public static final MacAlgorithm HMACSHA384

HMAC with SHA384

Field Detail

DEFAULT

public static final MacAlgorithm DEFAULT

The default MAC algorithm is HMACSHA384.

Method Detail

values

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

Returns:

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

valueOf

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

getByIndex

public static MacAlgorithm getByIndex(long index)
                               throws NoSuchAlgorithmException

Gets the algorithm by index.

Parameters:

index - the index of the algorithm to get

Returns:

the algorithm with the given index

Throws:

NoSuchAlgorithmException - thrown if no algorithm exists with the given index

getDefaultKeySizeInBytes

public int getDefaultKeySizeInBytes()

Get the default key size in bytes.

Returns:

the default keys size in bytes

getIndex

public int getIndex()

Get the index of the enumeration value.

Returns:

the index of the enumeration value