org.openksavi.sponge.core.plugin

Class BasePlugin

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.plugin.BasePlugin

All Implemented Interfaces:

org.openksavi.sponge.engine.EngineModule, org.openksavi.sponge.plugin.Plugin, org.openksavi.sponge.util.Manageable

Direct Known Subclasses:

JavaPlugin, KnowledgeBasePluginStub

public abstract class BasePlugin
extends BaseEngineModule
implements org.openksavi.sponge.plugin.Plugin

Base plugin.

Constructor Summary

Constructors

Constructor and Description
BasePlugin()

Method Summary

Modifier and Type	Method and Description
void	doShutdown() Shuts down this managed entity.
void	doStartup() Starts up this managed entity.
org.openksavi.sponge.config.Configuration	getConfiguration() Returns plugin configuration.
protected org.openksavi.sponge.kb.KnowledgeBaseEngineOperations	getEngineOperations()
org.openksavi.sponge.kb.KnowledgeBaseEngineOperations	getEps()
org.openksavi.sponge.kb.KnowledgeBase	getKnowledgeBase()
org.slf4j.Logger	getLogger() Returns the logger.
void	onAfterReload() After reload callback method.
void	onBeforeReload() Before reload callback method.
void	onConfigure(org.openksavi.sponge.config.Configuration configuration)
void	onInit()
void	onShutdown() On shutdown callback method.
void	onStartup() On startup callback method.
void	setConfiguration(org.openksavi.sponge.config.Configuration configuration, boolean configure) Sets plugin configuration.
void	setKnowledgeBase(org.openksavi.sponge.kb.KnowledgeBase knowledgeBase)
String	toString() Returns string representation.

Methods inherited from class org.openksavi.sponge.core.engine.BaseEngineModule

getEngine, getName, getService, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setEngine, setName, shutdown, startup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openksavi.sponge.engine.EngineModule

getEngine, getName, setEngine, setName

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

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

Constructor Detail

BasePlugin

public BasePlugin()

Method Detail

setConfiguration

public void setConfiguration(org.openksavi.sponge.config.Configuration configuration,
                             boolean configure)

Sets plugin configuration.

Specified by:

setConfiguration in interface org.openksavi.sponge.plugin.Plugin

Parameters:

configuration - plugin configuration.

configure - whether this configuration should be applied immediately.

getConfiguration

public org.openksavi.sponge.config.Configuration getConfiguration()

Returns plugin configuration.

Specified by:

getConfiguration in interface org.openksavi.sponge.plugin.Plugin

Returns:

plugin configuration.

getKnowledgeBase

public org.openksavi.sponge.kb.KnowledgeBase getKnowledgeBase()

Specified by:

getKnowledgeBase in interface org.openksavi.sponge.plugin.Plugin

setKnowledgeBase

public void setKnowledgeBase(org.openksavi.sponge.kb.KnowledgeBase knowledgeBase)

Specified by:

setKnowledgeBase in interface org.openksavi.sponge.plugin.Plugin

doStartup

public final void doStartup()

Starts up this managed entity.

Overrides:

doStartup in class BaseEngineModule

doShutdown

public final void doShutdown()

Shuts down this managed entity.

Overrides:

doShutdown in class BaseEngineModule

onStartup

public void onStartup()

On startup callback method.

Specified by:

onStartup in interface org.openksavi.sponge.plugin.Plugin

onShutdown

public void onShutdown()

On shutdown callback method.

Specified by:

onShutdown in interface org.openksavi.sponge.plugin.Plugin

onBeforeReload

public void onBeforeReload()

Before reload callback method.

Specified by:

onBeforeReload in interface org.openksavi.sponge.plugin.Plugin

onAfterReload

public void onAfterReload()

After reload callback method.

Specified by:

onAfterReload in interface org.openksavi.sponge.plugin.Plugin

onInit

public void onInit()

Specified by:

onInit in interface org.openksavi.sponge.plugin.Plugin

onConfigure

public void onConfigure(org.openksavi.sponge.config.Configuration configuration)

Specified by:

onConfigure in interface org.openksavi.sponge.plugin.Plugin

getEngineOperations

protected org.openksavi.sponge.kb.KnowledgeBaseEngineOperations getEngineOperations()

getEps

public org.openksavi.sponge.kb.KnowledgeBaseEngineOperations getEps()

toString

public String toString()

Returns string representation.

Overrides:

toString in class BaseEngineModule

Returns:

string representation.

getLogger

public org.slf4j.Logger getLogger()

Returns the logger.

Returns:

logger.