Package org.pf4j

Class DefaultPluginStatusProvider

  • All Implemented Interfaces:
    PluginStatusProvider

    public class DefaultPluginStatusProvider
    extends java.lang.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.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.List<java.lang.String> disabledPlugins  
      private java.util.List<java.lang.String> enabledPlugins  
      private static org.slf4j.Logger log  
      private java.nio.file.Path pluginsRoot  
    • Field Detail

      • log

        private static final org.slf4j.Logger log
      • pluginsRoot

        private final java.nio.file.Path pluginsRoot
      • enabledPlugins

        private java.util.List<java.lang.String> enabledPlugins
      • disabledPlugins

        private java.util.List<java.lang.String> disabledPlugins
    • Constructor Detail

      • DefaultPluginStatusProvider

        public DefaultPluginStatusProvider​(java.nio.file.Path pluginsRoot)
    • Method Detail

      • isPluginDisabled

        public boolean isPluginDisabled​(java.lang.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​(java.lang.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​(java.lang.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 java.nio.file.Path getEnabledFilePath()
      • getDisabledFilePath

        public java.nio.file.Path getDisabledFilePath()
      • getEnabledFilePath

        public static java.nio.file.Path getEnabledFilePath​(java.nio.file.Path pluginsRoot)
      • getDisabledFilePath

        public static java.nio.file.Path getDisabledFilePath​(java.nio.file.Path pluginsRoot)