org.onosproject.lisp.msg.authentication

Enum LispAuthenticationKeyEnum

java.lang.Object

java.lang.Enum<LispAuthenticationKeyEnum>

org.onosproject.lisp.msg.authentication.LispAuthenticationKeyEnum

All Implemented Interfaces:

Serializable, Comparable<LispAuthenticationKeyEnum>

public enum LispAuthenticationKeyEnum
extends Enum<LispAuthenticationKeyEnum>

Authentication key enumeration class. By far, LISP also support two types of MAC authentication which are HMAC-SHA-1-96 and HMAC-SHA-256-128. https://tools.ietf.org/html/rfc6830#page-39

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE No authentication.
SHA1 HMAC SHA1 encryption.
SHA256 HMAC SHA256 encryption.
UNKNOWN Unsupported authentication type.

Method Summary

Modifier and Type	Method and Description
short	getHashLength() Obtains hash length.
short	getKeyId() Obtains authentication key identifier.
String	getName() Obtains authentication name.
static LispAuthenticationKeyEnum	valueOf(short keyId) Obtains LISP authentication key enum by providing key identifier.
static LispAuthenticationKeyEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static LispAuthenticationKeyEnum[]	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

NONE

public static final LispAuthenticationKeyEnum NONE

No authentication.

SHA1

public static final LispAuthenticationKeyEnum SHA1

HMAC SHA1 encryption.

SHA256

public static final LispAuthenticationKeyEnum SHA256

HMAC SHA256 encryption.

UNKNOWN

public static final LispAuthenticationKeyEnum UNKNOWN

Unsupported authentication type.

Method Detail

values

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

Returns:

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

valueOf

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

getKeyId

public short getKeyId()

Obtains authentication key identifier.

Returns:

authentication key identifier

getName

public String getName()

Obtains authentication name.

Returns:

authentication name

getHashLength

public short getHashLength()

Obtains hash length.

Returns:

hash length

valueOf

public static LispAuthenticationKeyEnum valueOf(short keyId)

Obtains LISP authentication key enum by providing key identifier.

Parameters:

keyId - LISP authentication key identifier

Returns:

LISP authentication key enum