|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
org.identityconnectors.framework.common.objects.ScriptContextBuilder
public final class ScriptContextBuilder
Builds an ScriptContext
.
Constructor Summary | |
---|---|
ScriptContextBuilder() Creates an empty builder. |
|
ScriptContextBuilder(java.lang.String scriptLanguage, java.lang.String scriptText) Creates a builder with the required parameters specified. |
Method Summary | |
---|---|
ScriptContextBuilder |
addScriptArgument(java.lang.String name, java.lang.Object value) Adds or sets an argument to pass to the script. |
ScriptContext |
build() Creates a ScriptContext . |
java.util.Map<java.lang.String,java.lang.Object> |
getScriptArguments() Returns a mutable reference of the script arguments map. |
java.lang.String |
getScriptLanguage() Identifies the language in which the script is written (e.g., bash , csh , Perl4 or Python ). |
java.lang.String |
getScriptText() Returns the actual characters of the script. |
void |
removeScriptArgument(java.lang.String name) Removes the given script argument. |
ScriptContextBuilder |
setScriptLanguage(java.lang.String scriptLanguage) Sets the script language |
ScriptContextBuilder |
setScriptText(java.lang.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 |
---|
public ScriptContextBuilder()
public ScriptContextBuilder(java.lang.String scriptLanguage, java.lang.String scriptText)
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 |
---|
public java.lang.String getScriptLanguage()
bash
, csh
, Perl4
or Python
).public ScriptContextBuilder setScriptLanguage(java.lang.String scriptLanguage)
scriptLanguage
- The script languagepublic java.lang.String getScriptText()
public ScriptContextBuilder setScriptText(java.lang.String scriptText)
scriptText
- The actual characters of the script.public ScriptContextBuilder addScriptArgument(java.lang.String name, java.lang.Object value)
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.for a list of supported types.
public void removeScriptArgument(java.lang.String name)
name
- The name of the argument. Must not be null.public java.util.Map<java.lang.String,java.lang.Object> getScriptArguments()
public ScriptContext build()
ScriptContext
. The scriptLanguage
and scriptText
must be set prior to calling this.ScriptContext
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |