org.forgerock.openam.scripting

Class ScriptConstants

java.lang.Object

org.forgerock.openam.scripting.ScriptConstants

public final class ScriptConstants
extends Object

Constants used for managing scripts.

Since:

13.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScriptConstants.GlobalScript Predefined global script configuration IDs.
static class	ScriptConstants.ScriptContext The context in which a script will be used.
static class	ScriptConstants.ScriptErrorCode Error messages are stored in the scripting.properties file to facilitate translation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHENTICATION_SERVER_SIDE_NAME
static String	BLACK_LIST
static int	DEFAULT_CORE_THREADS
static long	DEFAULT_IDLE_TIMEOUT_SECONDS
static int	DEFAULT_MAX_THREADS
static int	DEFAULT_QUEUE_SIZE
static String	EMPTY
static String	EMPTY_SCRIPT_SELECTION
static String	ENGINE_CONFIGURATION
static String	JSON_UUID
static String	LOGGER_NAME
static String	OIDC_CLAIMS_NAME
static String	POLICY_CONDITION_NAME
static String	RESOURCE_BUNDLE Resource bundle used for error messages.
static String	SCRIPT_CONFIGURATION
static String	SCRIPT_CONFIGURATIONS
static String	SCRIPT_CONTEXT
static String	SCRIPT_CREATED_BY
static String	SCRIPT_CREATION_DATE
static String	SCRIPT_DESCRIPTION
static String	SCRIPT_IS_DEFAULT
static String	SCRIPT_LANGUAGE
static String	SCRIPT_LAST_MODIFIED_BY
static String	SCRIPT_LAST_MODIFIED_DATE
static String	SCRIPT_NAME
static String	SCRIPT_TEXT
static String	SCRIPT_TIMEOUT
static String	SCRIPTING_HTTP_CLIENT_NAME
static String	SERVICE_NAME
static String	THREAD_POOL_CORE_SIZE
static String	THREAD_POOL_IDLE_TIMEOUT
static String	THREAD_POOL_MAX_SIZE
static String	THREAD_POOL_QUEUE_SIZE
static String	USE_SECURITY_MANAGER
static String	WHITE_LIST

Method Summary

Modifier and Type	Method and Description
static ScriptConstants.ScriptContext	getContextFromString(String context) Retrieve the ScriptContext instance for the given context.
static SupportedScriptingLanguage	getLanguageFromString(String languageName) Retrieve the SupportedScriptingLanguage instance for the given language.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_BUNDLE

public static final String RESOURCE_BUNDLE

Resource bundle used for error messages.

See Also:

Constant Field Values

SCRIPT_NAME

public static final String SCRIPT_NAME

See Also:

Constant Field Values

JSON_UUID

public static final String JSON_UUID

See Also:

Constant Field Values

SCRIPT_TEXT

public static final String SCRIPT_TEXT

See Also:

Constant Field Values

SCRIPT_IS_DEFAULT

public static final String SCRIPT_IS_DEFAULT

See Also:

Constant Field Values

SCRIPT_LANGUAGE

public static final String SCRIPT_LANGUAGE

See Also:

Constant Field Values

SCRIPT_CONTEXT

public static final String SCRIPT_CONTEXT

See Also:

Constant Field Values

SCRIPT_DESCRIPTION

public static final String SCRIPT_DESCRIPTION

See Also:

Constant Field Values

SCRIPT_CREATED_BY

public static final String SCRIPT_CREATED_BY

See Also:

Constant Field Values

SCRIPT_CREATION_DATE

public static final String SCRIPT_CREATION_DATE

See Also:

Constant Field Values

SCRIPT_LAST_MODIFIED_BY

public static final String SCRIPT_LAST_MODIFIED_BY

See Also:

Constant Field Values

SCRIPT_LAST_MODIFIED_DATE

public static final String SCRIPT_LAST_MODIFIED_DATE

See Also:

Constant Field Values

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

SCRIPT_CONFIGURATION

public static final String SCRIPT_CONFIGURATION

See Also:

Constant Field Values

SCRIPT_CONFIGURATIONS

public static final String SCRIPT_CONFIGURATIONS

See Also:

Constant Field Values

EMPTY

public static final String EMPTY

See Also:

Constant Field Values

EMPTY_SCRIPT_SELECTION

public static final String EMPTY_SCRIPT_SELECTION

See Also:

Constant Field Values

SCRIPT_TIMEOUT

public static final String SCRIPT_TIMEOUT

See Also:

Constant Field Values

THREAD_POOL_CORE_SIZE

public static final String THREAD_POOL_CORE_SIZE

See Also:

Constant Field Values

THREAD_POOL_MAX_SIZE

public static final String THREAD_POOL_MAX_SIZE

See Also:

Constant Field Values

THREAD_POOL_QUEUE_SIZE

public static final String THREAD_POOL_QUEUE_SIZE

See Also:

Constant Field Values

THREAD_POOL_IDLE_TIMEOUT

public static final String THREAD_POOL_IDLE_TIMEOUT

See Also:

Constant Field Values

WHITE_LIST

public static final String WHITE_LIST

See Also:

Constant Field Values

BLACK_LIST

public static final String BLACK_LIST

See Also:

Constant Field Values

USE_SECURITY_MANAGER

public static final String USE_SECURITY_MANAGER

See Also:

Constant Field Values

ENGINE_CONFIGURATION

public static final String ENGINE_CONFIGURATION

See Also:

Constant Field Values

DEFAULT_CORE_THREADS

public static final int DEFAULT_CORE_THREADS

See Also:

Constant Field Values

DEFAULT_MAX_THREADS

public static final int DEFAULT_MAX_THREADS

See Also:

Constant Field Values

DEFAULT_QUEUE_SIZE

public static final int DEFAULT_QUEUE_SIZE

See Also:

Constant Field Values

DEFAULT_IDLE_TIMEOUT_SECONDS

public static final long DEFAULT_IDLE_TIMEOUT_SECONDS

See Also:

Constant Field Values

LOGGER_NAME

public static final String LOGGER_NAME

See Also:

Constant Field Values

AUTHENTICATION_SERVER_SIDE_NAME

public static final String AUTHENTICATION_SERVER_SIDE_NAME

See Also:

Constant Field Values

POLICY_CONDITION_NAME

public static final String POLICY_CONDITION_NAME

See Also:

Constant Field Values

OIDC_CLAIMS_NAME

public static final String OIDC_CLAIMS_NAME

See Also:

Constant Field Values

SCRIPTING_HTTP_CLIENT_NAME

public static final String SCRIPTING_HTTP_CLIENT_NAME

See Also:

Constant Field Values

Method Detail

getLanguageFromString

public static SupportedScriptingLanguage getLanguageFromString(String languageName)
                                                        throws ScriptException

Retrieve the SupportedScriptingLanguage instance for the given language.

Parameters:

languageName - The name of the required scripting language.

Returns:

The SupportedScriptingLanguage.

Throws:

ScriptException - If the given language is not supported.

getContextFromString

public static ScriptConstants.ScriptContext getContextFromString(String context)
                                                          throws ScriptException

Retrieve the ScriptContext instance for the given context.

Parameters:

context - The name of the required scripting context.

Returns:

The ScriptContext.

Throws:

ScriptException - If the given context is not supported.