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.

Field Summary

Fields

Modifier and Type	Field	Description
private List<String>	disabledPlugins
private List<String>	enabledPlugins
private static final org.slf4j.Logger	log
private final Path	pluginsRoot

Constructor Summary

Constructors

Constructor	Description
DefaultPluginStatusProvider(Path pluginsRoot)

Method Summary

Modifier and Type	Method	Description
void	disablePlugin(String pluginId)	Disables a plugin from being loaded.
void	enablePlugin(String pluginId)	Enables a plugin that has previously been disabled.
Path	getDisabledFilePath()
static Path	getDisabledFilePath(Path pluginsRoot)
Path	getEnabledFilePath()
static Path	getEnabledFilePath(Path pluginsRoot)
boolean	isPluginDisabled(String pluginId)	Checks if the plugin is disabled or not

Methods inherited from class Object

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

Field Details

log

private static final org.slf4j.Logger log

pluginsRoot

private final Path pluginsRoot

enabledPlugins

private List<String> enabledPlugins

disabledPlugins

private List<String> disabledPlugins

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)