Package org.identityconnectors.framework.common.objects

Class ScriptContextBuilder

  • public final class ScriptContextBuilder
extends java.lang.Object
    Builds an ScriptContext.

    • Constructor Detail

      • ScriptContextBuilder

        public ScriptContextBuilder()
        Creates an empty builder.

      • ScriptContextBuilder

        public ScriptContextBuilder​(java.lang.String scriptLanguage,
                            java.lang.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 java.lang.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​(java.lang.String scriptLanguage)
        Sets the script language.
        Parameters:
        scriptLanguage - The script language

      • getScriptText

        public java.lang.String getScriptText()
        Returns the actual characters of the script.
        Returns:
        the actual characters of the script.

      • setScriptText

        public ScriptContextBuilder setScriptText​(java.lang.String scriptText)
        Sets the actual characters of the script.
        Parameters:
        scriptText - The actual characters of the script.

      • addScriptArgument

        public ScriptContextBuilder addScriptArgument​(java.lang.String name,
                                              java.lang.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​(java.lang.String name)
        Removes the given script argument.
        Parameters:
        name - The name of the argument. Must not be null.

      • getScriptArguments

        public java.util.Map<java.lang.String,​java.lang.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.