org.jwall.audit.script

Interface Script

All Superinterfaces:

Serializable

public interface Script
extends Serializable

This interface defines the properties of a script definition. A script needs to provide some containers for results, the script source code and optionally some parameters.

Author:

Christian Bockermann <chris@jwall.org>

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Serializable>	getParameters() This method returns a Map of parameters.
Map<String,Serializable>	getResults() This returns the result of the script (if any).
URL	getResultUrl() This method returns the ResultUrl of that script.
String	getScriptLanguage() This method determines the language which is used to interpret/run the script source code.
String	getScriptSource() This method provides the source code of the script.
void	setResultUrl(URL url)

Method Detail

getScriptSource

String getScriptSource()

This method provides the source code of the script.

Returns:

getScriptLanguage

String getScriptLanguage()

This method determines the language which is used to interpret/run the script source code.

Returns:

setResultUrl

void setResultUrl(URL url)

getResultUrl

URL getResultUrl()

This method returns the ResultUrl of that script. Usually this value is determined by the script executor and provided to the implementing class.

Returns:

getParameters

Map<String,Serializable> getParameters()

This method returns a Map of parameters. These can be used as "args" for the script execution and will be provided to the script using the $args map.

Returns:

getResults

Map<String,Serializable> getResults()

This returns the result of the script (if any). The script has a map called $results bound that can be used to add result data.

Returns: