Class DefaultPluginStatusProvider

java.lang.Object
org.pf4j.DefaultPluginStatusProvider
All Implemented Interfaces:
PluginStatusProvider
public class DefaultPluginStatusProvider extends Object implements PluginStatusProvider
The default implementation for PluginStatusProvider. The enabled plugins are read from enabled.txt file and the disabled plugins are read from disabled.txt file.
Author:
Decebal Suiu, Mário Franco

  • Constructor Details

    • DefaultPluginStatusProvider

      public DefaultPluginStatusProvider(Path pluginsRoot)

  • Method Details

    • isPluginDisabled

      public boolean isPluginDisabled(String pluginId)
      Description copied from interface: PluginStatusProvider
      Checks if the plugin is disabled or not
      Specified by:
      isPluginDisabled in interface PluginStatusProvider
      Parameters:
      pluginId - the unique plugin identifier, specified in its metadata
      Returns:
      if the plugin is disabled or not

    • disablePlugin

      public void disablePlugin(String pluginId)
      Description copied from interface: PluginStatusProvider
      Disables a plugin from being loaded.
      Specified by:
      disablePlugin in interface PluginStatusProvider
      Parameters:
      pluginId - the unique plugin identifier, specified in its metadata

    • enablePlugin

      public void enablePlugin(String pluginId)
      Description copied from interface: PluginStatusProvider
      Enables a plugin that has previously been disabled.
      Specified by:
      enablePlugin in interface PluginStatusProvider
      Parameters:
      pluginId - the unique plugin identifier, specified in its metadata

    • getEnabledFilePath

      public Path getEnabledFilePath()

    • getDisabledFilePath

      public Path getDisabledFilePath()

    • getEnabledFilePath

      public static Path getEnabledFilePath(Path pluginsRoot)

    • getDisabledFilePath

      public static Path getDisabledFilePath(Path pluginsRoot)