org.forgerock.openam.scripting.service

Class ScriptConfiguration.Builder

java.lang.Object

org.forgerock.openam.scripting.service.ScriptConfiguration.Builder

Enclosing class:

ScriptConfiguration

public static class ScriptConfiguration.Builder
extends Object

Builder for ScriptConfiguration.

Method Summary

Modifier and Type	Method and Description
ScriptConfiguration	build() Construct the ScriptConfiguration with the parameters set on this builder.
ScriptConfiguration.Builder	generateId() Generate a universally unique identifier for the ScriptConfiguration.
ScriptConfiguration.Builder	setContext(ScriptConstants.ScriptContext context) Set the context for the ScriptConfiguration.
ScriptConfiguration.Builder	setCreatedBy(String createdBy) Set the ID of the user that created the ScriptConfiguration.
ScriptConfiguration.Builder	setCreationDate(long creationDate) Set the creation date of the ScriptConfiguration.
ScriptConfiguration.Builder	setDescription(String description) Add the description for the ScriptConfiguration.
ScriptConfiguration.Builder	setId(String id) Set a universally unique identifier for the ScriptConfiguration.
ScriptConfiguration.Builder	setLanguage(SupportedScriptingLanguage language) Set the language for the ScriptConfiguration.
ScriptConfiguration.Builder	setLastModifiedBy(String lastModifiedBy) Set the ID of the user that last modified the ScriptConfiguration.
ScriptConfiguration.Builder	setLastModifiedDate(long lastModifiedDate) Set the last modified date of the ScriptConfiguration.
ScriptConfiguration.Builder	setName(String name) Set the name for the ScriptConfiguration.
ScriptConfiguration.Builder	setScript(String script) Set the script for the ScriptConfiguration.

Methods inherited from class java.lang.Object

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

Method Detail

generateId

public ScriptConfiguration.Builder generateId()

Generate a universally unique identifier for the ScriptConfiguration.

Returns:

The ScriptConfiguration builder.

setId

public ScriptConfiguration.Builder setId(String id)

Set a universally unique identifier for the ScriptConfiguration.

Returns:

The ScriptConfiguration builder.

setName

public ScriptConfiguration.Builder setName(String name)

Set the name for the ScriptConfiguration.

Parameters:

name - A display name for the ScriptConfiguration.

Returns:

The ScriptConfiguration builder.

setScript

public ScriptConfiguration.Builder setScript(String script)

Set the script for the ScriptConfiguration.

Parameters:

script - The script that is represented by this configuration.

Returns:

The ScriptConfiguration builder.

setLanguage

public ScriptConfiguration.Builder setLanguage(SupportedScriptingLanguage language)

Set the language for the ScriptConfiguration.

Parameters:

language - The language in which the script is written.

Returns:

The ScriptConfiguration builder.

setContext

public ScriptConfiguration.Builder setContext(ScriptConstants.ScriptContext context)

Set the context for the ScriptConfiguration.

Parameters:

context - The context in which the script will be used.

Returns:

The ScriptConfiguration builder.

setDescription

public ScriptConfiguration.Builder setDescription(String description)

Add the description for the ScriptConfiguration.

Parameters:

description - The description.

Returns:

The ScriptConfiguration builder.

setCreatedBy

public ScriptConfiguration.Builder setCreatedBy(String createdBy)

Set the ID of the user that created the ScriptConfiguration.

Parameters:

createdBy - The user ID.

Returns:

The ScriptConfiguration builder.

setCreationDate

public ScriptConfiguration.Builder setCreationDate(long creationDate)

Set the creation date of the ScriptConfiguration.

Parameters:

creationDate - The creation date in milliseconds.

Returns:

The ScriptConfiguration builder.

setLastModifiedBy

public ScriptConfiguration.Builder setLastModifiedBy(String lastModifiedBy)

Set the ID of the user that last modified the ScriptConfiguration.

Parameters:

lastModifiedBy - The user ID.

Returns:

The ScriptConfiguration builder.

setLastModifiedDate

public ScriptConfiguration.Builder setLastModifiedDate(long lastModifiedDate)

Set the last modified date of the ScriptConfiguration.

Parameters:

lastModifiedDate - The last modified date.

Returns:

The ScriptConfiguration builder.

build

public ScriptConfiguration build()
                          throws ScriptException

Construct the ScriptConfiguration with the parameters set on this builder.

Returns:

An instance of ScriptConfiguration.

Throws:

ScriptException - if any of the required parameters are null.