Package org.jorigin.plugin
Interface IPluginManager
-
- All Known Implementing Classes:
DefaultPluginManager
public interface IPluginManagerThis interface specify the methods of a plugin manager. A plugin manager provide plugin integration within an application.- Since:
- 1.0.0
- Version:
- "1.0.9" - b201903071030L
- Author:
- Julien Seinturier - COMEX S.A. - contact@jorigin.org - https://github.com/jorigin/jeometry
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanaddPluginExclude(java.lang.String pluginName)Add a plugin name to the exclude list.booleanaddPluginInclude(java.lang.String pluginName)Add a plugin name to the include list.booleanaddPluginManagerListener(PluginManagerListener listener)Add a plugin manager listener to the plugin manager.java.util.ArrayList<java.lang.String>getPluginExcludes()Get the list of the name of the excluded plugins.java.util.ArrayList<java.lang.String>getPluginIncludes()Get the list of the name of the included plugins.voidpluginAllInit()Init all plugins registered to this manager.voidpluginAllRestart()Restart all plugins registered to this manager.voidpluginAllStart()Start all plugins registered to this manager.voidpluginAllStop()Stop all plugins registered to theis manager.voidpluginInit(IPlugin plugin)Initialize the plugin given in parameter.voidpluginRegister(IPlugin plugin)Register a plugin to the plugin manager.voidpluginRestart(IPlugin plugin)Restart the plugin given in parameter.voidpluginStart(IPlugin plugin)Start the plugin given in parameter.voidpluginStop(IPlugin plugin)Stop the plugin given in parameter.voidpluginUnregister(IPlugin plugin)Unregister the given plugin from the plugin managerbooleanremovePluginExclude(java.lang.String pluginName)Remove a plugin name from the exclude list.booleanremovePluginInclude(java.lang.String pluginName)Remove a plugin name from the include list.booleanremovePluginManagerListener(PluginManagerListener listener)Remove a plugin manager listener from the plugin manager.
-
-
-
Method Detail
-
pluginRegister
void pluginRegister(IPlugin plugin)
Register a plugin to the plugin manager.- Parameters:
plugin- the plugin to register.
-
pluginUnregister
void pluginUnregister(IPlugin plugin)
Unregister the given plugin from the plugin manager- Parameters:
plugin- the plugin to unregister
-
pluginInit
void pluginInit(IPlugin plugin)
Initialize the plugin given in parameter. Most of the time, this function call the functionIPlugin.pluginInit(IPlugger plugger).- Parameters:
plugin- the plugin to initialize.- See Also:
IPlugin
-
pluginStart
void pluginStart(IPlugin plugin)
Start the plugin given in parameter. Most of the time, this function call the functionIPlugin.pluginStart().- Parameters:
plugin- the plugin to start.- See Also:
IPlugin
-
pluginStop
void pluginStop(IPlugin plugin)
Stop the plugin given in parameter. Most of the time, this function call the functionIPlugin.pluginStop().- Parameters:
plugin- the plugin to stop.- See Also:
IPlugin
-
pluginRestart
void pluginRestart(IPlugin plugin)
Restart the plugin given in parameter. Most of the time, this function call the methodIPlugin.pluginStop()then the methodIPlugin.pluginStart().- Parameters:
plugin- the plugin to restart.- See Also:
IPlugin
-
pluginAllInit
void pluginAllInit()
Init all plugins registered to this manager.
-
pluginAllStart
void pluginAllStart()
Start all plugins registered to this manager.
-
pluginAllStop
void pluginAllStop()
Stop all plugins registered to theis manager.
-
pluginAllRestart
void pluginAllRestart()
Restart all plugins registered to this manager.
-
getPluginExcludes
java.util.ArrayList<java.lang.String> getPluginExcludes()
Get the list of the name of the excluded plugins.- Returns:
- the list of the name of the excluded plugins.
- See Also:
addPluginExclude(String),removePluginExclude(String),addPluginInclude(String),removePluginInclude(String)
-
getPluginIncludes
java.util.ArrayList<java.lang.String> getPluginIncludes()
Get the list of the name of the included plugins.- Returns:
- the list of the name of the excluded plugins.
- See Also:
addPluginExclude(String),removePluginExclude(String),addPluginInclude(String),removePluginInclude(String)
-
addPluginExclude
boolean addPluginExclude(java.lang.String pluginName)
Add a plugin name to the exclude list.- Parameters:
pluginName- the name of the plugin to exclude.- Returns:
trueif 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:
removePluginExclude(String),addPluginInclude(String),removePluginInclude(String)
-
removePluginExclude
boolean removePluginExclude(java.lang.String pluginName)
Remove a plugin name from the exclude list.- Parameters:
pluginName- the name of the plugin to remove from exclusion.- Returns:
trueif the plugin has been successfully removed from the exclude list, false otherwise.- See Also:
addPluginExclude(String),addPluginInclude(String),removePluginInclude(String)
-
addPluginInclude
boolean addPluginInclude(java.lang.String pluginName)
Add a plugin name to the include list.- Parameters:
pluginName- the name of the plugin to include.- Returns:
trueif 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:
addPluginExclude(String),removePluginExclude(String),removePluginInclude(String)
-
removePluginInclude
boolean removePluginInclude(java.lang.String pluginName)
Remove a plugin name from the include list.- Parameters:
pluginName- the name of the plugin to remove from inclusion.- Returns:
trueif the plugin has been successfully removed from the include list, false otherwise.- See Also:
addPluginExclude(String),removePluginExclude(String),addPluginInclude(String)
-
addPluginManagerListener
boolean addPluginManagerListener(PluginManagerListener listener)
Add a plugin manager listener to the plugin manager. This method returntrueis the listener has been successfully registered to the plugin andfalseotherwise.- Parameters:
listener- the listener to register to the plugin manager- Returns:
trueis the listener has been successfully registered to the plugin andfalseotherwise.- See Also:
PluginManagerListener
-
removePluginManagerListener
boolean removePluginManagerListener(PluginManagerListener listener)
Remove a plugin manager listener from the plugin manager. This method returntrueis the listener has been successfully removed from the plugin andfalseotherwise.- Parameters:
listener- the listener to remove from the plugin manager- Returns:
trueis the listener has been successfully removed from the plugin andfalseotherwise.- See Also:
PluginManagerListener
-
-