com.atlassian.plugin.manager

Interface PluginPersistentState

All Known Implementing Classes:

DefaultPluginPersistentState

public interface PluginPersistentState

Interface that represents a configuration state for plugins and plugin modules. The configuration state (enabled or disabled) is separate from the plugins and modules themselves because a plugin may have multiple states depending on the context.

Since:

2.2.0

Author:

anatoli

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PluginPersistentState.Builder Builder for PluginPersistentState instances.
static class	PluginPersistentState.Util

Method Summary

Modifier and Type	Method and Description
default Map<String,Boolean>	getMap() Deprecated. please use getStatesMap() instead
Map<String,PluginEnabledState>	getPluginEnabledStateMap(Plugin plugin) Get state map of the given plugin and its modules.
PluginRestartState	getPluginRestartState(String pluginKey) Gets whether the plugin is expected to be upgraded, installed, or removed on next restart
default Map<String,Boolean>	getPluginStateMap(Plugin plugin) Deprecated. please use getPluginEnabledStateMap(Plugin) instead
Map<String,PluginEnabledState>	getStatesMap() Get the map of all states with the update timestamp for each of them.
boolean	isEnabled(ModuleDescriptor<?> pluginModule) Whether or not a given plugin module is enabled in this state, calculated from it's current state AND default state.
boolean	isEnabled(Plugin plugin) Whether or not a plugin is enabled, calculated from it's current state AND default state.

Method Detail

getMap

@Deprecated
default Map<String,Boolean> getMap()

Deprecated. please use getStatesMap() instead

Get the map of all states. Deprecated since 4.5.0

Returns:

The map that maps plugins and modules' keys to an actual enabled state (Boolean.True/Boolean.False).

getStatesMap

Map<String,PluginEnabledState> getStatesMap()

Get the map of all states with the update timestamp for each of them.

Returns:

The map that maps plugins and modules' keys to an actual state PluginEnabledState

Since:

4.5.0

isEnabled

boolean isEnabled(Plugin plugin)

Whether or not a plugin is enabled, calculated from it's current state AND default state.

isEnabled

boolean isEnabled(ModuleDescriptor<?> pluginModule)

Whether or not a given plugin module is enabled in this state, calculated from it's current state AND default state.

getPluginStateMap

@Deprecated
default Map<String,Boolean> getPluginStateMap(Plugin plugin)

Deprecated. please use getPluginEnabledStateMap(Plugin) instead

Get state map of the given plugin and its modules. Deprecated since 4.5.0

Parameters:

plugin - the plugin

Returns:

The map that maps the plugin and its modules' keys to plugin state (Boolean.TRUE/Boolean.FALSE).

getPluginEnabledStateMap

Map<String,PluginEnabledState> getPluginEnabledStateMap(Plugin plugin)

Get state map of the given plugin and its modules.

Parameters:

plugin - the plugin

Returns:

The map that maps the plugin and its modules' keys to plugin state PluginEnabledState

Since:

4.5.0

getPluginRestartState

PluginRestartState getPluginRestartState(String pluginKey)

Gets whether the plugin is expected to be upgraded, installed, or removed on next restart

Parameters:

pluginKey - The plugin to query

Returns:

The state of the plugin on restart