org.zaproxy.zap.extension.script

Class ScriptVars

java.lang.Object

org.zaproxy.zap.extension.script.ScriptVars

public final class ScriptVars
extends Object

Manages global and script variables.

The global variables are meant to be accessible by all scripts and the script variables are meant to be accessible by just a given script (identified by its name).

Note: While it's possible to a script to access the variables of another script that usage is discouraged.

The keys and (string) values of the variables have restrictions on its character length:

• Key: ;
• Value: ;

There's a maximum number of global/script variables:

• Global: ;
• Script: ;

Since:

2.4.0

Method Summary

Modifier and Type	Method and Description
static void	clear() Clears all variables, global and script.
static void	clearGlobalVars() Clears the global variables.
static void	clearScriptVars(String scriptName) Clears the variables of the script with the given name.
static Object	getGlobalCustomVar(String key) Gets a global custom variable.
static Map<String,Object>	getGlobalCustomVars() Gets an unmodifiable map, variable key to value, containing the global custom variables.
static String	getGlobalVar(String key) Gets a global variable.
static Map<String,String>	getGlobalVars() Gets an unmodifiable map, variable key to value, containing the global variables.
static Object	getScriptCustomVar(ScriptContext context, String key) Gets a script custom variable.
static Object	getScriptCustomVar(String scriptName, String key) Gets a custom variable from the script with the given name.
static Map<String,Object>	getScriptCustomVars(String scriptName) Gets an unmodifiable map, variable key to value, containing the custom variables of the script with the given name.
static String	getScriptVar(ScriptContext context, String key) Gets a script variable.
static String	getScriptVar(String scriptName, String key) Gets a variable from the script with the given name.
static Map<String,String>	getScriptVars(String scriptName) Gets an unmodifiable map, variable key to value, containing the variables of the script with the given name.
static void	setGlobalCustomVar(String key, Object value) Sets or removes a global custom variable.
static void	setGlobalVar(String key, String value) Sets or removes a global variable.
static void	setScriptCustomVar(ScriptContext context, String key, Object value) Sets or removes a script custom variable.
static void	setScriptCustomVar(String scriptName, String key, Object value) Sets or removes a script custom variable.
static void	setScriptVar(ScriptContext context, String key, String value) Sets or removes a script variable.
static void	setScriptVar(String scriptName, String key, String value) Sets or removes a script variable.

Methods inherited from class java.lang.Object

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

Method Detail

setGlobalVar

public static void setGlobalVar(String key,
                                String value)

Sets or removes a global variable.

The variable is removed when the value is null.

Parameters:

key - the key of the variable.

value - the value of the variable.

Throws:

IllegalArgumentException - if one of the following conditions is met:

• The key is null or its length is higher than the maximum allowed ();
• The value's length is higher than the maximum allowed ();
• The number of global variables is higher than the maximum allowed ();

getGlobalVar

public static String getGlobalVar(String key)

Gets a global variable.

Parameters:

key - the key of the variable.

Returns:

the value of the variable, might be null if no value was previously set.

getGlobalVars

public static Map<String,String> getGlobalVars()

Gets an unmodifiable map, variable key to value, containing the global variables.

Iterations should be done in a synchronised block using the returned map.

Returns:

an unmodifiable map containing the global variables, never null.

Since:

2.8.0

setGlobalCustomVar

public static void setGlobalCustomVar(String key,
                                      Object value)

Sets or removes a global custom variable.

The variable is removed when the value is null.

Parameters:

key - the key of the variable.

value - the value of the variable.

Throws:

IllegalArgumentException - if one of the following conditions is met:

• The key is null or its length is higher than the maximum allowed ();
• The number of global variables is higher than the maximum allowed ();

Since:

2.9.0

getGlobalCustomVar

public static Object getGlobalCustomVar(String key)

Gets a global custom variable.

Parameters:

key - the key of the variable.

Returns:

the value of the variable, might be null if no value was previously set.

Since:

2.9.0

getGlobalCustomVars

public static Map<String,Object> getGlobalCustomVars()

Gets an unmodifiable map, variable key to value, containing the global custom variables.

Iterations should be done in a synchronised block using the returned map.

Returns:

an unmodifiable map containing the global variables, never null.

Since:

2.9.0

setScriptVar

public static void setScriptVar(ScriptContext context,
                                String key,
                                String value)

Sets or removes a script variable.

The variable is removed when the value is null.

Parameters:

context - the context of the script.

key - the key of the variable.

value - the value of the variable.

Throws:

IllegalArgumentException - if one of the following conditions is met:

• The context is null or it does not contain the name of the script;
• The key is null or its length is higher than the maximum allowed ();
• The value's length is higher than the maximum allowed ();
• The number of script variables is higher than the maximum allowed ();

setScriptVar

public static void setScriptVar(String scriptName,
                                String key,
                                String value)

Sets or removes a script variable.

The variable is removed when the value is null.

Parameters:

scriptName - the name of the script.

key - the key of the variable.

value - the value of the variable.

Throws:

IllegalArgumentException - if one of the following conditions is met:

• The scriptName is null;
• The key is null or its length is higher than the maximum allowed ();
• The value's length is higher than the maximum allowed ();
• The number of script variables is higher than the maximum allowed ();

Since:

2.8.0

getScriptVar

public static String getScriptVar(ScriptContext context,
                                  String key)

Gets a script variable.

Parameters:

context - the context of the script.

key - the key of the variable.

Returns:

the value of the variable, might be null if no value was previously set.

Throws:

IllegalArgumentException - if the context is null or it does not contain the name of the script.

getScriptVar

public static String getScriptVar(String scriptName,
                                  String key)

Gets a variable from the script with the given name.

Parameters:

scriptName - the name of the script.

key - the key of the variable.

Returns:

the value of the variable, might be null if no value was previously set.

Throws:

IllegalArgumentException - if the scriptName is null.

Since:

2.8.0

getScriptVars

public static Map<String,String> getScriptVars(String scriptName)

Gets an unmodifiable map, variable key to value, containing the variables of the script with the given name.

Iterations should be done in a synchronised block using the returned map.

Parameters:

scriptName - the name of the script.

Returns:

an unmodifiable map containing the script variables, never null.

Since:

2.8.0

setScriptCustomVar

public static void setScriptCustomVar(ScriptContext context,
                                      String key,
                                      Object value)

Sets or removes a script custom variable.

The variable is removed when the value is null.

Parameters:

context - the context of the script.

key - the key of the variable.

value - the value of the variable.

Throws:

IllegalArgumentException - if one of the following conditions is met:

• The context is null or it does not contain the name of the script;
• The key is null or its length is higher than the maximum allowed ();
• The number of script variables is higher than the maximum allowed ();

Since:

2.9.0

setScriptCustomVar

public static void setScriptCustomVar(String scriptName,
                                      String key,
                                      Object value)

Sets or removes a script custom variable.

The variable is removed when the value is null.

Parameters:

scriptName - the name of the script.

key - the key of the variable.

value - the value of the variable.

Throws:

IllegalArgumentException - if one of the following conditions is met:

• The scriptName is null;
• The key is null or its length is higher than the maximum allowed ();
• The number of script variables is higher than the maximum allowed ();

Since:

2.9.0

getScriptCustomVar

public static Object getScriptCustomVar(ScriptContext context,
                                        String key)

Gets a script custom variable.

Parameters:

context - the context of the script.

key - the key of the variable.

Returns:

the value of the variable, might be null if no value was previously set.

Throws:

IllegalArgumentException - if the context is null or it does not contain the name of the script.

Since:

2.9.0

getScriptCustomVar

public static Object getScriptCustomVar(String scriptName,
                                        String key)

Gets a custom variable from the script with the given name.

Parameters:

scriptName - the name of the script.

key - the key of the variable.

Returns:

the value of the variable, might be null if no value was previously set.

Throws:

IllegalArgumentException - if the scriptName is null.

Since:

2.9.0

getScriptCustomVars

public static Map<String,Object> getScriptCustomVars(String scriptName)

Gets an unmodifiable map, variable key to value, containing the custom variables of the script with the given name.

Iterations should be done in a synchronised block using the returned map.

Parameters:

scriptName - the name of the script.

Returns:

an unmodifiable map containing the script variables, never null.

Since:

2.9.0

clearGlobalVars

public static void clearGlobalVars()

Clears the global variables.

Since:

2.8.0

See Also:

clear(), clearScriptVars(String)

clearScriptVars

public static void clearScriptVars(String scriptName)

Clears the variables of the script with the given name.

Parameters:

scriptName - the name of the script.

Since:

2.8.0

See Also:

clear(), clearGlobalVars()

clear

public static void clear()

Clears all variables, global and script.

Since:

2.8.0

See Also:

clearGlobalVars(), clearScriptVars(String)