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:

EngineModule, Plugin, Descriptive, HasEngine, Manageable

Direct Known Subclasses:

JPlugin, KnowledgeBasePluginStub

public abstract class BasePlugin
extends BaseEngineModule
implements 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.
Configuration	getConfiguration() Returns plugin configuration.
protected KnowledgeBaseEngineOperations	getEngineOperations()
KnowledgeBase	getKnowledgeBase()
org.slf4j.Logger	getLogger() Returns the logger.
KnowledgeBaseEngineOperations	getSponge()
void	onAfterReload() After reload callback method.
void	onBeforeReload() Before reload callback method.
void	onConfigure(Configuration configuration)
void	onInit()
void	onShutdown() On shutdown callback method.
void	onStartup() On startup callback method.
void	setConfiguration(Configuration configuration, boolean configure) Sets plugin configuration.
void	setKnowledgeBase(KnowledgeBase knowledgeBase)
void	shutdown() Marked as final to prevent overriding in custom plugins.
void	startup() Marked as final to prevent overriding in custom plugins.
String	toString() Returns string representation.

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

getDescription, getEngine, getInternalService, getLabel, getName, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setDescription, setEngine, setLabel, setName

Methods inherited from class java.lang.Object

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

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

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated

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

Constructor Detail

BasePlugin

public BasePlugin()

Method Detail

setConfiguration

public void setConfiguration(Configuration configuration,
                             boolean configure)

Sets plugin configuration.

Specified by:

setConfiguration in interface Plugin

Parameters:

configuration - plugin configuration.

configure - whether this configuration should be applied immediately.

getConfiguration

public Configuration getConfiguration()

Returns plugin configuration.

Specified by:

getConfiguration in interface Plugin

Returns:

plugin configuration.

getKnowledgeBase

public KnowledgeBase getKnowledgeBase()

Specified by:

getKnowledgeBase in interface Plugin

setKnowledgeBase

public void setKnowledgeBase(KnowledgeBase knowledgeBase)

Specified by:

setKnowledgeBase in interface 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 Plugin

onShutdown

public void onShutdown()

On shutdown callback method.

Specified by:

onShutdown in interface Plugin

onBeforeReload

public void onBeforeReload()

Before reload callback method.

Specified by:

onBeforeReload in interface Plugin

onAfterReload

public void onAfterReload()

After reload callback method.

Specified by:

onAfterReload in interface Plugin

onInit

public void onInit()

Specified by:

onInit in interface Plugin

onConfigure

public void onConfigure(Configuration configuration)

Specified by:

onConfigure in interface Plugin

startup

public final void startup()

Marked as final to prevent overriding in custom plugins.

Specified by:

startup in interface Manageable

Overrides:

startup in class BaseEngineModule

shutdown

public final void shutdown()

Marked as final to prevent overriding in custom plugins.

Specified by:

shutdown in interface Manageable

Overrides:

shutdown in class BaseEngineModule

getEngineOperations

protected KnowledgeBaseEngineOperations getEngineOperations()

getSponge

public KnowledgeBaseEngineOperations getSponge()

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.