org.owasp.webscarab.plugin.scripted
Class Scripted

java.lang.Object
  org.owasp.webscarab.plugin.scripted.Scripted

All Implemented Interfaces:

java.lang.Runnable, ConversationHandler, Plugin

public class Scripted
extends java.lang.Object
implements Plugin, ConversationHandler

Author:

rogan

Constructor Summary

Scripted(Framework framework)
Creates a new instance of Scripted

Method Summary

void	analyse(ConversationID id, Request request, Response response, java.lang.String origin)
void	flush() called to instruct the plugin to flush any memory-only state to the store.
java.lang.String	getPluginName() The plugin name
java.lang.String	getScript()
java.lang.Object	getScriptableObject()
java.io.File	getScriptFile()
Hook[]	getScriptingHooks()
java.lang.String	getScriptLanguage()
java.lang.String	getStatus() called to determine what the current status of the plugin is
boolean	isBusy() called to test whether the plugin is able to be stopped
boolean	isModified() called to determine whether the data stored within the plugin has been modified and should be saved
boolean	isRunning()
void	loadScript(java.io.File file)
void	requestError(Request request, java.io.IOException ioe)
void	responseReceived(Response response)
void	run() starts the plugin running
void	runScript()
void	saveScript(java.io.File file)
void	setErr(java.io.PrintStream err)
void	setOut(java.io.PrintStream out)
void	setScript(java.lang.String language, java.lang.String script)
void	setSession(java.lang.String type, java.lang.Object store, java.lang.String session) informs the plugin that the Session has changed
void	setUI(ScriptedUI ui)
boolean	stop() called to suspend or stop the plugin
void	stopScript()

Methods inherited from class java.lang.Object

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

Constructor Detail

Scripted

public Scripted(Framework framework)

Creates a new instance of Scripted

Method Detail

setUI

public void setUI(ScriptedUI ui)

setOut

public void setOut(java.io.PrintStream out)

setErr

public void setErr(java.io.PrintStream err)

loadScript

public void loadScript(java.io.File file)
                throws java.io.IOException

Throws:

java.io.IOException

saveScript

public void saveScript(java.io.File file)
                throws java.io.IOException

Throws:

java.io.IOException

getScriptFile

public java.io.File getScriptFile()

getScriptLanguage

public java.lang.String getScriptLanguage()

getScript

public java.lang.String getScript()

setScript

public void setScript(java.lang.String language,
                      java.lang.String script)

analyse

public void analyse(ConversationID id,
                    Request request,
                    Response response,
                    java.lang.String origin)

Specified by:

analyse in interface Plugin

flush

public void flush()
           throws StoreException

Description copied from interface: Plugin

called to instruct the plugin to flush any memory-only state to the store.

Specified by:

flush in interface Plugin

Throws:

StoreException - if there is any problem saving the session data

getPluginName

public java.lang.String getPluginName()

Description copied from interface: Plugin

The plugin name

Specified by:

getPluginName in interface Plugin

Returns:

The name of the plugin

getStatus

public java.lang.String getStatus()

Description copied from interface: Plugin

called to determine what the current status of the plugin is

Specified by:

getStatus in interface Plugin

isBusy

public boolean isBusy()

Description copied from interface: Plugin

called to test whether the plugin is able to be stopped

Specified by:

isBusy in interface Plugin

Returns:

false if the plugin can be stopped

isModified

public boolean isModified()

Description copied from interface: Plugin

called to determine whether the data stored within the plugin has been modified and should be saved

Specified by:

isModified in interface Plugin

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Plugin

run

public void run()

Description copied from interface: Plugin

starts the plugin running

Specified by:

run in interface java.lang.Runnable

Specified by:

run in interface Plugin

requestError

public void requestError(Request request,
                         java.io.IOException ioe)

Specified by:

requestError in interface ConversationHandler

responseReceived

public void responseReceived(Response response)

Specified by:

responseReceived in interface ConversationHandler

setSession

public void setSession(java.lang.String type,
                       java.lang.Object store,
                       java.lang.String session)
                throws StoreException

Description copied from interface: Plugin

informs the plugin that the Session has changed

Specified by:

setSession in interface Plugin

Throws:

StoreException

stop

public boolean stop()

Description copied from interface: Plugin

called to suspend or stop the plugin

Specified by:

stop in interface Plugin

stopScript

public void stopScript()

runScript

public void runScript()

getScriptableObject

public java.lang.Object getScriptableObject()

Specified by:

getScriptableObject in interface Plugin

getScriptingHooks

public Hook[] getScriptingHooks()

Specified by:

getScriptingHooks in interface Plugin