org.owasp.orizon.tornado
Class Plugin

java.lang.Object
  extended by org.owasp.orizon.tornado.Plugin
Direct Known Subclasses:
DummyPlugin, FormatterPlugin

public abstract class Plugin
extends java.lang.Object

This is the interface that all Orizon plugins must to implement.

Since:
0.90
Author:
thesp0nge

Field Summary
protected  java.lang.String className
           
protected  int intended
           
protected  java.lang.String name
           
static int O_PLUGIN_DUMMY
           
static int O_PLUGIN_DUSK
           
static int O_PLUGIN_JERICHO
           
static int O_PLUGIN_MIRAGE
           
static int O_PLUGIN_OSH
           
static int O_PLUGIN_REPORT
           
static int O_PLUGIN_TWILIGHT
           
 
Constructor Summary
Plugin()
           
 
Method Summary
 java.lang.String getClassName()
           
 int getEngine()
           
abstract  java.lang.String getName()
           
abstract  java.lang.String getVersion()
           
abstract  int requiredMaj()
           
abstract  int requiredMin()
           
abstract  java.lang.String says()
           
 void setClassName(java.lang.String className)
           
abstract  void setEngine()
           
 void setName(java.lang.String name)
           
abstract  boolean start()
          This is the main plugin method().
abstract  boolean stop()
          This is the close up method for a plugin.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

intended

protected int intended

name

protected java.lang.String name

className

protected java.lang.String className

O_PLUGIN_DUMMY

public static int O_PLUGIN_DUMMY

O_PLUGIN_OSH

public static int O_PLUGIN_OSH

O_PLUGIN_MIRAGE

public static int O_PLUGIN_MIRAGE

O_PLUGIN_JERICHO

public static int O_PLUGIN_JERICHO

O_PLUGIN_DUSK

public static int O_PLUGIN_DUSK

O_PLUGIN_TWILIGHT

public static int O_PLUGIN_TWILIGHT

O_PLUGIN_REPORT

public static int O_PLUGIN_REPORT
Constructor Detail

Plugin

public Plugin()
Method Detail

start

public abstract boolean start()
This is the main plugin method(). It must be used to initialize the plugin.

Returns:
true if the plugin can be started or false otherwise.

stop

public abstract boolean stop()
This is the close up method for a plugin. Using the design by contract approach, a plugin writer must take care to call stop() when the start() method is finishing. Tornado will call stop() only for emergency shutdown.

Returns:
true

getName

public abstract java.lang.String getName()

getVersion

public abstract java.lang.String getVersion()

says

public abstract java.lang.String says()

requiredMaj

public abstract int requiredMaj()

requiredMin

public abstract int requiredMin()

setName

public void setName(java.lang.String name)

setEngine

public abstract void setEngine()

getEngine

public int getEngine()

getClassName

public java.lang.String getClassName()

setClassName

public void setClassName(java.lang.String className)