Enum Class NuggetAuthenticationFailureReason

java.lang.Object

java.lang.Enum<NuggetAuthenticationFailureReason>

org.j7m.middleware.operations.api.NuggetAuthenticationFailureReason

All Implemented Interfaces:

Serializable, Comparable<NuggetAuthenticationFailureReason>, Constable

public enum NuggetAuthenticationFailureReason
extends Enum<NuggetAuthenticationFailureReason>

Stable, redacted reason category for a failed nugget PIN admission attempt.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMISSION_UNAVAILABLE	The verifier or admission configuration is unavailable to public callers.
INVALID_REQUEST	The request shape or credential size was invalid.
NONE	No failure occurred.
REJECTED	The supplied credential was not accepted.
SERVICE_UNAVAILABLE	Nugget administration is disabled, stopping, or unavailable.
THROTTLED	Attempts from the request source are currently throttled.

Method Summary

Modifier and Type	Method	Description
static NuggetAuthenticationFailureReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NuggetAuthenticationFailureReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final NuggetAuthenticationFailureReason NONE

No failure occurred.

INVALID_REQUEST

public static final NuggetAuthenticationFailureReason INVALID_REQUEST

The request shape or credential size was invalid.

REJECTED

public static final NuggetAuthenticationFailureReason REJECTED

The supplied credential was not accepted.

THROTTLED

public static final NuggetAuthenticationFailureReason THROTTLED

Attempts from the request source are currently throttled.

SERVICE_UNAVAILABLE

public static final NuggetAuthenticationFailureReason SERVICE_UNAVAILABLE

Nugget administration is disabled, stopping, or unavailable.

ADMISSION_UNAVAILABLE

public static final NuggetAuthenticationFailureReason ADMISSION_UNAVAILABLE

The verifier or admission configuration is unavailable to public callers.

Method Details

values

public static NuggetAuthenticationFailureReason[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static NuggetAuthenticationFailureReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null