org.openksavi.sponge.core.engine

Class DefaultPluginManager

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.engine.DefaultPluginManager

All Implemented Interfaces:

Configurable, EngineModule, PluginManager, Descriptive, HasEngine, Manageable

public class DefaultPluginManager
extends BaseEngineModule
implements PluginManager

Plugin Manager.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Plugin>	pluginMap Plugin map indexed by name.

Constructor Summary

Constructors

Constructor and Description
DefaultPluginManager(SpongeEngine engine) Creates a new Plugin Manager.

Method Summary

Modifier and Type	Method and Description
void	addPlugin(Plugin plugin) Adds the specified plugin.
void	configure(Configuration configuration) Configures plugins.
Plugin	createAndConfigurePlugin(Configuration pluginConfig) Creates and configures a plugin.
protected Plugin	createPluginStub(String pluginName, String knowledgeBaseName, String pluginClassName) Creates a plugin stub.
protected void	definePluginVariable(String name, Plugin plugin)
void	definePluginVariables() Defines plugin variables.
void	doShutdown() Shuts down plugins.
void	doStartup() Starts up plugins.
boolean	existsPlugin(String name) Checks whether a plugin with the specified name exists.
<T extends Plugin> T	getPlugin(Class<T> cls)
Plugin	getPlugin(String name) Returns a plugin identified by the name.
<T extends Plugin> T	getPlugin(String name, Class<T> cls)
List<Plugin>	getPlugins() Returns the plugin list.
protected void	initPlugin(Plugin plugin)
protected void	initPlugins()
protected Plugin	loadPlugin(KnowledgeBasePluginStub pluginStub) Loads a plugin.
void	onAfterReload() Calls onAfterReload on plugins.
void	onBeforeReload() Calls onBeforeReload on plugins.
void	removePlugin(Plugin plugin) Removes the specified plugin.
protected void	replacePlugin(KnowledgeBasePluginStub stub, Plugin plugin)
void	startupPlugins()

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

getDescription, getDisplayName, getEngine, getInternalService, getName, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setDescription, setDisplayName, setEngine, setName, shutdown, startup, toString

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, shutdown, startup

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

getDescription, getDisplayName, getName, setDescription, setDisplayName, setName

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

getEngine, setEngine

Field Detail

pluginMap

protected Map<String,Plugin> pluginMap

Plugin map indexed by name.

Constructor Detail

DefaultPluginManager

public DefaultPluginManager(SpongeEngine engine)

Creates a new Plugin Manager.

Parameters:

engine - the engine.

Method Detail

configure

public void configure(Configuration configuration)

Configures plugins.

Specified by:

configure in interface Configurable

Parameters:

configuration - plugins configuration.

createAndConfigurePlugin

public Plugin createAndConfigurePlugin(Configuration pluginConfig)

Creates and configures a plugin.

Parameters:

pluginConfig - plugin configuration.

Returns:

a plugin.

existsPlugin

public boolean existsPlugin(String name)

Checks whether a plugin with the specified name exists.

Specified by:

existsPlugin in interface PluginManager

Parameters:

name - plugin name.

Returns:

true if the plugin exists.

addPlugin

public void addPlugin(Plugin plugin)

Adds the specified plugin.

Specified by:

addPlugin in interface PluginManager

Parameters:

plugin - plugin.

removePlugin

public void removePlugin(Plugin plugin)

Removes the specified plugin.

Specified by:

removePlugin in interface PluginManager

Parameters:

plugin - plugin.

getPlugins

public List<Plugin> getPlugins()

Returns the plugin list. The result is an immutable list that prevents from locking the entire plugin map for long-running operations on the list.

Specified by:

getPlugins in interface PluginManager

Returns:

plugin list.

getPlugin

public Plugin getPlugin(String name)

Returns a plugin identified by the name.

Specified by:

getPlugin in interface PluginManager

Parameters:

name - plugin name.

Returns:

plugin or null if there is no such plugin.

getPlugin

public <T extends Plugin> T getPlugin(String name,
                                      Class<T> cls)

Specified by:

getPlugin in interface PluginManager

getPlugin

public <T extends Plugin> T getPlugin(Class<T> cls)

Specified by:

getPlugin in interface PluginManager

createPluginStub

protected Plugin createPluginStub(String pluginName,
                                  String knowledgeBaseName,
                                  String pluginClassName)

Creates a plugin stub.

Parameters:

pluginName - a plugin name.

knowledgeBaseName - a knowledge base name.

pluginClassName - a plugin class name.

Returns:

a plugin stub.

loadPlugin

protected Plugin loadPlugin(KnowledgeBasePluginStub pluginStub)

Loads a plugin.

Parameters:

pluginStub - a plugin stub.

Returns:

loaded plugin.

doStartup

public void doStartup()

Starts up plugins.

Overrides:

doStartup in class BaseEngineModule

startupPlugins

public void startupPlugins()

initPlugins

protected void initPlugins()

initPlugin

protected void initPlugin(Plugin plugin)

definePluginVariables

public void definePluginVariables()

Defines plugin variables.

definePluginVariable

protected void definePluginVariable(String name,
                                    Plugin plugin)

replacePlugin

protected void replacePlugin(KnowledgeBasePluginStub stub,
                             Plugin plugin)

doShutdown

public void doShutdown()

Shuts down plugins.

Overrides:

doShutdown in class BaseEngineModule

onBeforeReload

public void onBeforeReload()

Calls onBeforeReload on plugins.

Specified by:

onBeforeReload in interface PluginManager

onAfterReload

public void onAfterReload()

Calls onAfterReload on plugins.

Specified by:

onAfterReload in interface PluginManager