com.atlassian.plugin.manager

Class DefaultPluginManager

java.lang.Object

com.atlassian.plugin.manager.DefaultPluginManager

All Implemented Interfaces:

PluginAccessor, PluginController, PluginSystemLifecycle, SplitStartupPluginSystemLifecycle

public class DefaultPluginManager
extends Object
implements PluginController, PluginAccessor, SplitStartupPluginSystemLifecycle

This implementation delegates the initiation and classloading of plugins to a list of PluginLoaders and records the state of plugins in a PluginPersistentStateStore.

This class is responsible for enabling and disabling plugins and plugin modules and reflecting these state changes in the PluginPersistentStateStore.

An interesting quirk in the design is that installPlugins(com.atlassian.plugin.PluginArtifact[]) explicitly stores the plugin via a PluginInstaller, whereas uninstall(Plugin) relies on the underlying PluginLoader to remove the plugin if necessary.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultPluginManager.Builder<T extends DefaultPluginManager.Builder<?>>

Nested classes/interfaces inherited from interface com.atlassian.plugin.PluginAccessor

PluginAccessor.Descriptor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultPluginManager(DefaultPluginManager.Builder<? extends DefaultPluginManager.Builder> builder)
	DefaultPluginManager(PluginPersistentStateStore store, List<PluginLoader> pluginLoaders, ModuleDescriptorFactory moduleDescriptorFactory, PluginEventManager pluginEventManager)
	DefaultPluginManager(PluginPersistentStateStore store, List<PluginLoader> pluginLoaders, ModuleDescriptorFactory moduleDescriptorFactory, PluginEventManager pluginEventManager, boolean verifyRequiredPlugins)
	DefaultPluginManager(PluginPersistentStateStore store, List<PluginLoader> pluginLoaders, ModuleDescriptorFactory moduleDescriptorFactory, PluginEventManager pluginEventManager, PluginExceptionInterception pluginExceptionInterception)
	DefaultPluginManager(PluginPersistentStateStore store, List<PluginLoader> pluginLoaders, ModuleDescriptorFactory moduleDescriptorFactory, PluginEventManager pluginEventManager, PluginExceptionInterception pluginExceptionInterception, boolean verifyRequiredPlugins)
	DefaultPluginManager(PluginPersistentStateStore store, List<PluginLoader> pluginLoaders, ModuleDescriptorFactory moduleDescriptorFactory, PluginEventManager pluginEventManager, PluginExceptionInterception pluginExceptionInterception, boolean verifyRequiredPlugins, Predicate<Plugin> delayLoadOf)
	DefaultPluginManager(PluginPersistentStateStore store, List<PluginLoader> pluginLoaders, ModuleDescriptorFactory moduleDescriptorFactory, PluginEventManager pluginEventManager, PluginExceptionInterception pluginExceptionInterception, Predicate<Plugin> delayLoadOf)
	DefaultPluginManager(PluginPersistentStateStore store, List<PluginLoader> pluginLoaders, ModuleDescriptorFactory moduleDescriptorFactory, PluginEventManager pluginEventManager, Predicate<Plugin> delayLoadOf)

Method Summary

Modifier and Type	Method and Description
ModuleDescriptor<?>	addDynamicModule(Plugin maybePluginInternal, org.dom4j.Element module)
protected void	addPlugins(PluginLoader loader, Collection<Plugin> pluginsToInstall) Update the local plugin state and enable state aware modules.
void	disablePlugin(String key)
protected void	disablePluginInternal(String key, boolean persistDisabledState)
void	disablePluginModule(String completeKey)
void	disablePluginWithoutPersisting(String key)
void	earlyStartup() Perform the first part of startup.
void	enablePluginModule(String completeKey)
void	enablePlugins(String... keys) Enable a set of plugins by key.
PluginsClassLoader	getClassLoader()
Iterable<ModuleDescriptor<?>>	getDynamicModules(Plugin maybePluginInternal)
Class<?>	getDynamicPluginClass(String className)
InputStream	getDynamicResourceAsStream(String name)
<D extends ModuleDescriptor<?>> List<D>	getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz) This method has been reverted to pre PLUG-40 to fix performance issues that were encountered during load testing.
<M> List<M>	getEnabledModulesByClass(Class<M> moduleClass)
Plugin	getEnabledPlugin(String pluginKey)
ModuleDescriptor<?>	getEnabledPluginModule(String completeKey)
Collection<Plugin>	getEnabledPlugins()
static String	getLateStartupEnableRetryProperty()
static String	getMinimumPluginVersionsFileProperty()
<M> Collection<ModuleDescriptor<M>>	getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)
<M> Collection<M>	getModules(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)
Plugin	getPlugin(String key)
ModuleDescriptor<?>	getPluginModule(String completeKey)
PluginRestartState	getPluginRestartState(String key)
Collection<Plugin>	getPlugins()
Collection<Plugin>	getPlugins(Predicate<Plugin> pluginPredicate)
static String	getStartupOverrideFileProperty()
protected PluginPersistentState	getState()
void	init()
Set<String>	installPlugins(PluginArtifact... pluginArtifacts)
boolean	isPluginEnabled(String key) This method checks to see if the plugin is enabled based on the state manager and the plugin.
boolean	isPluginModuleEnabled(String completeKey)
boolean	isSystemPlugin(String key)
void	lateStartup() Perform the second part of startup.
static DefaultPluginManager.Builder<? extends DefaultPluginManager.Builder<?>>	newBuilder()
protected void	notifyModuleDisabled(ModuleDescriptor<?> module)
protected void	notifyModuleEnabled(ModuleDescriptor<?> module)
protected void	notifyUninstallPlugin(Plugin plugin)
void	onPluginContainerUnavailable(PluginContainerUnavailableEvent event)
void	onPluginModuleAvailable(PluginModuleAvailableEvent event)
void	onPluginModuleUnavailable(PluginModuleUnavailableEvent event)
void	onPluginRefresh(PluginRefreshedEvent event)
protected void	onUpdateRequiresRestartState(String pluginKey, PluginRestartState pluginRestartState)
void	removeDynamicModule(Plugin maybePluginInternal, ModuleDescriptor<?> module)
protected void	removeStateFromStore(PluginPersistentStateStore stateStore, Plugin plugin)
void	revertRestartRequiredChange(String pluginKey)
int	scanForNewPlugins()
void	setPluginInstaller(PluginInstaller pluginInstaller) Set the plugin installation strategy for this manager
void	shutdown() Fires the shutdown event
void	uninstall(Plugin plugin) Uninstalls the given plugin, emitting disabled and uninstalled events as it does so.
protected void	uninstallNoEvent(Plugin plugin) Preforms an uninstallation without broadcasting the uninstallation event.
void	uninstallPlugins(Collection<Plugin> plugins)
protected void	unloadPlugin(Plugin plugin) Unload a plugin.
protected void	updatePlugin(Plugin oldPlugin, Plugin newPlugin) Replace an already loaded plugin with another version.
void	warmRestart()

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.PluginAccessor

getActiveModuleDescriptorsByClass, getModuleDescriptors, getModules, getPlugins

Constructor Detail

DefaultPluginManager

public DefaultPluginManager(PluginPersistentStateStore store,
                            List<PluginLoader> pluginLoaders,
                            ModuleDescriptorFactory moduleDescriptorFactory,
                            PluginEventManager pluginEventManager)

DefaultPluginManager

public DefaultPluginManager(PluginPersistentStateStore store,
                            List<PluginLoader> pluginLoaders,
                            ModuleDescriptorFactory moduleDescriptorFactory,
                            PluginEventManager pluginEventManager,
                            PluginExceptionInterception pluginExceptionInterception)

DefaultPluginManager

public DefaultPluginManager(PluginPersistentStateStore store,
                            List<PluginLoader> pluginLoaders,
                            ModuleDescriptorFactory moduleDescriptorFactory,
                            PluginEventManager pluginEventManager,
                            boolean verifyRequiredPlugins)

DefaultPluginManager

@ExperimentalApi
public DefaultPluginManager(PluginPersistentStateStore store,
                                             List<PluginLoader> pluginLoaders,
                                             ModuleDescriptorFactory moduleDescriptorFactory,
                                             PluginEventManager pluginEventManager,
                                             Predicate<Plugin> delayLoadOf)

DefaultPluginManager

@ExperimentalApi
public DefaultPluginManager(PluginPersistentStateStore store,
                                             List<PluginLoader> pluginLoaders,
                                             ModuleDescriptorFactory moduleDescriptorFactory,
                                             PluginEventManager pluginEventManager,
                                             PluginExceptionInterception pluginExceptionInterception,
                                             Predicate<Plugin> delayLoadOf)

DefaultPluginManager

public DefaultPluginManager(PluginPersistentStateStore store,
                            List<PluginLoader> pluginLoaders,
                            ModuleDescriptorFactory moduleDescriptorFactory,
                            PluginEventManager pluginEventManager,
                            PluginExceptionInterception pluginExceptionInterception,
                            boolean verifyRequiredPlugins)

DefaultPluginManager

public DefaultPluginManager(PluginPersistentStateStore store,
                            List<PluginLoader> pluginLoaders,
                            ModuleDescriptorFactory moduleDescriptorFactory,
                            PluginEventManager pluginEventManager,
                            PluginExceptionInterception pluginExceptionInterception,
                            boolean verifyRequiredPlugins,
                            Predicate<Plugin> delayLoadOf)

DefaultPluginManager

protected DefaultPluginManager(DefaultPluginManager.Builder<? extends DefaultPluginManager.Builder> builder)

Method Detail

getStartupOverrideFileProperty

@Internal
public static String getStartupOverrideFileProperty()

getLateStartupEnableRetryProperty

@Internal
public static String getLateStartupEnableRetryProperty()

getMinimumPluginVersionsFileProperty

@Internal
public static String getMinimumPluginVersionsFileProperty()

newBuilder

public static DefaultPluginManager.Builder<? extends DefaultPluginManager.Builder<?>> newBuilder()

init

public void init()
          throws PluginParseException,
                 NotificationException

Specified by:

init in interface PluginSystemLifecycle

Throws:

PluginParseException

NotificationException

earlyStartup

@ExperimentalApi
public void earlyStartup()
                                   throws PluginParseException,
                                          NotificationException

Description copied from interface: SplitStartupPluginSystemLifecycle

Perform the first part of startup. This initializes the plugin system, and installs and enables early plugins.

Specified by:

earlyStartup in interface SplitStartupPluginSystemLifecycle

Throws:

PluginParseException - If parsing the plugins failed.

NotificationException - If any of the Event Listeners throw an exception on the Framework startup events.

See Also:

PluginSystemLifecycle.init()

lateStartup

@ExperimentalApi
public void lateStartup()
                                  throws PluginParseException,
                                         NotificationException

Description copied from interface: SplitStartupPluginSystemLifecycle

Perform the second part of startup. This installs and enables late plugins, and performs any final validation steps. This may only be called after SplitStartupPluginSystemLifecycle.earlyStartup(), and calling both earlyStartup and lateStartup is equivalent to calling PluginSystemLifecycle.init().

Specified by:

lateStartup in interface SplitStartupPluginSystemLifecycle

Throws:

PluginParseException - If parsing the plugins failed.

NotificationException - If any of the Event Listeners throw an exception on the Framework startup events.

See Also:

PluginSystemLifecycle.init()

shutdown

public void shutdown()

Fires the shutdown event

Specified by:

shutdown in interface PluginSystemLifecycle

Throws:

IllegalStateException - if already shutdown or already in the process of shutting down.

Since:

2.0.0

warmRestart

public final void warmRestart()

Specified by:

warmRestart in interface PluginSystemLifecycle

onPluginModuleAvailable

public void onPluginModuleAvailable(PluginModuleAvailableEvent event)

onPluginModuleUnavailable

public void onPluginModuleUnavailable(PluginModuleUnavailableEvent event)

onPluginContainerUnavailable

public void onPluginContainerUnavailable(PluginContainerUnavailableEvent event)

onPluginRefresh

public void onPluginRefresh(PluginRefreshedEvent event)

setPluginInstaller

public void setPluginInstaller(PluginInstaller pluginInstaller)

Set the plugin installation strategy for this manager

Parameters:

pluginInstaller - the plugin installation strategy to use

See Also:

PluginInstaller

installPlugins

public Set<String> installPlugins(PluginArtifact... pluginArtifacts)
                           throws PluginParseException

Specified by:

installPlugins in interface PluginController

Throws:

PluginParseException

scanForNewPlugins

public int scanForNewPlugins()
                      throws PluginParseException

Specified by:

scanForNewPlugins in interface PluginController

Throws:

PluginParseException

onUpdateRequiresRestartState

protected void onUpdateRequiresRestartState(String pluginKey,
                                            PluginRestartState pluginRestartState)

uninstall

public void uninstall(Plugin plugin)
               throws PluginException

Uninstalls the given plugin, emitting disabled and uninstalled events as it does so.

Specified by:

uninstall in interface PluginController

Parameters:

plugin - the plugin to uninstall.

Throws:

PluginException - If the plugin or loader doesn't support uninstallation

uninstallPlugins

public void uninstallPlugins(Collection<Plugin> plugins)
                      throws PluginException

Specified by:

uninstallPlugins in interface PluginController

Throws:

PluginException

uninstallNoEvent

protected void uninstallNoEvent(Plugin plugin)

Preforms an uninstallation without broadcasting the uninstallation event.

Parameters:

plugin - The plugin to uninstall

Since:

2.5.0

revertRestartRequiredChange

public void revertRestartRequiredChange(String pluginKey)
                                 throws PluginException

Specified by:

revertRestartRequiredChange in interface PluginController

Parameters:

pluginKey - The plugin key to revert

Throws:

PluginException - If the revert cannot be completed

removeStateFromStore

protected void removeStateFromStore(PluginPersistentStateStore stateStore,
                                    Plugin plugin)

unloadPlugin

protected void unloadPlugin(Plugin plugin)
                     throws PluginException

Unload a plugin. Called when plugins are added locally, or remotely in a clustered application.

Parameters:

plugin - the plugin to remove

Throws:

PluginException - if the plugin cannot be uninstalled

notifyUninstallPlugin

protected void notifyUninstallPlugin(Plugin plugin)

getState

protected PluginPersistentState getState()

addPlugins

protected void addPlugins(@Nullable
                          PluginLoader loader,
                          Collection<Plugin> pluginsToInstall)
                   throws PluginParseException

Update the local plugin state and enable state aware modules.

If there is an existing plugin with the same key, the version strings of the existing plugin and the plugin provided to this method will be parsed and compared. If the installed version is newer than the provided version, it will not be changed. If the specified plugin's version is the same or newer, the existing plugin state will be saved and the plugin will be unloaded before the provided plugin is installed. If the existing plugin cannot be unloaded a PluginException will be thrown.

Parameters:

loader - the loader used to load this plugin. This should only be null when called internally from init(), in which case the loader is looked up per plugin in candidatePluginsToPluginLoader.

pluginsToInstall - the plugins to add

Throws:

PluginParseException - if the plugin cannot be parsed

Since:

2.0.2

updatePlugin

protected void updatePlugin(Plugin oldPlugin,
                            Plugin newPlugin)
                     throws PluginException

Replace an already loaded plugin with another version. Relevant stored configuration for the plugin will be preserved.

Parameters:

oldPlugin - Plugin to replace

newPlugin - New plugin to install

Throws:

PluginException - if the plugin cannot be updated

getPlugins

public Collection<Plugin> getPlugins()

Specified by:

getPlugins in interface PluginAccessor

getPlugins

public Collection<Plugin> getPlugins(Predicate<Plugin> pluginPredicate)

Specified by:

getPlugins in interface PluginAccessor

Since:

0.17

See Also:

PluginAccessor.getPlugins(Predicate)

getEnabledPlugins

public Collection<Plugin> getEnabledPlugins()

Specified by:

getEnabledPlugins in interface PluginAccessor

See Also:

PluginAccessor.getEnabledPlugins()

getModules

public <M> Collection<M> getModules(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)

Specified by:

getModules in interface PluginAccessor

Since:

0.17

See Also:

PluginAccessor.getModules(Predicate)

getModuleDescriptors

public <M> Collection<ModuleDescriptor<M>> getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)

Specified by:

getModuleDescriptors in interface PluginAccessor

Since:

0.17

See Also:

PluginAccessor.getModuleDescriptors(Predicate)

getPlugin

public Plugin getPlugin(String key)

Specified by:

getPlugin in interface PluginAccessor

getEnabledPlugin

public Plugin getEnabledPlugin(String pluginKey)

Specified by:

getEnabledPlugin in interface PluginAccessor

getPluginModule

public ModuleDescriptor<?> getPluginModule(String completeKey)

Specified by:

getPluginModule in interface PluginAccessor

getEnabledPluginModule

public ModuleDescriptor<?> getEnabledPluginModule(String completeKey)

Specified by:

getEnabledPluginModule in interface PluginAccessor

getEnabledModulesByClass

public <M> List<M> getEnabledModulesByClass(Class<M> moduleClass)

Specified by:

getEnabledModulesByClass in interface PluginAccessor

See Also:

PluginAccessor.getEnabledModulesByClass(Class)

getEnabledModuleDescriptorsByClass

public <D extends ModuleDescriptor<?>> List<D> getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)

This method has been reverted to pre PLUG-40 to fix performance issues that were encountered during load testing. This should be reverted to the state it was in at 54639 when the fundamental issue leading to this slowdown has been corrected (that is, slowness of PluginClassLoader).

Specified by:

getEnabledModuleDescriptorsByClass in interface PluginAccessor

See Also:

PluginAccessor.getEnabledModuleDescriptorsByClass(Class)

enablePlugins

public void enablePlugins(String... keys)

Enable a set of plugins by key. This will implicitly and recursively enable all dependent plugins.

Specified by:

enablePlugins in interface PluginController

Parameters:

keys - The plugin keys. Must not be null.

Since:

2.5.0

disablePlugin

public void disablePlugin(String key)

Specified by:

disablePlugin in interface PluginController

disablePluginWithoutPersisting

public void disablePluginWithoutPersisting(String key)

Specified by:

disablePluginWithoutPersisting in interface PluginController

disablePluginInternal

protected void disablePluginInternal(String key,
                                     boolean persistDisabledState)

disablePluginModule

public void disablePluginModule(String completeKey)

Specified by:

disablePluginModule in interface PluginController

notifyModuleDisabled

protected void notifyModuleDisabled(ModuleDescriptor<?> module)

enablePluginModule

public void enablePluginModule(String completeKey)

Specified by:

enablePluginModule in interface PluginController

notifyModuleEnabled

protected void notifyModuleEnabled(ModuleDescriptor<?> module)

isPluginModuleEnabled

public boolean isPluginModuleEnabled(String completeKey)

Specified by:

isPluginModuleEnabled in interface PluginAccessor

isPluginEnabled

public boolean isPluginEnabled(String key)

This method checks to see if the plugin is enabled based on the state manager and the plugin.

Specified by:

isPluginEnabled in interface PluginAccessor

Parameters:

key - The plugin key

Returns:

True if the plugin is enabled

getDynamicResourceAsStream

public InputStream getDynamicResourceAsStream(String name)

Specified by:

getDynamicResourceAsStream in interface PluginAccessor

getDynamicPluginClass

public Class<?> getDynamicPluginClass(String className)
                               throws ClassNotFoundException

Throws:

ClassNotFoundException

getClassLoader

public PluginsClassLoader getClassLoader()

Specified by:

getClassLoader in interface PluginAccessor

isSystemPlugin

public boolean isSystemPlugin(String key)

Specified by:

isSystemPlugin in interface PluginAccessor

getPluginRestartState

public PluginRestartState getPluginRestartState(String key)

Specified by:

getPluginRestartState in interface PluginAccessor

addDynamicModule

public ModuleDescriptor<?> addDynamicModule(Plugin maybePluginInternal,
                                            org.dom4j.Element module)

Specified by:

addDynamicModule in interface PluginController

getDynamicModules

public Iterable<ModuleDescriptor<?>> getDynamicModules(Plugin maybePluginInternal)

Specified by:

getDynamicModules in interface PluginAccessor

removeDynamicModule

public void removeDynamicModule(Plugin maybePluginInternal,
                                ModuleDescriptor<?> module)

Specified by:

removeDynamicModule in interface PluginController