org.forgerock.openam.scripting

Enum ScriptConstants.GlobalScript

java.lang.Object

java.lang.Enum<ScriptConstants.GlobalScript>

org.forgerock.openam.scripting.ScriptConstants.GlobalScript

All Implemented Interfaces:

Serializable, Comparable<ScriptConstants.GlobalScript>

Enclosing class:

ScriptConstants

public static enum ScriptConstants.GlobalScript
extends Enum<ScriptConstants.GlobalScript>

Predefined global script configuration IDs. The global script configurations are defined in the scripting service and accessible in all realms.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTH_MODULE_CLIENT_SIDE
AUTH_MODULE_SERVER_SIDE
DEVICE_ID_MATCH_CLIENT_SIDE
DEVICE_ID_MATCH_SERVER_SIDE
OIDC_CLAIMS_SCRIPT
POLICY_CONDITION_SCRIPT

Method Summary

Modifier and Type	Method and Description
ScriptConstants.ScriptContext	getContext() Get the ScriptConstants.ScriptContext of the global script.
String	getDisplayName() Get the display name of the global script.
String	getId() Get the Id of the global script.
static boolean	isGlobalScript(String id) Returns true if the id is a global script id.
static ScriptConstants.GlobalScript	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScriptConstants.GlobalScript[]	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

AUTH_MODULE_SERVER_SIDE

public static final ScriptConstants.GlobalScript AUTH_MODULE_SERVER_SIDE

AUTH_MODULE_CLIENT_SIDE

public static final ScriptConstants.GlobalScript AUTH_MODULE_CLIENT_SIDE

DEVICE_ID_MATCH_SERVER_SIDE

public static final ScriptConstants.GlobalScript DEVICE_ID_MATCH_SERVER_SIDE

DEVICE_ID_MATCH_CLIENT_SIDE

public static final ScriptConstants.GlobalScript DEVICE_ID_MATCH_CLIENT_SIDE

OIDC_CLAIMS_SCRIPT

public static final ScriptConstants.GlobalScript OIDC_CLAIMS_SCRIPT

POLICY_CONDITION_SCRIPT

public static final ScriptConstants.GlobalScript POLICY_CONDITION_SCRIPT

Method Detail

values

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

Returns:

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

valueOf

public static ScriptConstants.GlobalScript 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

getDisplayName

public String getDisplayName()

Get the display name of the global script.

Returns:

The display name of the script.

getId

public String getId()

Get the Id of the global script.

Returns:

The Id of the global script.

getContext

public ScriptConstants.ScriptContext getContext()

Get the ScriptConstants.ScriptContext of the global script.

Returns:

The context of the global script.

isGlobalScript

public static boolean isGlobalScript(String id)

Returns true if the id is a global script id.

Parameters:

id - The script id.

Returns:

true if the id matches a global script id.