org.owasp.webscarab.plugin
Interface Plugin

All Superinterfaces:
java.lang.Runnable
All Known Implementing Classes:
Compare, Extensions, Fragments, Fuzzer, ManualRequest, Proxy, Scripted, Search, SessionIDAnalysis, Spider, WebService, XSSCRLF

public interface Plugin
extends java.lang.Runnable

This abstract class lists the basics that a WebScarab plugin will need to provide

Author:
rdawes

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.Object getScriptableObject()
           
 Hook[] getScriptingHooks()
           
 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 run()
          starts the plugin running
 void setSession(java.lang.String type, java.lang.Object store, java.lang.String session)
          informs the plugin that the Session has changed
 boolean stop()
          called to suspend or stop the plugin
 

Method Detail

getPluginName

java.lang.String getPluginName()
The plugin name

Returns:
The name of the plugin

setSession

void setSession(java.lang.String type,
                java.lang.Object store,
                java.lang.String session)
                throws StoreException
informs the plugin that the Session has changed

Parameters:
model - the new model
Throws:
StoreException

run

void run()
starts the plugin running

Specified by:
run in interface java.lang.Runnable

isRunning

boolean isRunning()

isBusy

boolean isBusy()
called to test whether the plugin is able to be stopped

Returns:
false if the plugin can be stopped

getStatus

java.lang.String getStatus()
called to determine what the current status of the plugin is


stop

boolean stop()
called to suspend or stop the plugin


isModified

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


flush

void flush()
           throws StoreException
called to instruct the plugin to flush any memory-only state to the store.

Throws:
StoreException - if there is any problem saving the session data

analyse

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

getScriptingHooks

Hook[] getScriptingHooks()

getScriptableObject

java.lang.Object getScriptableObject()