org.zaproxy.clientapi.gen

Class Script

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.ScriptDeprecated

org.zaproxy.clientapi.gen.Script

public class Script
extends ScriptDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor and Description
Script(ClientApi api)

Method Summary

Modifier and Type	Method and Description
ApiResponse	disable(java.lang.String scriptname) Disables the script with the given name
ApiResponse	enable(java.lang.String scriptname) Enables the script with the given name
ApiResponse	listEngines() Lists the script engines available
ApiResponse	listScripts() Lists the scripts available, with its engine, name, description, type and error state.
ApiResponse	load(java.lang.String scriptname, java.lang.String scripttype, java.lang.String scriptengine, java.lang.String filename, java.lang.String scriptdescription, java.nio.charset.Charset charset) Loads a script into ZAP from the given local file, with the given name, type and engine, optionally with a description, and a charset name to read the script (the charset name is required if the script is not in UTF-8, for example, in ISO-8859-1).
ApiResponse	remove(java.lang.String scriptname) Removes the script with the given name
ApiResponse	runStandAloneScript(java.lang.String scriptname) Runs the stand alone script with the give name

Methods inherited from class org.zaproxy.clientapi.gen.deprecated.ScriptDeprecated

disable, enable, load, load, remove, runStandAloneScript

Methods inherited from class java.lang.Object

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

Constructor Detail

Script

public Script(ClientApi api)

Method Detail

listEngines

public ApiResponse listEngines()
                        throws ClientApiException

Lists the script engines available

Throws:

ClientApiException

listScripts

public ApiResponse listScripts()
                        throws ClientApiException

Lists the scripts available, with its engine, name, description, type and error state.

Throws:

ClientApiException

enable

public ApiResponse enable(java.lang.String scriptname)
                   throws ClientApiException

Enables the script with the given name

Throws:

ClientApiException

disable

public ApiResponse disable(java.lang.String scriptname)
                    throws ClientApiException

Disables the script with the given name

Throws:

ClientApiException

load

public ApiResponse load(java.lang.String scriptname,
                        java.lang.String scripttype,
                        java.lang.String scriptengine,
                        java.lang.String filename,
                        java.lang.String scriptdescription,
                        java.nio.charset.Charset charset)
                 throws ClientApiException

Loads a script into ZAP from the given local file, with the given name, type and engine, optionally with a description, and a charset name to read the script (the charset name is required if the script is not in UTF-8, for example, in ISO-8859-1).

Throws:

ClientApiException

remove

public ApiResponse remove(java.lang.String scriptname)
                   throws ClientApiException

Removes the script with the given name

Throws:

ClientApiException

runStandAloneScript

public ApiResponse runStandAloneScript(java.lang.String scriptname)
                                throws ClientApiException

Runs the stand alone script with the give name

Throws:

ClientApiException