org.zaproxy.zap.extension.script

Class ScriptWrapper

java.lang.Object

org.zaproxy.zap.extension.script.ScriptWrapper

public class ScriptWrapper
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScriptWrapper()
	ScriptWrapper(String name, String description, ScriptEngineWrapper engine, ScriptType type)
	ScriptWrapper(String name, String description, ScriptEngineWrapper engine, ScriptType type, boolean enabled, File file)
	ScriptWrapper(String name, String description, String engineName, ScriptType type, boolean enabled, File file)
protected	ScriptWrapper(String name, String description, String engineName, String typeName, boolean enabled, File file)

Method Summary

Modifier and Type	Method and Description
String	getContents()
String	getDescription()
ScriptEngineWrapper	getEngine() Gets the script engine wrapper.
String	getEngineName()
File	getFile()
<T> T	getInterface(Class<T> class1)
String	getLastErrorDetails()
Exception	getLastException()
String	getLastOutput()
String	getName()
ScriptType	getType()
String	getTypeName()
Writer	getWriter() Gets the writer which will be written to every time this script runs (if any)
boolean	hasChangedOnDisk() Returns true if the script has changed on disk since it was loaded into this class
boolean	isChanged()
boolean	isEnabled()
boolean	isError()
boolean	isLoadOnStart()
boolean	isRunableStandalone()
void	reloadScript() Reloads the script.
void	setChanged(boolean changed)
void	setContents(String contents)
void	setDescription(String description)
void	setEnabled(boolean enabled) Sets if this script is enabled.
void	setEngine(ScriptEngineWrapper engine)
void	setEngineName(String engineName)
void	setError(boolean error)
void	setFile(File file)
void	setLastErrorDetails(String lastErrorDetails)
void	setLastException(Exception lastException)
void	setLastOutput(String lastOutput)
void	setLoadOnStart(boolean loadOnStart)
void	setName(String name)
void	setType(ScriptType type)
void	setWriter(Writer writer) Set a writer which will be written to every time this script runs

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptWrapper

public ScriptWrapper()

ScriptWrapper

public ScriptWrapper(String name,
                     String description,
                     ScriptEngineWrapper engine,
                     ScriptType type)

ScriptWrapper

public ScriptWrapper(String name,
                     String description,
                     String engineName,
                     ScriptType type,
                     boolean enabled,
                     File file)

ScriptWrapper

public ScriptWrapper(String name,
                     String description,
                     ScriptEngineWrapper engine,
                     ScriptType type,
                     boolean enabled,
                     File file)

ScriptWrapper

protected ScriptWrapper(String name,
                        String description,
                        String engineName,
                        String typeName,
                        boolean enabled,
                        File file)

Method Detail

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getEngine

public ScriptEngineWrapper getEngine()

Gets the script engine wrapper. Might be null if the engine is not installed or was not yet set.

Returns:

the engine of the script, or null if not installed or was not yet set

setEngine

public void setEngine(ScriptEngineWrapper engine)

setEngineName

public void setEngineName(String engineName)

getEngineName

public String getEngineName()

getType

public ScriptType getType()

setType

public void setType(ScriptType type)

getTypeName

public String getTypeName()

getContents

public String getContents()

setContents

public void setContents(String contents)

getLastOutput

public String getLastOutput()

setLastOutput

public void setLastOutput(String lastOutput)

isChanged

public boolean isChanged()

setChanged

public void setChanged(boolean changed)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

Sets if this script is enabled.

It's not possible to enable scripts without engine.

Parameters:

enabled - true if the script should be enabled, false otherwise

See Also:

getEngine()

getLastErrorDetails

public String getLastErrorDetails()

setLastErrorDetails

public void setLastErrorDetails(String lastErrorDetails)

getLastException

public Exception getLastException()

setLastException

public void setLastException(Exception lastException)

isError

public boolean isError()

setError

public void setError(boolean error)

isLoadOnStart

public boolean isLoadOnStart()

setLoadOnStart

public void setLoadOnStart(boolean loadOnStart)

getFile

public File getFile()

setFile

public void setFile(File file)

getInterface

public <T> T getInterface(Class<T> class1)
                   throws ScriptException,
                          IOException

Throws:

ScriptException

IOException

isRunableStandalone

public boolean isRunableStandalone()

getWriter

public Writer getWriter()

Gets the writer which will be written to every time this script runs (if any)

Returns:

setWriter

public void setWriter(Writer writer)

Set a writer which will be written to every time this script runs

Parameters:

writer -

reloadScript

public void reloadScript()
                  throws IOException

Reloads the script. It should only be called if the script has already been loaded via loadScript(Charset)

Throws:

IOException

Since:

2.8.0

hasChangedOnDisk

public boolean hasChangedOnDisk()

Returns true if the script has changed on disk since it was loaded into this class

Returns:

true if the script has changed on disk since it was loaded into this class

Since:

2.8.0