org.identityconnectors.framework.common.objects

Class ScriptContextBuilder

java.lang.Object

org.identityconnectors.framework.common.objects.ScriptContextBuilder

public final class ScriptContextBuilder
extends Object

Builds an ScriptContext.

Constructor Summary

Constructors

Constructor and Description
ScriptContextBuilder() Creates an empty builder.
ScriptContextBuilder(String scriptLanguage, String scriptText) Creates a builder with the required parameters specified.

Method Summary

Modifier and Type	Method and Description
ScriptContextBuilder	addScriptArgument(String name, Object value) Adds or sets an argument to pass to the script.
ScriptContext	build() Creates a ScriptContext.
Map<String,Object>	getScriptArguments() Returns a mutable reference of the script arguments map.
String	getScriptLanguage() Identifies the language in which the script is written (e.g., bash, csh, Perl4 or Python).
String	getScriptText() Returns the actual characters of the script.
void	removeScriptArgument(String name) Removes the given script argument.
ScriptContextBuilder	setScriptLanguage(String scriptLanguage) Sets the script language.
ScriptContextBuilder	setScriptText(String scriptText) Sets the actual characters of the script.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptContextBuilder

public ScriptContextBuilder()

Creates an empty builder.

ScriptContextBuilder

public ScriptContextBuilder(String scriptLanguage,
                            String scriptText)

Creates a builder with the required parameters specified.

Parameters:

scriptLanguage - a string that identifies the language in which the script is written (e.g., bash, csh, Perl4 or Python).

scriptText - The text (i.e., actual characters) of the script.

Method Detail

getScriptLanguage

public String getScriptLanguage()

Identifies the language in which the script is written (e.g., bash, csh, Perl4 or Python).

Returns:

The script language.

setScriptLanguage

public ScriptContextBuilder setScriptLanguage(String scriptLanguage)

Sets the script language.

Parameters:

scriptLanguage - The script language

getScriptText

public String getScriptText()

Returns the actual characters of the script.

Returns:

the actual characters of the script.

setScriptText

public ScriptContextBuilder setScriptText(String scriptText)

Sets the actual characters of the script.

Parameters:

scriptText - The actual characters of the script.

addScriptArgument

public ScriptContextBuilder addScriptArgument(String name,
                                              Object value)

Adds or sets an argument to pass to the script.

Parameters:

name - The name of the argument. Must not be null.

value - The value of the argument. Must be one of type types that the framework can serialize.

See Also:

for a list of supported types.

removeScriptArgument

public void removeScriptArgument(String name)

Removes the given script argument.

Parameters:

name - The name of the argument. Must not be null.

getScriptArguments

public Map<String,Object> getScriptArguments()

Returns a mutable reference of the script arguments map.

Returns:

A mutable reference of the script arguments map.

build

public ScriptContext build()

Creates a ScriptContext. The scriptLanguage and scriptText must be set prior to calling this.

Returns:

The ScriptContext.