org.identityconnectors.framework.common.objects

Class ScriptContext

java.lang.Object

org.identityconnectors.framework.common.objects.ScriptContext

public final class ScriptContext
extends Object

Encapsulates a script and all of its parameters.

See Also:

ScriptOnResourceApiOp, ScriptOnConnectorApiOp

Constructor Summary

Constructors

Constructor and Description
ScriptContext(String scriptLanguage, String scriptText, Map<String,Object> scriptArguments) Public only for serialization; please use ScriptContextBuilder.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getScriptArguments() Returns a map of arguments to be passed to the script.
String	getScriptLanguage() Identifies the language in which the script is written (e.g., bash, csh, Perl4 or Python).
String	getScriptText() Returns the text (i.e., actual characters) of the script.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptContext

public ScriptContext(String scriptLanguage,
                     String scriptText,
                     Map<String,Object> scriptArguments)

Public only for serialization; please use ScriptContextBuilder.

Parameters:

scriptLanguage - The script language. Must not be null.

scriptText - The script text. Must not be null.

scriptArguments - The script arguments. May be null.

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.

getScriptText

public String getScriptText()

Returns the text (i.e., actual characters) of the script.

Returns:

The text of the script.

getScriptArguments

public Map<String,Object> getScriptArguments()

Returns a map of arguments to be passed to the script. Values must be types that the framework can serialize. See ObjectSerializerFactory for a list of supported types.

Returns:

A map of arguments to be passed to the script.

toString

public String toString()

Overrides:

toString in class Object