DefaultPluginManager (Atlassian Plugins

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

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

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ModuleDescriptor<?>`	`addDynamicModule(Plugin maybePluginInternal, org.dom4j.Element module)` Add a new module described by `element` to the plugin specified.
`protected void`	`addPlugins(PluginLoader loader, Collection<Plugin> pluginsToInstall)` Update the local plugin state and enable state aware modules.
`void`	`disablePlugin(String key)` Disables the plugin with the given key.
`protected void`	`disablePluginInternal(String key, boolean persistDisabledState)`
`void`	`disablePluginModule(String completeKey)` Disable a plugin module by key.
`void`	`disablePluginWithoutPersisting(String key)` Disables the plugin with the given key without persisting the disabled state.
`void`	`earlyStartup()` Perform the first part of startup.
`void`	`enablePluginModule(String completeKey)` Enable a plugin module by key.
`void`	`enablePlugins(String... keys)` Enable a set of plugins by key.
`PluginsClassLoader`	`getClassLoader()` Retrieve the class loader responsible for loading classes and resources from plugins.
`Iterable<ModuleDescriptor<?>>`	`getDynamicModules(Plugin maybePluginInternal)` Retrieve all currently registered dynamic modules i.e.
`Class<?>`	`getDynamicPluginClass(String className)`
`InputStream`	`getDynamicResourceAsStream(String name)` Retrieve a resource from a currently loaded (and active) dynamically loaded plugin.
`<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)` Retrieve all plugin modules that implement or extend a specific class.
`Plugin`	`getEnabledPlugin(String pluginKey)` Retrieve a given plugin if it is enabled.
`ModuleDescriptor<?>`	`getEnabledPluginModule(String completeKey)` Retrieve an enabled plugin module by complete module key.
`Collection<Plugin>`	`getEnabledPlugins()` Get all of the currently enabled plugins.
`static String`	`getLateStartupEnableRetryProperty()`
`static String`	`getMinimumPluginVersionsFileProperty()`
`<M> Collection<ModuleDescriptor<M>>`	`getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)` Gets all module descriptors of installed modules that match the given predicate.
`<M> Collection<M>`	`getModules(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)` Gets all installed modules that match the given predicate.
`Plugin`	`getPlugin(String key)` Retrieve a given plugin (whether enabled or not).
`ModuleDescriptor<?>`	`getPluginModule(String completeKey)` Retrieve any plugin module by complete module key.
`PluginRestartState`	`getPluginRestartState(String key)` Gets the state of the plugin upon restart.
`Collection<Plugin>`	`getPlugins()` Gets all of the currently installed plugins.
`Collection<Plugin>`	`getPlugins(Predicate<Plugin> pluginPredicate)` Gets all installed plugins that match the given predicate.
`static String`	`getStartupOverrideFileProperty()`
`protected PluginPersistentState`	`getState()`
`void`	`init()` Initialise the plugin system.
`Set<String>`	`installPlugins(PluginArtifact... pluginArtifacts)` Installs multiple plugins and returns the list of plugin keys.
`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)` Whether or not a given plugin module is currently enabled.
`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)` Remove a module that was dynamically added to plugin..
`protected void`	`removeStateFromStore(PluginPersistentStateStore stateStore, Plugin plugin)`
`void`	`revertRestartRequiredChange(String pluginKey)` Restores the state of any plugin requiring a restart that had been removed, upgraded, or installed.
`int`	`scanForNewPlugins()` Search all loaders and add any new plugins you find.
`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)` Uninstall multiple plugin, disabling it first.
`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()` Restart all plugins by disabling and enabling them in the order they were loaded (by plugin loader)

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
```
    Description copied from interface: PluginSystemLifecycle
    
    Initialise the plugin system. This must be called before anything else.
    
    Specified by:
    
    init in interface PluginSystemLifecycle
    
    Throws:
    
    PluginParseException - If parsing the plugins failed.
    
    NotificationException - If any of the Event Listeners throw an exception on the Framework startup events.
  - 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()
```
    Description copied from interface: PluginSystemLifecycle
    
    Restart all plugins by disabling and enabling them in the order they were loaded (by plugin loader)
    
    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
```
    Description copied from interface: PluginController
    
    Installs multiple plugins and returns the list of plugin keys. All plugin artifacts must be for valid plugins or none will be installed.
    
    Specified by:
    
    installPlugins in interface PluginController
    
    Parameters:
    
    pluginArtifacts - The list of plugin artifacts to install
    
    Returns:
    
    A list of plugin keys
    
    Throws:
    
    PluginParseException - if any plugin is not a valid plugin
  - scanForNewPlugins
```
public int scanForNewPlugins()
                      throws PluginParseException
```
    Description copied from interface: PluginController
    
    Search all loaders and add any new plugins you find.
    
    Specified by:
    
    scanForNewPlugins in interface PluginController
    
    Returns:
    
    The number of new plugins found.
    
    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
```
    Description copied from interface: PluginController
    
    Uninstall multiple plugin, disabling it first.
    
    Specified by:
    
    uninstallPlugins in interface PluginController
    
    Parameters:
    
    plugins - The plugins to uninstall.
    
    Throws:
    
    PluginException - if there was some problem uninstalling a plugin.
  - 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
```
    Description copied from interface: PluginController
    
    Restores the state of any plugin requiring a restart that had been removed, upgraded, or installed. If marked as removed, the mark will be deleted. If marked as upgrade, an attempt to restore the original plugin artifact will be made. If marked as install, the artifact will be deleted.
    
    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()
```
    Description copied from interface: PluginAccessor
    
    Gets all of the currently installed plugins.
    
    Specified by:
    
    getPlugins in interface PluginAccessor
    
    Returns:
    
    a collection of installed Plugins.
  - getPlugins
```
public Collection<Plugin> getPlugins(Predicate<Plugin> pluginPredicate)
```
    Description copied from interface: PluginAccessor
    
    Gets all installed plugins that match the given predicate.
    
    Specified by:
    
    getPlugins in interface PluginAccessor
    
    Parameters:
    
    pluginPredicate - the Predicate describing which plugins to match.
    
    Returns:
    
    a collection of Plugins that match the given predicate.
    
    Since:
    
    0.17
    
    See Also:
    
    PluginAccessor.getPlugins(Predicate)
  - getEnabledPlugins
```
public Collection<Plugin> getEnabledPlugins()
```
    Description copied from interface: PluginAccessor
    
    Get all of the currently enabled plugins.
    
    Specified by:
    
    getEnabledPlugins in interface PluginAccessor
    
    Returns:
    
    a collection of installed and enabled Plugins.
    
    See Also:
    
    PluginAccessor.getEnabledPlugins()
  - getModules
```
public <M> Collection<M> getModules(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)
```
    Description copied from interface: PluginAccessor
    
    Gets all installed modules that match the given predicate.
    
    Specified by:
    
    getModules in interface PluginAccessor
    
    Parameters:
    
    moduleDescriptorPredicate - describes which modules to match
    
    Returns:
    
    a collection of modules as per ModuleDescriptor.getModule() that match the given predicate.
    
    Since:
    
    0.17
    
    See Also:
    
    PluginAccessor.getModules(Predicate)
  - getModuleDescriptors
```
public <M> Collection<ModuleDescriptor<M>> getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate)
```
    Description copied from interface: PluginAccessor
    
    Gets all module descriptors of installed modules that match the given predicate.
    
    Specified by:
    
    getModuleDescriptors in interface PluginAccessor
    
    Parameters:
    
    moduleDescriptorPredicate - describes which modules to match
    
    Returns:
    
    a collection of ModuleDescriptors that match the given predicate.
    
    Since:
    
    0.17
    
    See Also:
    
    PluginAccessor.getModuleDescriptors(Predicate)
  - getPlugin
```
public Plugin getPlugin(String key)
```
    Description copied from interface: PluginAccessor
    
    Retrieve a given plugin (whether enabled or not).
    
    Specified by:
    
    getPlugin in interface PluginAccessor
    
    Parameters:
    
    key - The plugin key. Cannot be null.
    
    Returns:
    
    The enabled plugin, or null if that plugin does not exist.
  - getEnabledPlugin
```
public Plugin getEnabledPlugin(String pluginKey)
```
    Description copied from interface: PluginAccessor
    
    Retrieve a given plugin if it is enabled.
    
    Specified by:
    
    getEnabledPlugin in interface PluginAccessor
    
    Returns:
    
    The enabled plugin, or null if that plugin does not exist or is disabled.
  - getPluginModule
```
public ModuleDescriptor<?> getPluginModule(String completeKey)
```
    Description copied from interface: PluginAccessor
    
    Retrieve any plugin module by complete module key.
    Note: the module may or may not be disabled.
    
    Specified by:
    
    getPluginModule in interface PluginAccessor
  - getEnabledPluginModule
```
public ModuleDescriptor<?> getEnabledPluginModule(String completeKey)
```
    Description copied from interface: PluginAccessor
    
    Retrieve an enabled plugin module by complete module key.
    
    Specified by:
    
    getEnabledPluginModule in interface PluginAccessor
  - getEnabledModulesByClass
```
public <M> List<M> getEnabledModulesByClass(Class<M> moduleClass)
```
    Description copied from interface: PluginAccessor
    
    Retrieve all plugin modules that implement or extend a specific class.
    
    Specified by:
    
    getEnabledModulesByClass in interface PluginAccessor
    
    Returns:
    
    List of modules that implement or extend the given class.
    
    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
    
    Parameters:
    
    descriptorClazz - module descriptor class
    
    Returns:
    
    List of ModuleDescriptors that implement or extend the given class.
    
    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)
```
    Description copied from interface: PluginController
    
    Disables the plugin with the given key.
    Calling this method will persist the disabled state so that the plugin will also be disabled on next startup. This would normally be used when a user manually disables a plugin.
    If you extend DefaultPluginManager and override this method, you will also need to override PluginController.disablePluginWithoutPersisting(String).
    Mandatory dependent plugins will also be disabled. Optionally dependent plugins will be disabled then enabled. Dynamically dependent plugins will not be disabled.
    
    Specified by:
    
    disablePlugin in interface PluginController
    
    Parameters:
    
    key - The plugin key.
    
    See Also:
    
    PluginController.disablePluginWithoutPersisting(String), Plugin.getDependencies()
  - disablePluginWithoutPersisting
```
public void disablePluginWithoutPersisting(String key)
```
    Description copied from interface: PluginController
    
    Disables the plugin with the given key without persisting the disabled state.
    Calling this method will NOT persist the disabled state so that the framework will try to enable the plugin on next startup. This is used when a plugin has errors on startup.
    If you extend DefaultPluginManager and override PluginController.disablePlugin(String), you will also need to override this method.
    Mandatory dependent plugins will also be disabled. Optionally dependent plugins will be disabled then enabled. Dynamically dependent plugins will not be disabled.
    
    Specified by:
    
    disablePluginWithoutPersisting in interface PluginController
    
    Parameters:
    
    key - The plugin key.
    
    See Also:
    
    PluginController.disablePlugin(String), Plugin.getDependencies()
  - disablePluginInternal
```
protected void disablePluginInternal(String key,
                                     boolean persistDisabledState)
```
  - disablePluginModule
```
public void disablePluginModule(String completeKey)
```
    Description copied from interface: PluginController
    
    Disable a plugin module by key.
    
    Specified by:
    
    disablePluginModule in interface PluginController
    
    Parameters:
    
    completeKey - The "complete key" of the plugin module.
  - notifyModuleDisabled
```
protected void notifyModuleDisabled(ModuleDescriptor<?> module)
```
  - enablePluginModule
```
public void enablePluginModule(String completeKey)
```
    Description copied from interface: PluginController
    
    Enable a plugin module by key.
    
    Specified by:
    
    enablePluginModule in interface PluginController
    
    Parameters:
    
    completeKey - The "complete key" of the plugin module.
  - notifyModuleEnabled
```
protected void notifyModuleEnabled(ModuleDescriptor<?> module)
```
  - isPluginModuleEnabled
```
public boolean isPluginModuleEnabled(String completeKey)
```
    Description copied from interface: PluginAccessor
    
    Whether or not a given plugin module is currently enabled. This also checks if the plugin it is contained within is enabled also
    
    Specified by:
    
    isPluginModuleEnabled in interface PluginAccessor
    
    See Also:
    
    PluginAccessor.isPluginEnabled(String)
  - 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)
```
    Description copied from interface: PluginAccessor
    
    Retrieve a resource from a currently loaded (and active) dynamically loaded plugin. Will return the first resource found, so plugins with overlapping resource names will behave erratically.
    
    Specified by:
    
    getDynamicResourceAsStream in interface PluginAccessor
    
    Parameters:
    
    name - the path to the resource to retrieve
    
    Returns:
    
    the dynamically loaded resource that matches that path, or null if no such resource is found
  - getDynamicPluginClass
```
public Class<?> getDynamicPluginClass(String className)
                               throws ClassNotFoundException
```
    Throws:
    
    ClassNotFoundException
  - getClassLoader
```
public PluginsClassLoader getClassLoader()
```
    Description copied from interface: PluginAccessor
    
    Retrieve the class loader responsible for loading classes and resources from plugins.
    
    Specified by:
    
    getClassLoader in interface PluginAccessor
    
    Returns:
    
    the class loader
  - isSystemPlugin
```
public boolean isSystemPlugin(String key)
```
    Specified by:
    
    isSystemPlugin in interface PluginAccessor
    
    Returns:
    
    true if the plugin is a system plugin.
  - getPluginRestartState
```
public PluginRestartState getPluginRestartState(String key)
```
    Description copied from interface: PluginAccessor
    
    Gets the state of the plugin upon restart. Only useful for plugins that contain module descriptors with the \@RestartRequired annotation, and therefore, cannot be dynamically installed, upgraded, or removed at runtime
    
    Specified by:
    
    getPluginRestartState in interface PluginAccessor
    
    Parameters:
    
    key - The plugin key
    
    Returns:
    
    The state of the plugin on restart
  - addDynamicModule
```
public ModuleDescriptor<?> addDynamicModule(Plugin maybePluginInternal,
                                            org.dom4j.Element module)
```
    Description copied from interface: PluginController
    Add a new module described by element to the plugin specified.
    Module will be enabled if the following conditions are met:
    - ModuleDescriptor.isEnabledByDefault() returns true
    - This module has not been marked as disabled elsewhere, e.g. by user
    Specified by:
    
    addDynamicModule in interface PluginController
    
    Parameters:
    
    maybePluginInternal - to add the module to
    
    module - to add
    
    Returns:
    
    added module
    
    See Also:
    
    PluginController.removeDynamicModule(Plugin, ModuleDescriptor), PluginAccessor.getDynamicModules(Plugin)
  - getDynamicModules
```
public Iterable<ModuleDescriptor<?>> getDynamicModules(Plugin maybePluginInternal)
```
    Description copied from interface: PluginAccessor
    
    Retrieve all currently registered dynamic modules i.e. any module that has been added to plugin via PluginController.addDynamicModule(Plugin, org.dom4j.Element) during the lifetime of this plugin, but not removed via PluginController.removeDynamicModule(Plugin, ModuleDescriptor).
    
    Specified by:
    
    getDynamicModules in interface PluginAccessor
    
    Parameters:
    
    maybePluginInternal - to query
    
    Returns:
    
    modules added, may be empty
    
    See Also:
    
    PluginController.addDynamicModule(Plugin, org.dom4j.Element), PluginController.removeDynamicModule(Plugin, ModuleDescriptor)
  - removeDynamicModule
```
public void removeDynamicModule(Plugin maybePluginInternal,
                                ModuleDescriptor<?> module)
```
    Description copied from interface: PluginController
    
    Remove a module that was dynamically added to plugin..
    
    Specified by:
    
    removeDynamicModule in interface PluginController
    
    Parameters:
    
    maybePluginInternal - to remove the module from
    
    module - to remove
    
    See Also:
    
    PluginController.addDynamicModule(Plugin, org.dom4j.Element), PluginAccessor.getDynamicModules(Plugin)

Class DefaultPluginManager

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.plugin.PluginAccessor

Constructor Detail

DefaultPluginManager

DefaultPluginManager

DefaultPluginManager

DefaultPluginManager

DefaultPluginManager

DefaultPluginManager

DefaultPluginManager

DefaultPluginManager

Method Detail

getStartupOverrideFileProperty

getLateStartupEnableRetryProperty

getMinimumPluginVersionsFileProperty

newBuilder

init

earlyStartup

lateStartup

shutdown

warmRestart

onPluginModuleAvailable

onPluginModuleUnavailable

onPluginContainerUnavailable

onPluginRefresh

setPluginInstaller

installPlugins

scanForNewPlugins

onUpdateRequiresRestartState

uninstall

uninstallPlugins

uninstallNoEvent

revertRestartRequiredChange

removeStateFromStore

unloadPlugin

notifyUninstallPlugin

getState

addPlugins

updatePlugin

getPlugins

getPlugins

getEnabledPlugins

getModules

getModuleDescriptors

getPlugin

getEnabledPlugin

getPluginModule

getEnabledPluginModule

getEnabledModulesByClass

getEnabledModuleDescriptorsByClass

enablePlugins

disablePlugin

disablePluginWithoutPersisting

disablePluginInternal

disablePluginModule

notifyModuleDisabled

enablePluginModule

notifyModuleEnabled

isPluginModuleEnabled

isPluginEnabled

getDynamicResourceAsStream

getDynamicPluginClass

getClassLoader

isSystemPlugin

getPluginRestartState

addDynamicModule

getDynamicModules

removeDynamicModule