Module org.jcommon

Package org.jorigin.plugin

Class DefaultPluginManager

java.lang.Object

org.jorigin.plugin.DefaultPluginManager

All Implemented Interfaces:

IPluginManager

public class DefaultPluginManager
extends Object
implements IPluginManager

This class is a default implementation of the IPluginManager interface. The plugins are stored in an underlying ArrayList.

Since:

1.0.0

Version:

"1.0.14" - b202111241200L

Author:

Julien SEINTURIER - Université de Toulon / CNRS LIS umr 7020 - github.com/jorigin/jcommon (contact@jorigin.org)

Constructor Summary

Constructors

Constructor	Description
DefaultPluginManager(IPlugger plugger)	Create a default plugin manager.

Method Summary

Modifier and Type	Method	Description
boolean	addPluginExclude(String pluginName)	Add a plugin name to the exclude list.
boolean	addPluginInclude(String pluginName)	Add a plugin name to the include list.
boolean	addPluginManagerListener(PluginManagerListener listener)	Add a plugin manager listener to the plugin manager.
ArrayList<String>	getPluginExcludes()	Get the list of the name of the excluded plugins.
ArrayList<String>	getPluginIncludes()	Get the list of the name of the included plugins.
void	pluginAllInit()	Init all plugins registered to this manager.
void	pluginAllRestart()	Restart all plugins registered to this manager.
void	pluginAllStart()	Start all plugins registered to this manager.
void	pluginAllStop()	Stop all plugins registered to theis manager.
void	pluginInit(IPlugin plugin)	Initialize the plugin given in parameter.
void	pluginRegister(IPlugin plugin)	Register a plugin to the plugin manager.
void	pluginRestart(IPlugin plugin)	Restart the plugin given in parameter.
void	pluginStart(IPlugin plugin)	Start the plugin given in parameter.
void	pluginStop(IPlugin plugin)	Stop the plugin given in parameter.
void	pluginUnregister(IPlugin plugin)	Unregister the given plugin from the plugin manager
boolean	removePluginExclude(String pluginName)	Remove a plugin name from the exclude list.
boolean	removePluginInclude(String pluginName)	Remove a plugin name from the include list.
boolean	removePluginManagerListener(PluginManagerListener listener)	Remove a plugin manager listener from the plugin manager.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPluginManager

public DefaultPluginManager(IPlugger plugger)

Create a default plugin manager.

Parameters:

plugger - The IPlugger to manage.

Method Detail

addPluginExclude

public boolean addPluginExclude(String pluginName)

Description copied from interface: IPluginManager

Add a plugin name to the exclude list.

Specified by:

addPluginExclude in interface IPluginManager

Parameters:

pluginName - the name of the plugin to exclude.

Returns:

true if the plugin has been successfully added to the exclude list, false otherwise. Please note that if the plugin name is already in the exclude list it will not be added twice.

See Also:

IPluginManager.removePluginExclude(String), IPluginManager.addPluginInclude(String), IPluginManager.removePluginInclude(String)

addPluginInclude

public boolean addPluginInclude(String pluginName)

Description copied from interface: IPluginManager

Add a plugin name to the include list.

Specified by:

addPluginInclude in interface IPluginManager

Parameters:

pluginName - the name of the plugin to include.

Returns:

true if the plugin has been succesfully added to the include list, false otherwise. Please note that if the plugin name is already in the include list it will not be added twice.

See Also:

IPluginManager.addPluginExclude(String), IPluginManager.removePluginExclude(String), IPluginManager.removePluginInclude(String)

getPluginExcludes

public ArrayList<String> getPluginExcludes()

Description copied from interface: IPluginManager

Get the list of the name of the excluded plugins.

Specified by:

getPluginExcludes in interface IPluginManager

Returns:

the list of the name of the excluded plugins.

See Also:

IPluginManager.addPluginExclude(String), IPluginManager.removePluginExclude(String), IPluginManager.addPluginInclude(String), IPluginManager.removePluginInclude(String)

getPluginIncludes

public ArrayList<String> getPluginIncludes()

Description copied from interface: IPluginManager

Get the list of the name of the included plugins.

Specified by:

getPluginIncludes in interface IPluginManager

Returns:

the list of the name of the excluded plugins.

See Also:

IPluginManager.addPluginExclude(String), IPluginManager.removePluginExclude(String), IPluginManager.addPluginInclude(String), IPluginManager.removePluginInclude(String)

pluginAllInit

public void pluginAllInit()

Description copied from interface: IPluginManager

Init all plugins registered to this manager.

Specified by:

pluginAllInit in interface IPluginManager

pluginAllRestart

public void pluginAllRestart()

Description copied from interface: IPluginManager

Restart all plugins registered to this manager.

Specified by:

pluginAllRestart in interface IPluginManager

pluginAllStart

public void pluginAllStart()

Description copied from interface: IPluginManager

Start all plugins registered to this manager.

Specified by:

pluginAllStart in interface IPluginManager

pluginAllStop

public void pluginAllStop()

Description copied from interface: IPluginManager

Stop all plugins registered to theis manager.

Specified by:

pluginAllStop in interface IPluginManager

pluginInit

public void pluginInit(IPlugin plugin)

Description copied from interface: IPluginManager

Initialize the plugin given in parameter. Most of the time, this function call the function IPlugin.pluginInit(IPlugger plugger).

Specified by:

pluginInit in interface IPluginManager

Parameters:

plugin - the plugin to initialize.

See Also:

IPlugin

pluginRegister

public void pluginRegister(IPlugin plugin)

Description copied from interface: IPluginManager

Register a plugin to the plugin manager.

Specified by:

pluginRegister in interface IPluginManager

Parameters:

plugin - the plugin to register.

pluginRestart

public void pluginRestart(IPlugin plugin)

Description copied from interface: IPluginManager

Restart the plugin given in parameter. Most of the time, this function call the method IPlugin.pluginStop() then the method IPlugin.pluginStart().

Specified by:

pluginRestart in interface IPluginManager

Parameters:

plugin - the plugin to restart.

See Also:

IPlugin

pluginStart

public void pluginStart(IPlugin plugin)

Description copied from interface: IPluginManager

Start the plugin given in parameter. Most of the time, this function call the function IPlugin.pluginStart().

Specified by:

pluginStart in interface IPluginManager

Parameters:

plugin - the plugin to start.

See Also:

IPlugin

pluginStop

public void pluginStop(IPlugin plugin)

Description copied from interface: IPluginManager

Stop the plugin given in parameter. Most of the time, this function call the function IPlugin.pluginStop().

Specified by:

pluginStop in interface IPluginManager

Parameters:

plugin - the plugin to stop.

See Also:

IPlugin

pluginUnregister

public void pluginUnregister(IPlugin plugin)

Description copied from interface: IPluginManager

Unregister the given plugin from the plugin manager

Specified by:

pluginUnregister in interface IPluginManager

Parameters:

plugin - the plugin to unregister

removePluginExclude

public boolean removePluginExclude(String pluginName)

Description copied from interface: IPluginManager

Remove a plugin name from the exclude list.

Specified by:

removePluginExclude in interface IPluginManager

Parameters:

pluginName - the name of the plugin to remove from exclusion.

Returns:

true if the plugin has been successfully removed from the exclude list, false otherwise.

See Also:

IPluginManager.addPluginExclude(String), IPluginManager.addPluginInclude(String), IPluginManager.removePluginInclude(String)

removePluginInclude

public boolean removePluginInclude(String pluginName)

Description copied from interface: IPluginManager

Remove a plugin name from the include list.

Specified by:

removePluginInclude in interface IPluginManager

Parameters:

pluginName - the name of the plugin to remove from inclusion.

Returns:

true if the plugin has been successfully removed from the include list, false otherwise.

See Also:

IPluginManager.addPluginExclude(String), IPluginManager.removePluginExclude(String), IPluginManager.addPluginInclude(String)

addPluginManagerListener

public boolean addPluginManagerListener(PluginManagerListener listener)

Description copied from interface: IPluginManager

Add a plugin manager listener to the plugin manager. This method return true is the listener has been successfully registered to the plugin and false otherwise.

Specified by:

addPluginManagerListener in interface IPluginManager

Parameters:

listener - the listener to register to the plugin manager

Returns:

true is the listener has been successfully registered to the plugin and false otherwise.

See Also:

PluginManagerListener

removePluginManagerListener

public boolean removePluginManagerListener(PluginManagerListener listener)

Description copied from interface: IPluginManager

Remove a plugin manager listener from the plugin manager. This method return true is the listener has been successfully removed from the plugin and false otherwise.

Specified by:

removePluginManagerListener in interface IPluginManager

Parameters:

listener - the listener to remove from the plugin manager

Returns:

true is the listener has been successfully removed from the plugin and false otherwise.

See Also:

PluginManagerListener