com.atlassian.plugin.manager

Class DefaultPluginPersistentState

java.lang.Object

com.atlassian.plugin.manager.DefaultPluginPersistentState

All Implemented Interfaces:

PluginPersistentState, StoredPluginState, Serializable

public final class DefaultPluginPersistentState
extends Object
implements Serializable, PluginPersistentState

Immutable implementation of the PluginPersistentState interface.

The state stored in this object represents changes done by a user to the plugin's state. If "getPluginState()" or "getPluginModuleState()" return null, then the manager should assume that the default state applies instead.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.plugin.manager.PluginPersistentState

PluginPersistentState.Builder, PluginPersistentState.Util

Method Summary

Modifier and Type	Method and Description
static Map<String,PluginEnabledState>	getPluginEnabledStateMap(Map<String,Boolean> map)
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.
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, calculated from its persisted state AND default state.
boolean	isEnabled(Plugin plugin) Whether or not a plugin is enabled, calculated from its persisted state AND default state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.plugin.manager.PluginPersistentState

builder, builder, getMap, getPluginStateMap

Method Detail

getStatesMap

public Map<String,PluginEnabledState> getStatesMap()

Description copied from interface: StoredPluginState

Get the map of all states with the update timestamp for each of them. If the plugin or module has no entry in the Map, then it is in the default state.

Specified by:

getStatesMap in interface StoredPluginState

Returns:

a map of plugins and modules' keys to their stored state

isEnabled

public boolean isEnabled(Plugin plugin)

Description copied from interface: StoredPluginState

Whether or not a plugin is enabled, calculated from its persisted state AND default state. The default state is 'enabled' unless there is a disabled='true' attribute in atlassian-plugin.xml, or the minimum java-version specified in atlassian-plugin.xml is higher than the version we are running in. This does not report whether the plugin has successfully started -- use PluginAccessor for that information.

Specified by:

isEnabled in interface StoredPluginState

isEnabled

public boolean isEnabled(ModuleDescriptor<?> pluginModule)

Description copied from interface: StoredPluginState

Whether or not a given plugin module is enabled, calculated from its persisted state AND default state. The default state is 'enabled' unless there is a disabled='true' attribute in atlassian-plugin.xml, or the minimum java-version specified in atlassian-plugin.xml is higher than the version we are running in. This does not report whether the plugin has successfully started -- use PluginAccessor for that information.

Specified by:

isEnabled in interface StoredPluginState

getPluginEnabledStateMap

public Map<String,PluginEnabledState> getPluginEnabledStateMap(Plugin plugin)

Description copied from interface: StoredPluginState

Get state map of the given plugin and its modules. If the plugin or module has no entry in the Map, then it is in the default state.

Specified by:

getPluginEnabledStateMap in interface StoredPluginState

Parameters:

plugin - the plugin

Returns:

a map of plugin and module keys to their stored state

getPluginRestartState

public PluginRestartState getPluginRestartState(String pluginKey)

Description copied from interface: StoredPluginState

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

Specified by:

getPluginRestartState in interface StoredPluginState

Parameters:

pluginKey - The plugin to query

Returns:

The state of the plugin on restart

getPluginEnabledStateMap

public static Map<String,PluginEnabledState> getPluginEnabledStateMap(Map<String,Boolean> map)