Package org.forgerock.am.authn.backchannel.exceptions

Enum Class BackChannelAuthErrorCode

java.lang.Object

java.lang.Enum<BackChannelAuthErrorCode>

org.forgerock.am.authn.backchannel.exceptions.BackChannelAuthErrorCode

All Implemented Interfaces:

Serializable, Comparable<BackChannelAuthErrorCode>, java.lang.constant.Constable

public enum BackChannelAuthErrorCode
extends Enum<BackChannelAuthErrorCode>

Error codes for Back channel authentication.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMPTY_SUBJECT_NAME_OR_TYPE	The subject name and/or type is empty.
EMPTY_TRANSACTION_ID	The transaction id is null.
EMPTY_TYPE	The type is empty.
EMPTY_VALUE	The value is empty.
ERROR_CREATING_TRANSACTION	An error occurred creating the transaction.
ERROR_FETCHING_TRANSACTION	There was an error fetching the transaction.
INVALID_ALLOW_RETRY	The allowRetry field is invalid.
INVALID_CONTENT	The content is invalid.
INVALID_DATA	The provided data object is invalid.
INVALID_IDENTITY	The identity is invalid.
INVALID_REALM	The realm is invalid.
INVALID_SUBJECT_NAME	The subject name is invalid.
INVALID_SUBJECT_TYPE	The subject type is invalid.
INVALID_TRACKING_ID	The tracking id is invalid.
INVALID_TRANSACTION_ID	The transaction id is invalid.
INVALID_TREE	The tree is invalid.
INVALID_TYPE	The type is invalid.
TRANSACTION_EXPIRED	The transaction has expired.
TRANSACTION_NOT_FOUND	The transaction id could not be found.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INVALID_SUBJECT_TYPE

public static final BackChannelAuthErrorCode INVALID_SUBJECT_TYPE

The subject type is invalid.

INVALID_CONTENT

public static final BackChannelAuthErrorCode INVALID_CONTENT

The content is invalid.

INVALID_REALM

public static final BackChannelAuthErrorCode INVALID_REALM

The realm is invalid.

INVALID_IDENTITY

public static final BackChannelAuthErrorCode INVALID_IDENTITY

The identity is invalid.

INVALID_TREE

public static final BackChannelAuthErrorCode INVALID_TREE

The tree is invalid.

ERROR_CREATING_TRANSACTION

public static final BackChannelAuthErrorCode ERROR_CREATING_TRANSACTION

An error occurred creating the transaction.

EMPTY_TYPE

public static final BackChannelAuthErrorCode EMPTY_TYPE

The type is empty.

INVALID_TYPE

public static final BackChannelAuthErrorCode INVALID_TYPE

The type is invalid.

EMPTY_VALUE

public static final BackChannelAuthErrorCode EMPTY_VALUE

The value is empty.

EMPTY_SUBJECT_NAME_OR_TYPE

public static final BackChannelAuthErrorCode EMPTY_SUBJECT_NAME_OR_TYPE

The subject name and/or type is empty.

INVALID_SUBJECT_NAME

public static final BackChannelAuthErrorCode INVALID_SUBJECT_NAME

The subject name is invalid.

EMPTY_TRANSACTION_ID

public static final BackChannelAuthErrorCode EMPTY_TRANSACTION_ID

The transaction id is null.

INVALID_TRANSACTION_ID

public static final BackChannelAuthErrorCode INVALID_TRANSACTION_ID

The transaction id is invalid.

TRANSACTION_NOT_FOUND

public static final BackChannelAuthErrorCode TRANSACTION_NOT_FOUND

The transaction id could not be found.

ERROR_FETCHING_TRANSACTION

public static final BackChannelAuthErrorCode ERROR_FETCHING_TRANSACTION

There was an error fetching the transaction.

INVALID_DATA

public static final BackChannelAuthErrorCode INVALID_DATA

The provided data object is invalid.

INVALID_TRACKING_ID

public static final BackChannelAuthErrorCode INVALID_TRACKING_ID

The tracking id is invalid.

TRANSACTION_EXPIRED

public static final BackChannelAuthErrorCode TRANSACTION_EXPIRED

The transaction has expired.

INVALID_ALLOW_RETRY

public static final BackChannelAuthErrorCode INVALID_ALLOW_RETRY

The allowRetry field is invalid.

Method Details

values

public static BackChannelAuthErrorCode[] 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 BackChannelAuthErrorCode 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