org.forgerock.openam.scripting.service

Class ScriptConfiguration

java.lang.Object

org.forgerock.openam.scripting.service.ScriptConfiguration

public class ScriptConfiguration
extends Object

This class represents the configuration for a script in OpenAM. It supplies a builder class for easy construction and error reporting.

Since:

13.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScriptConfiguration.Builder Builder for ScriptConfiguration.

Method Summary

Modifier and Type	Method and Description
static ScriptConfiguration.Builder	builder() Create a builder for ScriptConfiguration.
boolean	equals(Object o)
ScriptConstants.ScriptContext	getContext() Get the context in which the script will be used.
String	getCreatedBy() Get the ID of the user that created the script.
long	getCreationDate() Get the date this script was created.
String	getDescription() Get the description for the script.
String	getId() Get the universally unique identifier for the ScriptConfiguration.
SupportedScriptingLanguage	getLanguage() Get the language in which the script is written.
String	getLastModifiedBy() Get the ID of the user that last modified the script.
long	getLastModifiedDate() Get the date this script was last modified.
String	getName() Get the name for the ScriptConfiguration.
String	getScript() Get the script represented by the ScriptConfiguration.
int	hashCode()
boolean	isDefault() Returns true if this is a default script.
ScriptConfiguration.Builder	populatedBuilder() Create a builder for this ScriptConfiguration with all fields populated and ready for modification.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static final ScriptConfiguration.Builder builder()

Create a builder for ScriptConfiguration.

Returns:

A ScriptConfiguration builder.

getId

public String getId()

Get the universally unique identifier for the ScriptConfiguration.

Returns:

The UUID.

getName

public String getName()

Get the name for the ScriptConfiguration.

Returns:

The name.

getScript

public String getScript()

Get the script represented by the ScriptConfiguration.

Returns:

The script.

isDefault

public boolean isDefault()

Returns true if this is a default script.

Returns:

true if a default script.

getLanguage

public SupportedScriptingLanguage getLanguage()

Get the language in which the script is written.

Returns:

The scripting language.

getContext

public ScriptConstants.ScriptContext getContext()

Get the context in which the script will be used.

Returns:

The script context.

getDescription

public String getDescription()

Get the description for the script.

Returns:

The script description.

getCreatedBy

public String getCreatedBy()

Get the ID of the user that created the script.

Returns:

The user ID.

getCreationDate

public long getCreationDate()

Get the date this script was created.

Returns:

The creation date.

getLastModifiedBy

public String getLastModifiedBy()

Get the ID of the user that last modified the script.

Returns:

The user ID.

getLastModifiedDate

public long getLastModifiedDate()

Get the date this script was last modified.

Returns:

The last modified date.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

populatedBuilder

public ScriptConfiguration.Builder populatedBuilder()

Create a builder for this ScriptConfiguration with all fields populated and ready for modification.

Returns:

A populated ScriptConfiguration builder.