|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectscone.Plugin
public abstract class Plugin
Classes implementing this interface may be registered as a plugin.
Use config/scone/plugins.xml
to enable and disable plugins.
Use config/properties/<plugin-classname>.xml
to configure plugins.
At startup, the registered classes will be instantiated, stored in a Vector to
remain in memory and the init() method will be invoked.
Field Summary | |
---|---|
static int |
ACCESSTRACKING
enable usertracking |
static int |
ACCESSTRACKING2
enable usertracking2: only with JavaScript but well working |
static int |
ADDPREAMBLE
use AddPreambleEditor |
static int |
CALCFINGERPRINT
Calculate a Fingerprint of the Web page source code. |
static int |
CONSIDERINCLUSIONS
fill InclusionTable and create Inclusion objects |
static int |
CONSIDERKEYWORDS
fill keywordtable... |
static int |
CONSIDERLINKS
fill LinkTable and create Link objects. |
static java.lang.String |
COPYRIGHT
|
static java.lang.String |
DECENT_HOST_CONDITION
condition for megs that parse any request/response with: ! |
static java.lang.String |
HTDOCCONDITION
the standard condition for megs: ! |
static java.lang.String |
NO_HTDOCCONDITION
condition for megs that handle NON-HTML-Documents: ! |
static int |
NOCACHE
use NoCache - use to avoid caching in the browser... |
static int |
NOREQUIREMENTS
possible requirements |
static int |
PAGETIMEOUT
use PageTimout - use to limit caching in the browser... |
static int |
PARSEDOCUMENT
fill HtmlDocumentTable and create HtmlDocument objects |
static int |
POSTDATA
Get the Post-Data of the browser's request if available. |
static int |
RAS
use RAS-Server (Remote Access Server) The Plugin class has to implement ,,public int getRasPort()´´! |
static int |
RESOURCEGENERATOR
use GeneralResourceGenerator |
static int |
SAVEBODYTEXT
Save the pure, unescaped text of the document body |
static int |
SAVESOURCECODE
Save the source Code |
static int |
USEPARSINGMEG
internal requirement! |
Constructor Summary | |
---|---|
Plugin()
|
Method Summary | |
---|---|
void |
addMeg(Meg meg)
adds a MEG to WBI. |
void |
disable()
overwrite this method to shutdown plugin activities not yet implemented! |
void |
displayConfigGUI(java.awt.Dialog parent)
displays a GUI that allows for editing the persistent properties for the plugin. |
void |
displayConfigGUI(java.awt.Frame parent)
displays a GUI that allows for editing the persistent properties for the plugin. |
void |
enable()
overwrite this method to enable plugin ectivities not yet implemented! |
PersistentProperties |
getProperties()
returns a PersistentProperties object that the framework provides for the plugin. |
int |
getRasPort()
Specify the port of the RAS-Server. |
abstract int |
getRequirements()
Define the requirements of this plugin by implementing this method. |
abstract void |
init()
Initializes a scone plugin. |
void |
init(Proxy proxy)
sets the proxy variable. |
void |
saveProperties()
saves the properties if they have been changed. |
void |
terminate()
overwrite this method to be notified when the Proxy terminates |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final int USEPARSINGMEG
public static final int NOREQUIREMENTS
public static final int PARSEDOCUMENT
public static final int CONSIDERLINKS
public static final int CONSIDERINCLUSIONS
public static final int POSTDATA
The Data is made available by the PostDataExtractor and the ParsingMeg and stored in
sconePipe.getTokenInputStream().getMetaInfo().get("postData")
public static final int CONSIDERKEYWORDS
public static final int SAVEBODYTEXT
public static final int SAVESOURCECODE
public static final int CALCFINGERPRINT
public static final int ADDPREAMBLE
public static final int RESOURCEGENERATOR
public static final int NOCACHE
public static final int PAGETIMEOUT
public static final int RAS
public static final int ACCESSTRACKING
public static final int ACCESSTRACKING2
public static final java.lang.String HTDOCCONDITION
public static final java.lang.String NO_HTDOCCONDITION
public static final java.lang.String DECENT_HOST_CONDITION
Constructor Detail |
---|
public Plugin()
Method Detail |
---|
public abstract int getRequirements()
These requirements have to be combined by the | operator: PARSEDOCUMENT | CONSIDERLINKS will cause scone to create HtmlDocument objects, Link objects and LinkToken objects.
If a feature is not required by any of the registered plugins, scone will not support it at runtime.
public int getRasPort()
public abstract void init()
Scone
framework.
public void init(Proxy proxy)
proxy
- the Proxy objectpublic void addMeg(Meg meg)
meg
- the MEGpublic PersistentProperties getProperties()
public void saveProperties()
public void displayConfigGUI(java.awt.Frame parent)
parent
- a parent Frame for the config dialogpublic void displayConfigGUI(java.awt.Dialog parent)
parent
- a parent Dialog for the config dialogpublic void enable()
public void disable()
public void terminate()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |