ExtensionScript (OWASP Zed Attack Proxy)

java.lang.Object
- org.parosproxy.paros.extension.ExtensionAdaptor
- - org.zaproxy.zap.extension.script.ExtensionScript

All Implemented Interfaces:: CommandLineListener, Extension

public class ExtensionScript
extends ExtensionAdaptor
implements CommandLineListener

Field Summary

Fields
Modifier and Type	Field and Description
`static Charset`	`DEFAULT_CHARSET` The `Charset` used to load/save the scripts from/to the file.
`static int`	`EXTENSION_ORDER`
`static ImageIcon`	`ICON` Deprecated. (2.7.0) Use `getScriptIcon()` instead.
`static String`	`NAME`
`protected static String`	`SCRIPT_CONSOLE_HOME_PAGE` Deprecated.
`protected static String`	`SCRIPT_NAME_ATT`
`static String`	`SCRIPTS_DIR`
`static String`	`TEMPLATES_DIR`
`static String`	`TYPE_HTTP_SENDER`
`static String`	`TYPE_PROXY`
`static String`	`TYPE_STANDALONE`
`static String`	`TYPE_TARGETED`

Constructor Summary

Constructors
Constructor and Description

ExtensionScript()

Constructors
Constructor and Description
`ExtensionScript()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addListener(ScriptEventListener listener)`
`ScriptNode`	`addScript(ScriptWrapper script)`
`ScriptNode`	`addScript(ScriptWrapper script, boolean display)`
`void`	`addScriptOutputListener(ScriptOutputListener listener)` Adds the given script output listener.
`int`	`addScriptsFromDir(File dir)` Adds the scripts from the given directory and starts tracking it.
`ScriptNode`	`addTemplate(ScriptWrapper template)`
`ScriptNode`	`addTemplate(ScriptWrapper template, boolean display)`
`void`	`addWriter(Writer writer)` Adds the given writer.
`<T> ScriptsCache<T>`	`createScriptsCache(ScriptsCache.Configuration<T> config)` Creates a scripts cache.
`void`	`execute(CommandLineArgument[] args)` execute the command line using the argument provided.
`String`	`getAuthor()` Gets the author of the extension.
`String`	`getDescription()` Returns the description of the extension, to be shown in UI components.
`String`	`getEngineNameForExtension(String ext)`
`ScriptEngineWrapper`	`getEngineWrapper(String name)`
`List<String>`	`getHandledExtensions()` Get the list of extensions this listener can handle
`<T> T`	`getInterface(ScriptWrapper script, Class<T> class1)` Gets the interface `class1` from the given `script`.
`<T> T`	`getInterfaceWithOutAddOnLoader(ScriptWrapper script, Class<T> clazz)` Gets the interface `clazz` from the given `script`.
`ScriptWrapper`	`getScript(String name)`
`int`	`getScriptCount(File dir)` Gets the numbers of scripts for the given directory for the currently registered script engines and types.
`static ImageIcon`	`getScriptIcon()` Gets the script icon.
`List<String>`	`getScriptingEngines()`
`protected ScriptParam`	`getScriptParam()`
`List<ScriptWrapper>`	`getScripts(ScriptType type)`
`List<ScriptWrapper>`	`getScripts(String type)`
`ScriptType`	`getScriptType(String name)`
`Collection<ScriptType>`	`getScriptTypes()`
`ScriptUI`	`getScriptUI()`
`List<ScriptWrapper>`	`getTemplates(ScriptType type)`
`ScriptTreeModel`	`getTreeModel()`
`String`	`getUIName()` By default returns the name returned by `getName()`.
`List<String>`	`getUnsavedResources()` Extensions should return the user friendly names of any unsaved resources - if there are any the user will be given the option not to exit ZAP or, if the extension is bundled in an add-on that's being updated or uninstalled, not to continue with the changes.
`void`	`handleFailedScriptInterface(ScriptWrapper script, String errorMessage)` Handles a failed attempt to convert a script into an interface.
`boolean`	`handleFile(File file)` Handle the specified file (in whatever way is appropriate).
`void`	`handleScriptError(ScriptWrapper script, String error)` Handles errors caused by scripts.
`void`	`handleScriptException(ScriptWrapper script, Exception exception)` Handles exceptions thrown by scripts.
`static boolean`	`hasSameScriptEngine(ScriptWrapper scriptWrapper, ScriptEngineWrapper engineWrapper)` Tells whether or not the given `scriptWrapper` has the given `engineWrapper`.
`void`	`hook(ExtensionHook extensionHook)` Called during extension's initialisation to allow to add new functionality to core components.
`boolean`	`invokeProxyScript(ScriptWrapper script, HttpMessage msg, boolean request)` Invokes the given `script`, synchronously, as a `ProxyScript`, handling any `Exception` thrown during the invocation.
`Invocable`	`invokeScript(ScriptWrapper script)` Invokes the given `script`, synchronously, handling any `Exception` thrown during the invocation.
`Invocable`	`invokeScriptWithOutAddOnLoader(ScriptWrapper script)` Invokes the given `script`, synchronously, handling any `Exception` thrown during the invocation.
`void`	`invokeSenderScript(ScriptWrapper script, HttpMessage msg, int initiator, HttpSender sender, boolean request)` Invokes the given `script`, synchronously, as a `HttpSenderScript`, handling any `Exception` thrown during the invocation.
`void`	`invokeTargetedScript(ScriptWrapper script, HttpMessage msg)` Invokes the given `script`, synchronously, as a `TargetedScript`, handling any `Exception` thrown during the invocation.
`static boolean`	`isSameScriptEngine(String name, String engineName, String engineLanguage)` Tells whether or not the given `name` matches the given `engineName` and `engineLanguage`.
`ScriptWrapper`	`loadScript(ScriptWrapper script)` Loads the script from the file, using `DEFAULT_CHARSET`.
`ScriptWrapper`	`loadScript(ScriptWrapper script, Charset charset)` Loads the script from the file, using the given charset.
`void`	`postInit()` Implement this method to perform tasks after all extensions/add-ons have been initialised.
`static void`	`recordScriptCalledStats(ScriptWrapper sw)`
`static void`	`recordScriptFailedStats(ScriptWrapper sw)`
`void`	`registerScriptEngineWrapper(ScriptEngineWrapper wrapper)` Registers a new script engine wrapper.
`void`	`registerScriptType(ScriptType type)` Registers a new type of script.
`void`	`removeListener(ScriptEventListener listener)`
`void`	`removeScript(ScriptWrapper script)`
`void`	`removeScriptEngineWrapper(ScriptEngineWrapper wrapper)` Removes the given script engine wrapper.
`void`	`removeScriptOutputListener(ScriptOutputListener listener)` Removes the given script output listener.
`int`	`removeScriptsFromDir(File dir)` Removes the scripts added from the given directory and stops tracking it.
`void`	`removeScriptType(ScriptType type)` Removes the given script type.
`void`	`removeScriptUI()`
`void`	`removeScripType(ScriptType type)` Deprecated. (2.9.0) Use `removeScriptType(ScriptType)` instead.
`void`	`removeTemplate(ScriptWrapper template)`
`void`	`removeWriter(Writer writer)` Removes the given writer.
`void`	`saveScript(ScriptWrapper script)`
`void`	`setChanged(ScriptWrapper script, boolean changed)`
`void`	`setEnabled(ScriptWrapper script, boolean enabled)`
`void`	`setError(ScriptWrapper script, Exception e)`
`void`	`setError(ScriptWrapper script, String details)`
`void`	`setScriptUI(ScriptUI scriptUI)`
`boolean`	`supportsDb(String type)` No database tables used, so all supported

Methods inherited from class org.parosproxy.paros.extension.ExtensionAdaptor
canUnload, databaseOpen, destroy, getActiveActions, getAddOn, getDependencies, getExtensionMenu, getExtensionView, getI18nPrefix, getMessages, getModel, getName, getOrder, getView, hasView, init, initModel, initView, initXML, isCore, isDepreciated, isEnabled, optionsLoaded, postInstall, setAddOn, setDescription, setEnabled, setI18nPrefix, setMessages, setName, setOrder, start, stop, supportsLowMemory, unload

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.parosproxy.paros.extension.Extension
getURL, getVersion

- Field Detail
  - EXTENSION_ORDER
```
public static final int EXTENSION_ORDER
```
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - ICON
```
@Deprecated
public static final ImageIcon ICON
```
    Deprecated. (2.7.0) Use getScriptIcon() instead.
  - DEFAULT_CHARSET
```
public static final Charset DEFAULT_CHARSET
```
    The Charset used to load/save the scripts from/to the file.
    While the scripts can be loaded with any Charset (defaulting to this one) they are always saved with this Charset.
    
    Since:
    
    2.7.0
    
    See Also:
    
    loadScript(ScriptWrapper), loadScript(ScriptWrapper, Charset), saveScript(ScriptWrapper)
  - SCRIPTS_DIR
```
public static final String SCRIPTS_DIR
```
    See Also:
    
    Constant Field Values
  - TEMPLATES_DIR
```
public static final String TEMPLATES_DIR
```
  - SCRIPT_CONSOLE_HOME_PAGE
```
@Deprecated
protected static final String SCRIPT_CONSOLE_HOME_PAGE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SCRIPT_NAME_ATT
```
protected static final String SCRIPT_NAME_ATT
```
    See Also:
    
    Constant Field Values
  - TYPE_HTTP_SENDER
```
public static final String TYPE_HTTP_SENDER
```
    See Also:
    
    Constant Field Values
  - TYPE_PROXY
```
public static final String TYPE_PROXY
```
    See Also:
    
    Constant Field Values
  - TYPE_STANDALONE
```
public static final String TYPE_STANDALONE
```
    See Also:
    
    Constant Field Values
  - TYPE_TARGETED
```
public static final String TYPE_TARGETED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExtensionScript
```
public ExtensionScript()
```
- Method Detail
  - getUIName
```
public String getUIName()
```
    Description copied from class: ExtensionAdaptor
    
    By default returns the name returned by getName().
    
    Specified by:
    
    getUIName in interface Extension
    
    Overrides:
    
    getUIName in class ExtensionAdaptor
    
    Returns:
    
    the UI name of the extension, never null
    
    See Also:
    
    ExtensionAdaptor.getName()
  - hook
```
public void hook(ExtensionHook extensionHook)
```
    Description copied from interface: Extension
    
    Called during extension's initialisation to allow to add new functionality to core components.
    
    Specified by:
    
    hook in interface Extension
    
    Overrides:
    
    hook in class ExtensionAdaptor
    
    Parameters:
    
    extensionHook - the hook to add the components.
  - getScriptingEngines
```
public List<String> getScriptingEngines()
```
  - registerScriptEngineWrapper
```
public void registerScriptEngineWrapper(ScriptEngineWrapper wrapper)
```
    Registers a new script engine wrapper.
    The templates of the wrapped script engine are loaded, if any.
    The engine is set to existing scripts targeting the given engine.
    
    Parameters:
    
    wrapper - the script engine wrapper that will be added, must not be null
    
    See Also:
    
    removeScriptEngineWrapper(ScriptEngineWrapper), ScriptWrapper.setEngine(ScriptEngineWrapper)
  - hasSameScriptEngine
```
public static boolean hasSameScriptEngine(ScriptWrapper scriptWrapper,
                                          ScriptEngineWrapper engineWrapper)
```
    Tells whether or not the given scriptWrapper has the given engineWrapper.
    If the given scriptWrapper has an engine set it's checked by reference (operator ==), otherwise it's used the engine names.
    
    Parameters:
    
    scriptWrapper - the script wrapper that will be checked
    
    engineWrapper - the engine that will be checked against the engine of the script
    
    Returns:
    
    true if the given script has the given engine, false otherwise.
    
    Since:
    
    2.4.0
    
    See Also:
    
    isSameScriptEngine(String, String, String)
  - isSameScriptEngine
```
public static boolean isSameScriptEngine(String name,
                                         String engineName,
                                         String engineLanguage)
```
    Tells whether or not the given name matches the given engineName and engineLanguage.
    
    Parameters:
    
    name - the name that will be checked against the given engineName and engineLanguage.
    
    engineName - the name of the script engine.
    
    engineLanguage - the language of the script engine.
    
    Returns:
    
    true if the name matches the given engine's name and language, false otherwise.
    
    Since:
    
    2.4.0
    
    See Also:
    
    hasSameScriptEngine(ScriptWrapper, ScriptEngineWrapper)
  - removeScriptEngineWrapper
```
public void removeScriptEngineWrapper(ScriptEngineWrapper wrapper)
```
    Removes the given script engine wrapper.
    The user's templates and scripts associated with the given engine are not removed but its engine is set to null. Default templates are removed.
    The call to this method has no effect if the given type is not registered.
    
    Parameters:
    
    wrapper - the script engine wrapper that will be removed, must not be null
    
    Since:
    
    2.4.0
    
    See Also:
    
    registerScriptEngineWrapper(ScriptEngineWrapper), ScriptWrapper.setEngine(ScriptEngineWrapper)
  - getEngineWrapper
```
public ScriptEngineWrapper getEngineWrapper(String name)
```
  - getEngineNameForExtension
```
public String getEngineNameForExtension(String ext)
```
  - getScriptParam
```
protected ScriptParam getScriptParam()
```
  - getTreeModel
```
public ScriptTreeModel getTreeModel()
```
  - registerScriptType
```
public void registerScriptType(ScriptType type)
```
    Registers a new type of script.
    The script is added to the tree of scripts and its scripts/templates loaded, if any.
    
    Parameters:
    
    type - the new type of script
    
    Throws:
    
    InvalidParameterException - if a script type with same name is already registered
    
    See Also:
    
    removeScriptType(ScriptType)
  - removeScripType
```
@Deprecated
public void removeScripType(ScriptType type)
```
    Deprecated. (2.9.0) Use removeScriptType(ScriptType) instead.
    
    Removes the given script type.
    The templates and scripts associated with the given type are also removed, if any.
    The call to this method has no effect if the given type is not registered.
    
    Parameters:
    
    type - the script type that will be removed
    
    Since:
    
    2.4.0
    
    See Also:
    
    registerScriptType(ScriptType)
  - removeScriptType
```
public void removeScriptType(ScriptType type)
```
    Removes the given script type.
    The templates and scripts associated with the given type are also removed, if any.
    The call to this method has no effect if the given type is not registered.
    
    Parameters:
    
    type - the script type that will be removed
    
    Since:
    
    2.9.0
    
    See Also:
    
    registerScriptType(ScriptType)
  - getScriptType
```
public ScriptType getScriptType(String name)
```
  - getScriptTypes
```
public Collection<ScriptType> getScriptTypes()
```
  - getAuthor
```
public String getAuthor()
```
    Description copied from interface: Extension
    
    Gets the author of the extension.
    Since 2.9.0 defaults to the author of the add-on, if set, otherwise an empty string.
    
    Specified by:
    
    getAuthor in interface Extension
    
    Returns:
    
    the author of the extension, might be null.
  - getDescription
```
public String getDescription()
```
    Description copied from interface: Extension
    
    Returns the description of the extension, to be shown in UI components. The description must be internationalised.
    
    Specified by:
    
    getDescription in interface Extension
    
    Overrides:
    
    getDescription in class ExtensionAdaptor
    
    Returns:
    
    the description of the extension, never null
  - getScript
```
public ScriptWrapper getScript(String name)
```
  - addScript
```
public ScriptNode addScript(ScriptWrapper script)
```
  - addScript
```
public ScriptNode addScript(ScriptWrapper script,
                            boolean display)
```
  - saveScript
```
public void saveScript(ScriptWrapper script)
                throws IOException
```
    Throws:
    
    IOException
  - removeScript
```
public void removeScript(ScriptWrapper script)
```
  - removeTemplate
```
public void removeTemplate(ScriptWrapper template)
```
  - addTemplate
```
public ScriptNode addTemplate(ScriptWrapper template)
```
  - addTemplate
```
public ScriptNode addTemplate(ScriptWrapper template,
                              boolean display)
```
  - postInit
```
public void postInit()
```
    Description copied from interface: Extension
    
    Implement this method to perform tasks after all extensions/add-ons have been initialised.
    
    Specified by:
    
    postInit in interface Extension
    
    Overrides:
    
    postInit in class ExtensionAdaptor
    
    See Also:
    
    Extension.postInstall()
  - addScriptsFromDir
```
public int addScriptsFromDir(File dir)
```
    Adds the scripts from the given directory and starts tracking it.
    The directory will be tracked to add or remove its scripts when a new script engine/type is added or removed.
    The scripts are expected to be under directories of the corresponding script type, for example:
```
 (dir specified)
 ├── active
 │   ├── gof_lite.js
 │   ├── TestInsecureHTTPVerbs.py
 │   └── User defined attacks.js
 ├── extender
 │   └── HTTP Message Logger.js
 ├── httpfuzzerprocessor
 │   ├── add_msgs_sites_tree.js
 │   ├── http_status_code_filter.py
 │   └── showDifferences.js
 ├── httpsender
 │   ├── add_header_request.py
 │   └── Capture and Replace Anti CSRF Token.js
 └── variant
     └── JsonStrings.js
 
```
    where active, extender, httpfuzzerprocessor, httpsender, and variant are the script types.
    Parameters:
    
    dir - the directory from where to add the scripts.
    
    Returns:
    
    the number of scripts added.
    
    Since:
    
    2.4.1
    
    See Also:
    
    removeScriptsFromDir(File)
  - removeScriptsFromDir
```
public int removeScriptsFromDir(File dir)
```
    Removes the scripts added from the given directory and stops tracking it.
    The number of scripts removed might be different than the number of scripts initially added, as a script engine or type might have been added or removed in the meantime.
    
    Parameters:
    
    dir - the directory previously added.
    
    Returns:
    
    the number of scripts removed.
    
    Since:
    
    2.4.1
    
    See Also:
    
    addScriptsFromDir(File)
  - getScriptCount
```
public int getScriptCount(File dir)
```
    Gets the numbers of scripts for the given directory for the currently registered script engines and types.
    
    Parameters:
    
    dir - the directory to check.
    
    Returns:
    
    the number of scripts.
    
    Since:
    
    2.4.1
  - loadScript
```
public ScriptWrapper loadScript(ScriptWrapper script)
                         throws IOException
```
    Loads the script from the file, using DEFAULT_CHARSET.
    If the file contains invalid byte sequences (for DEFAULT_CHARSET) it will be loaded again using the (JVM) default charset, to load scripts saved with older ZAP versions (which relied on default charset).
    
    Parameters:
    
    script - the ScriptWrapper to be loaded (read script from file).
    
    Returns:
    
    the ScriptWrapper with the actual script read from the file.
    
    Throws:
    
    IOException - if an error occurred while reading the script from the file.
    
    IllegalArgumentException - if the script is null.
    
    See Also:
    
    loadScript(ScriptWrapper, Charset)
  - loadScript
```
public ScriptWrapper loadScript(ScriptWrapper script,
                                Charset charset)
                         throws IOException
```
    Loads the script from the file, using the given charset.
    
    Parameters:
    
    script - the ScriptWrapper to be loaded (read script from file).
    
    charset - the charset to use when reading the script from the file.
    
    Returns:
    
    the ScriptWrapper with the actual script read from the file.
    
    Throws:
    
    IOException - if an error occurred while reading the script from the file.
    
    IllegalArgumentException - if the script or the charset is null.
    
    Since:
    
    2.7.0
    
    See Also:
    
    loadScript(ScriptWrapper)
  - getScripts
```
public List<ScriptWrapper> getScripts(String type)
```
  - getScripts
```
public List<ScriptWrapper> getScripts(ScriptType type)
```
  - getTemplates
```
public List<ScriptWrapper> getTemplates(ScriptType type)
```
  - invokeScript
```
public Invocable invokeScript(ScriptWrapper script)
                       throws ScriptException
```
    Invokes the given script, synchronously, handling any Exception thrown during the invocation.
    The context class loader of caller thread is replaced with the class loader AddOnLoader to allow the script to access classes of add-ons. If this behaviour is not desired call the method invokeScriptWithOutAddOnLoader instead.
    
    Parameters:
    
    script - the script that will be invoked
    
    Returns:
    
    an Invocable for the script, or null if none.
    
    Throws:
    
    ScriptException - if the engine of the given script was not found.
    
    See Also:
    
    invokeScriptWithOutAddOnLoader(ScriptWrapper), Invocable
  - invokeScriptWithOutAddOnLoader
```
public Invocable invokeScriptWithOutAddOnLoader(ScriptWrapper script)
                                         throws ScriptException
```
    Invokes the given script, synchronously, handling any Exception thrown during the invocation.
    
    Parameters:
    
    script - the script that will be invoked/evaluated
    
    Returns:
    
    an Invocable for the script, or null if none.
    
    Throws:
    
    ScriptException - if the engine of the given script was not found.
    
    See Also:
    
    invokeScript(ScriptWrapper), Invocable
  - handleScriptException
```
public void handleScriptException(ScriptWrapper script,
                                  Exception exception)
```
    Handles exceptions thrown by scripts.
    The given exception (if of type ScriptException the cause will be used instead) will be written to the writer(s) associated with the given script, moreover the script will be disabled and flagged that has an error.
    
    Parameters:
    
    script - the script that resulted in an exception, must not be null
    
    exception - the exception thrown, must not be null
    
    Since:
    
    2.5.0
    
    See Also:
    
    setEnabled(ScriptWrapper, boolean), setError(ScriptWrapper, Exception), handleFailedScriptInterface(ScriptWrapper, String), handleScriptError(ScriptWrapper, String), ScriptException
  - handleScriptError
```
public void handleScriptError(ScriptWrapper script,
                              String error)
```
    Handles errors caused by scripts.
    The given error will be written to the writer(s) associated with the given script, moreover the script will be disabled and flagged that has an error.
    
    Parameters:
    
    script - the script that caused the error, must not be null.
    
    error - the error caused by the script, must not be null.
    
    Since:
    
    2.9.0
    
    See Also:
    
    setEnabled(ScriptWrapper, boolean), setError(ScriptWrapper, String), handleScriptException(ScriptWrapper, Exception)
  - invokeTargetedScript
```
public void invokeTargetedScript(ScriptWrapper script,
                                 HttpMessage msg)
```
    Invokes the given script, synchronously, as a TargetedScript, handling any Exception thrown during the invocation.
    The context class loader of caller thread is replaced with the class loader AddOnLoader to allow the script to access classes of add-ons.
    
    Parameters:
    
    script - the script to invoke.
    
    msg - the HTTP message to process.
    
    Since:
    
    2.2.0
    
    See Also:
    
    getInterface(ScriptWrapper, Class)
  - handleFailedScriptInterface
```
public void handleFailedScriptInterface(ScriptWrapper script,
                                        String errorMessage)
```
    Handles a failed attempt to convert a script into an interface.
    The given errorMessage will be written to the writer(s) associated with the given script, moreover it will be disabled and flagged that has an error.
    
    Parameters:
    
    script - the script that resulted in an exception, must not be null
    
    errorMessage - the message that will be written to the writer(s)
    
    Since:
    
    2.5.0
    
    See Also:
    
    setEnabled(ScriptWrapper, boolean), setError(ScriptWrapper, Exception), handleScriptException(ScriptWrapper, Exception)
  - invokeProxyScript
```
public boolean invokeProxyScript(ScriptWrapper script,
                                 HttpMessage msg,
                                 boolean request)
```
    Invokes the given script, synchronously, as a ProxyScript, handling any Exception thrown during the invocation.
    The context class loader of caller thread is replaced with the class loader AddOnLoader to allow the script to access classes of add-ons.
    
    Parameters:
    
    script - the script to invoke.
    
    msg - the HTTP message being proxied.
    
    request - true if processing the request, false otherwise.
    
    Returns:
    
    true if the request should be forward to the server, false otherwise.
    
    Since:
    
    2.2.0
    
    See Also:
    
    getInterface(ScriptWrapper, Class)
  - invokeSenderScript
```
public void invokeSenderScript(ScriptWrapper script,
                               HttpMessage msg,
                               int initiator,
                               HttpSender sender,
                               boolean request)
```
    Invokes the given script, synchronously, as a HttpSenderScript, handling any Exception thrown during the invocation.
    The context class loader of caller thread is replaced with the class loader AddOnLoader to allow the script to access classes of add-ons.
    
    Parameters:
    
    script - the script to invoke.
    
    msg - the HTTP message being sent/received.
    
    initiator - the initiator of the request.
    
    sender - the sender of the given HttpMessage.
    
    request - true if processing the request, false otherwise.
    
    Since:
    
    2.4.1
    
    See Also:
    
    getInterface(ScriptWrapper, Class)
  - setChanged
```
public void setChanged(ScriptWrapper script,
                       boolean changed)
```
  - setEnabled
```
public void setEnabled(ScriptWrapper script,
                       boolean enabled)
```
  - setError
```
public void setError(ScriptWrapper script,
                     String details)
```
  - setError
```
public void setError(ScriptWrapper script,
                     Exception e)
```
  - addListener
```
public void addListener(ScriptEventListener listener)
```
  - removeListener
```
public void removeListener(ScriptEventListener listener)
```
  - addWriter
```
public void addWriter(Writer writer)
```
    Adds the given writer.
    It will be written to each time a script writes some output.
    
    Parameters:
    
    writer - the writer to add.
    
    See Also:
    
    removeWriter(Writer), addScriptOutputListener(ScriptOutputListener)
  - removeWriter
```
public void removeWriter(Writer writer)
```
    Removes the given writer.
    
    Parameters:
    
    writer - the writer to remove.
    
    See Also:
    
    addWriter(Writer)
  - addScriptOutputListener
```
public void addScriptOutputListener(ScriptOutputListener listener)
```
    Adds the given script output listener.
    
    Parameters:
    
    listener - the listener to add.
    
    Throws:
    
    NullPointerException - if the given listener is null.
    
    Since:
    
    2.8.0
    
    See Also:
    
    removeScriptOutputListener(ScriptOutputListener)
  - removeScriptOutputListener
```
public void removeScriptOutputListener(ScriptOutputListener listener)
```
    Removes the given script output listener.
    
    Parameters:
    
    listener - the listener to remove.
    
    Throws:
    
    NullPointerException - if the given listener is null.
    
    Since:
    
    2.8.0
    
    See Also:
    
    addScriptOutputListener(ScriptOutputListener)
  - getScriptUI
```
public ScriptUI getScriptUI()
```
  - setScriptUI
```
public void setScriptUI(ScriptUI scriptUI)
```
  - removeScriptUI
```
public void removeScriptUI()
```
  - createScriptsCache
```
public <T> ScriptsCache<T> createScriptsCache(ScriptsCache.Configuration<T> config)
```
    Creates a scripts cache.
    
    Type Parameters:
    
    T - the target interface.
    
    Parameters:
    
    config - the cache configuration
    
    Returns:
    
    the scripts cache.
    
    Since:
    
    2.10.0
  - getInterface
```
public <T> T getInterface(ScriptWrapper script,
                          Class<T> class1)
                   throws ScriptException,
                          IOException
```
    Gets the interface class1 from the given script. Might return null if the script does not implement the interface.
    First tries to get the interface directly from the script by calling the method ScriptWrapper.getInterface(Class), if it returns null the interface will be extracted from the script after invoking it, using the method Invocable.getInterface(Class).
    The context class loader of caller thread is replaced with the class loader AddOnLoader to allow the script to access classes of add-ons. If this behaviour is not desired call the method getInterfaceWithOutAddOnLoader( instead.
    
    Parameters:
    
    script - the script that will be invoked
    
    class1 - the interface that will be obtained from the script
    
    Returns:
    
    the interface implemented by the script, or null if the script does not implement the interface.
    
    Throws:
    
    ScriptException - if the engine of the given script was not found.
    
    IOException - if an error occurred while obtaining the interface directly from the script ( ScriptWrapper.getInterface(Class))
    
    See Also:
    
    getInterfaceWithOutAddOnLoader(ScriptWrapper, Class), ScriptWrapper.getInterface(Class), Invocable.getInterface(Class)
  - getInterfaceWithOutAddOnLoader
```
public <T> T getInterfaceWithOutAddOnLoader(ScriptWrapper script,
                                            Class<T> clazz)
                                     throws ScriptException,
                                            IOException
```
    Gets the interface clazz from the given script. Might return null if the script does not implement the interface.
    First tries to get the interface directly from the script by calling the method ScriptWrapper.getInterface(Class), if it returns null the interface will be extracted from the script after invoking it, using the method Invocable.getInterface(Class).
    
    Parameters:
    
    script - the script that will be invoked
    
    clazz - the interface that will be obtained from the script
    
    Returns:
    
    the interface implemented by the script, or null if the script does not implement the interface.
    
    Throws:
    
    ScriptException - if the engine of the given script was not found.
    
    IOException - if an error occurred while obtaining the interface directly from the script ( ScriptWrapper.getInterface(Class))
    
    See Also:
    
    getInterface(ScriptWrapper, Class), ScriptWrapper.getInterface(Class), Invocable.getInterface(Class)
  - getUnsavedResources
```
public List<String> getUnsavedResources()
```
    Description copied from interface: Extension
    
    Extensions should return the user friendly names of any unsaved resources - if there are any the user will be given the option not to exit ZAP or, if the extension is bundled in an add-on that's being updated or uninstalled, not to continue with the changes.
    
    Specified by:
    
    getUnsavedResources in interface Extension
    
    Overrides:
    
    getUnsavedResources in class ExtensionAdaptor
    
    Returns:
    
    a List containing the unsaved resources or null if none
    
    See Also:
    
    Extension.getActiveActions()
  - execute
```
public void execute(CommandLineArgument[] args)
```
    Description copied from interface: CommandLineListener
    
    execute the command line using the argument provided.
    
    Specified by:
    
    execute in interface CommandLineListener
    
    Parameters:
    
    args - the command line arguments
  - handleFile
```
public boolean handleFile(File file)
```
    Description copied from interface: CommandLineListener
    
    Handle the specified file (in whatever way is appropriate). This will only be called for files specified on the command line without switches and which match one of the extensions returned by getHandledExtensions()
    
    Specified by:
    
    handleFile in interface CommandLineListener
    
    Parameters:
    
    file - the file provided through the command line
    
    Returns:
    
    true if the listener handled the file, false otherwise
  - getHandledExtensions
```
public List<String> getHandledExtensions()
```
    Description copied from interface: CommandLineListener
    
    Get the list of extensions this listener can handle
    
    Specified by:
    
    getHandledExtensions in interface CommandLineListener
    
    Returns:
    
    a List with the handled extensions
  - supportsDb
```
public boolean supportsDb(String type)
```
    No database tables used, so all supported
    
    Specified by:
    
    supportsDb in interface Extension
    
    Overrides:
    
    supportsDb in class ExtensionAdaptor
    
    Parameters:
    
    type - the db type
    
    Returns:
    
    true if the specified db type is supported by the extension (or if it doesn't use any db)
    
    See Also:
    
    Database.getType()
  - getScriptIcon
```
public static ImageIcon getScriptIcon()
```
    Gets the script icon.
    Should be called/used only when in view mode.
    
    Returns:
    
    the script icon, never null.
    
    Since:
    
    2.7.0
  - recordScriptCalledStats
```
public static void recordScriptCalledStats(ScriptWrapper sw)
```
  - recordScriptFailedStats
```
public static void recordScriptFailedStats(ScriptWrapper sw)
```

Class ExtensionScript

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.parosproxy.paros.extension.ExtensionAdaptor

Methods inherited from class java.lang.Object

Methods inherited from interface org.parosproxy.paros.extension.Extension

Field Detail

EXTENSION_ORDER

NAME

ICON

DEFAULT_CHARSET

SCRIPTS_DIR

TEMPLATES_DIR

SCRIPT_CONSOLE_HOME_PAGE

SCRIPT_NAME_ATT

TYPE_HTTP_SENDER

TYPE_PROXY

TYPE_STANDALONE

TYPE_TARGETED

Constructor Detail

ExtensionScript

Method Detail

getUIName

hook

getScriptingEngines

registerScriptEngineWrapper

hasSameScriptEngine

isSameScriptEngine

removeScriptEngineWrapper

getEngineWrapper

getEngineNameForExtension

getScriptParam

getTreeModel

registerScriptType

removeScripType

removeScriptType

getScriptType

getScriptTypes

getAuthor

getDescription

getScript

addScript

addScript

saveScript

removeScript

removeTemplate

addTemplate

addTemplate

postInit

addScriptsFromDir

removeScriptsFromDir

getScriptCount

loadScript

loadScript

getScripts

getScripts

getTemplates

invokeScript

invokeScriptWithOutAddOnLoader

handleScriptException

handleScriptError

invokeTargetedScript

handleFailedScriptInterface

invokeProxyScript

invokeSenderScript

setChanged

setEnabled

setError

setError

addListener

removeListener

addWriter

removeWriter

addScriptOutputListener

removeScriptOutputListener

getScriptUI

setScriptUI

removeScriptUI

createScriptsCache