Package org.forgerock.openam.auth.node.api

Class SharedStateConstants

java.lang.Object

org.forgerock.openam.auth.node.api.SharedStateConstants

@SupportedAll
public final class SharedStateConstants
extends Object

This class represents all the constants that can be used as keys for storing values in the tree's shared state.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH_LEVEL	The current authentication level achieved so far processing the tree.
static final String	CURRENT_NODE_ID	The nodeId of the node being processed in the tree.
static final String	EMAIL_ADDRESS	The user's email address.
static final String	ERROR_MESSAGE_KEY	Error message key.
static final String	FAILURE_URL	The post authentication failure URL.
static final String	LOCKOUT_MESSAGE_KEY	Lockout message key.
static final String	NODE_TYPE	The AuthType parameter key.
static final String	OBJECT_ATTRIBUTES	Deprecated. use IdmIntegrationService.OBJECT_ATTRIBUTES instead.
static final String	ONE_TIME_PASSWORD	The One Time Password.
static final String	ONE_TIME_PASSWORD_TIMESTAMP	The time at which the one time password was created.
static final String	PASSWORD	The user's password.
static final String	REALM	The Realm.
static final String	RETRIES_REMAINING	The countdown of number of retries remaining.
static final String	RETRY_COUNT	The count of number of retries.
static final String	SUCCESS_URL	The post authentication success URL.
static final String	TARGET_AUTH_LEVEL	The desirable authentication level to achieve at successful authentication.
static final String	TOKEN_RESTRICTION	The final session that is issued after authentication will be restricted according to this restriction.
static final String	UNIVERSAL_ID	The user universal id.
static final String	USER_GOTO_ON_FAIL_PARAM_KEY	The gotoOnFail URL parameter key.
static final String	USER_GOTO_PARAM_KEY	The goto URL parameter key.
static final String	USER_INFO	User info payload key.
static final String	USERNAME	The username.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

REALM

public static final String REALM

The Realm.

See Also:

• Constant Field Values

AUTH_LEVEL

public static final String AUTH_LEVEL

The current authentication level achieved so far processing the tree.

See Also:

• Constant Field Values

TARGET_AUTH_LEVEL

public static final String TARGET_AUTH_LEVEL

The desirable authentication level to achieve at successful authentication.

See Also:

• Constant Field Values

CURRENT_NODE_ID

public static final String CURRENT_NODE_ID

The nodeId of the node being processed in the tree.

See Also:

• Constant Field Values

USERNAME

public static final String USERNAME

The username.

See Also:

• Constant Field Values

UNIVERSAL_ID

public static final String UNIVERSAL_ID

The user universal id.

See Also:

• Constant Field Values

PASSWORD

public static final String PASSWORD

The user's password.

See Also:

• Constant Field Values

ONE_TIME_PASSWORD

public static final String ONE_TIME_PASSWORD

The One Time Password.

See Also:

• Constant Field Values

ONE_TIME_PASSWORD_TIMESTAMP

public static final String ONE_TIME_PASSWORD_TIMESTAMP

The time at which the one time password was created.

See Also:

• Constant Field Values

RETRIES_REMAINING

public static final String RETRIES_REMAINING

The countdown of number of retries remaining.

See Also:

• Constant Field Values

RETRY_COUNT

public static final String RETRY_COUNT

The count of number of retries.

See Also:

• Constant Field Values

EMAIL_ADDRESS

public static final String EMAIL_ADDRESS

The user's email address.

See Also:

• Constant Field Values

SUCCESS_URL

public static final String SUCCESS_URL

The post authentication success URL.

See Also:

• Constant Field Values

FAILURE_URL

public static final String FAILURE_URL

The post authentication failure URL.

See Also:

• Constant Field Values

USER_GOTO_PARAM_KEY

public static final String USER_GOTO_PARAM_KEY

The goto URL parameter key.

See Also:

• Constant Field Values

USER_GOTO_ON_FAIL_PARAM_KEY

public static final String USER_GOTO_ON_FAIL_PARAM_KEY

The gotoOnFail URL parameter key.

See Also:

• Constant Field Values

NODE_TYPE

public static final String NODE_TYPE

The AuthType parameter key. Must be kept in sync with: ISAuthConstants#NODE_TYPE.

See Also:

• Constant Field Values

OBJECT_ATTRIBUTES

@Deprecated
public static final String OBJECT_ATTRIBUTES

Deprecated.

use IdmIntegrationService.OBJECT_ATTRIBUTES instead.

The container for user object attribute data. This should never be imported by a Node.

See Also:

• Constant Field Values

USER_INFO

public static final String USER_INFO

User info payload key.

See Also:

• Constant Field Values

ERROR_MESSAGE_KEY

public static final String ERROR_MESSAGE_KEY

Error message key.

See Also:

• Constant Field Values

LOCKOUT_MESSAGE_KEY

public static final String LOCKOUT_MESSAGE_KEY

Lockout message key.

See Also:

• Constant Field Values

TOKEN_RESTRICTION

public static final String TOKEN_RESTRICTION

The final session that is issued after authentication will be restricted according to this restriction.

See Also:

• Constant Field Values