org.owasp.webscarab.plugin.search
Class Search

java.lang.Object
  org.owasp.webscarab.plugin.search.Search

All Implemented Interfaces:

java.lang.Runnable, Plugin

public class Search
extends java.lang.Object
implements Plugin

Author:

rogan

Constructor Summary

Search(Framework framework)
Creates a new instance of Search

Method Summary

void	addSearch(java.lang.String description, java.lang.String expression)
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.
SearchModel	getModel()
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	reload(java.lang.String description)
void	removeSearch(java.lang.String description)
void	run() starts the plugin running
void	setFilter(java.lang.String description)
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

Methods inherited from class java.lang.Object

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

Constructor Detail

Search

public Search(Framework framework)

Creates a new instance of Search

Method Detail

getModel

public SearchModel getModel()

addSearch

public void addSearch(java.lang.String description,
                      java.lang.String expression)

removeSearch

public void removeSearch(java.lang.String description)

setFilter

public void setFilter(java.lang.String description)

reload

public void reload(java.lang.String description)

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

getScriptableObject

public java.lang.Object getScriptableObject()

Specified by:

getScriptableObject in interface Plugin

getScriptingHooks

public Hook[] getScriptingHooks()

Specified by:

getScriptingHooks in interface 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

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