Module org.jcommon.core
Package org.jorigin.plugin

Interface IPluginManager

All Known Implementing Classes:
DefaultPluginManager
public interface IPluginManager
This interface specify the methods of a plugin manager. A plugin manager provide plugin integration within an application.
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)

  • Method Details

    • 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 function IPlugin.pluginInit(IPlugger plugger).
      Parameters:
      plugin - the plugin to initialize.
      See Also:

    • pluginStart

      void pluginStart(IPlugin plugin)
      Start the plugin given in parameter. Most of the time, this function call the function IPlugin.pluginStart().
      Parameters:
      plugin - the plugin to start.
      See Also:

    • pluginStop

      void pluginStop(IPlugin plugin)
      Stop the plugin given in parameter. Most of the time, this function call the function IPlugin.pluginStop().
      Parameters:
      plugin - the plugin to stop.
      See Also:

    • pluginRestart

      void pluginRestart(IPlugin plugin)
      Restart the plugin given in parameter. Most of the time, this function call the method IPlugin.pluginStop() then the method IPlugin.pluginStart().
      Parameters:
      plugin - the plugin to restart.
      See Also:

    • 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

      ArrayList<String> getPluginExcludes()
      Get the list of the name of the excluded plugins.
      Returns:
      the list of the name of the excluded plugins.
      See Also:

    • getPluginIncludes

      ArrayList<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

      boolean addPluginExclude(String pluginName)
      Add a plugin name to the exclude list.
      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:

    • removePluginExclude

      boolean removePluginExclude(String pluginName)
      Remove a plugin name from the exclude list.
      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:

    • addPluginInclude

      boolean addPluginInclude(String pluginName)
      Add a plugin name to the include list.
      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:

    • removePluginInclude

      boolean removePluginInclude(String pluginName)
      Remove a plugin name from the include list.
      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:

    • addPluginManagerListener

      boolean addPluginManagerListener(PluginManagerListener listener)
      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.
      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:

    • removePluginManagerListener

      boolean removePluginManagerListener(PluginManagerListener listener)
      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.
      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: