org.openksavi.sponge.plugin

Interface Plugin

All Superinterfaces:

Descriptive, EngineModule, HasEngine, Manageable

public interface Plugin
extends EngineModule

A plugin.

Method Summary

Modifier and Type	Method and Description
Configuration	getConfiguration() Returns a plugin configuration.
KnowledgeBase	getKnowledgeBase() Returns the knowledge base associated with this plugin.
void	onAfterReload() After reload callback method.
void	onBeforeReload() Before reload callback method.
void	onConfigure(Configuration configuration) A callback method that applies a configuration.
void	onInit() Initializes the plugin.
void	onShutdown() On shutdown callback method.
void	onStartup() On startup callback method.
void	setConfiguration(Configuration configuration, boolean configure) Sets a plugin configuration.
void	setKnowledgeBase(KnowledgeBase knowledgeBase) Sets the knowledge base associated with this plugin.

Methods inherited from interface org.openksavi.sponge.util.Manageable

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated, shutdown, startup

Methods inherited from interface org.openksavi.sponge.util.Descriptive

getDescription, getLabel, getName, setDescription, setLabel, setName

Methods inherited from interface org.openksavi.sponge.util.HasEngine

getEngine, setEngine

Method Detail

setConfiguration

void setConfiguration(Configuration configuration,
                      boolean configure)

Sets a plugin configuration.

Parameters:

configuration - a plugin configuration.

configure - whether this configuration should be applied immediately.

onConfigure

void onConfigure(Configuration configuration)

A callback method that applies a configuration.

Parameters:

configuration - configuration.

getConfiguration

Configuration getConfiguration()

Returns a plugin configuration.

Returns:

a plugin configuration.

onInit

void onInit()

Initializes the plugin.

onStartup

void onStartup()

On startup callback method.

onShutdown

void onShutdown()

On shutdown callback method.

onBeforeReload

void onBeforeReload()

Before reload callback method.

onAfterReload

void onAfterReload()

After reload callback method.

getKnowledgeBase

KnowledgeBase getKnowledgeBase()

Returns the knowledge base associated with this plugin.

Returns:

the knowledge base.

setKnowledgeBase

void setKnowledgeBase(KnowledgeBase knowledgeBase)

Sets the knowledge base associated with this plugin.

Parameters:

knowledgeBase - the knowledge base.