Package 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	Description
Script(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	clearGlobalCustomVar(java.lang.String varkey)	Clears a global custom variable.
ApiResponse	clearGlobalVar(java.lang.String varkey)	Clears the global variable with the given key.
ApiResponse	clearGlobalVars()	Clears the global variables.
ApiResponse	clearScriptCustomVar(java.lang.String scriptname, java.lang.String varkey)	Clears a script custom variable.
ApiResponse	clearScriptVar(java.lang.String scriptname, java.lang.String varkey)	Clears the variable with the given key of the given script.
ApiResponse	clearScriptVars(java.lang.String scriptname)	Clears the variables of the given script.
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	globalCustomVar(java.lang.String varkey)	Gets the value (string representation) of a global custom variable.
ApiResponse	globalCustomVars()	Gets all the global custom variables (key/value pairs, the value is the string representation).
ApiResponse	globalVar(java.lang.String varkey)	Gets the value of the global variable with the given key.
ApiResponse	globalVars()	Gets all the global variables (key/value pairs).
ApiResponse	listEngines()	Lists the script engines available
ApiResponse	listScripts()	Lists the scripts available, with its engine, name, description, type and error state.
ApiResponse	listTypes()	Lists the script types available.
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 given name
ApiResponse	scriptCustomVar(java.lang.String scriptname, java.lang.String varkey)	Gets the value (string representation) of a custom variable.
ApiResponse	scriptCustomVars(java.lang.String scriptname)	Gets all the custom variables (key/value pairs, the value is the string representation) of a script.
ApiResponse	scriptVar(java.lang.String scriptname, java.lang.String varkey)	Gets the value of the variable with the given key for the given script.
ApiResponse	scriptVars(java.lang.String scriptname)	Gets all the variables (key/value pairs) of the given script.
ApiResponse	setGlobalVar(java.lang.String varkey, java.lang.String varvalue)	Sets the value of the global variable with the given key.
ApiResponse	setScriptVar(java.lang.String scriptname, java.lang.String varkey, java.lang.String varvalue)	Sets the value of the variable with the given key of the given script.

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

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

listTypes

public ApiResponse listTypes()
                      throws ClientApiException

Lists the script types available.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

listScripts

public ApiResponse listScripts()
                        throws ClientApiException

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

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

globalVar

public ApiResponse globalVar(java.lang.String varkey)
                      throws ClientApiException

Gets the value of the global variable with the given key. Returns an API error (DOES_NOT_EXIST) if no value was previously set.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

globalCustomVar

public ApiResponse globalCustomVar(java.lang.String varkey)
                            throws ClientApiException

Gets the value (string representation) of a global custom variable. Returns an API error (DOES_NOT_EXIST) if no value was previously set.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

globalVars

public ApiResponse globalVars()
                       throws ClientApiException

Gets all the global variables (key/value pairs).

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

globalCustomVars

public ApiResponse globalCustomVars()
                             throws ClientApiException

Gets all the global custom variables (key/value pairs, the value is the string representation).

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

scriptVar

public ApiResponse scriptVar(java.lang.String scriptname,
                             java.lang.String varkey)
                      throws ClientApiException

Gets the value of the variable with the given key for the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists or if no value was previously set.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

scriptCustomVar

public ApiResponse scriptCustomVar(java.lang.String scriptname,
                                   java.lang.String varkey)
                            throws ClientApiException

Gets the value (string representation) of a custom variable. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists or if no value was previously set.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

scriptVars

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

Gets all the variables (key/value pairs) of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

scriptCustomVars

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

Gets all the custom variables (key/value pairs, the value is the string representation) of a script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

enable

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

Enables the script with the given name

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

disable

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

Disables the script with the given name

This component is optional and therefore the API will only work if it is installed

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).

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

remove

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

Removes the script with the given name

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

runStandAloneScript

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

Runs the stand alone script with the given name

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

clearGlobalVar

public ApiResponse clearGlobalVar(java.lang.String varkey)
                           throws ClientApiException

Clears the global variable with the given key.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

clearGlobalCustomVar

public ApiResponse clearGlobalCustomVar(java.lang.String varkey)
                                 throws ClientApiException

Clears a global custom variable.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

clearGlobalVars

public ApiResponse clearGlobalVars()
                            throws ClientApiException

Clears the global variables.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

clearScriptVar

public ApiResponse clearScriptVar(java.lang.String scriptname,
                                  java.lang.String varkey)
                           throws ClientApiException

Clears the variable with the given key of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

clearScriptCustomVar

public ApiResponse clearScriptCustomVar(java.lang.String scriptname,
                                        java.lang.String varkey)
                                 throws ClientApiException

Clears a script custom variable.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

clearScriptVars

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

Clears the variables of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setScriptVar

public ApiResponse setScriptVar(java.lang.String scriptname,
                                java.lang.String varkey,
                                java.lang.String varvalue)
                         throws ClientApiException

Sets the value of the variable with the given key of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setGlobalVar

public ApiResponse setGlobalVar(java.lang.String varkey,
                                java.lang.String varvalue)
                         throws ClientApiException

Sets the value of the global variable with the given key.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException