com.atlassian.plugin.manager

Class EnabledModuleCachingPluginAccessor

java.lang.Object

com.atlassian.plugin.manager.EnabledModuleCachingPluginAccessor

All Implemented Interfaces:

PluginAccessor

public final class EnabledModuleCachingPluginAccessor
extends Object
implements PluginAccessor

A caching decorator which caches getEnabledModuleDescriptorsByClass(Class) and getEnabledModulesByClass(Class) on PluginAccessor interface.

Nested Class Summary

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

PluginAccessor.Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected PluginAccessor	delegate

Constructor Summary

Constructors

Constructor and Description
EnabledModuleCachingPluginAccessor(PluginAccessor delegate, PluginEventManager pluginEventManager, PluginController pluginController)

Method Summary

Modifier and Type	Method and Description
<D extends ModuleDescriptor<?>> List<D>	getActiveModuleDescriptorsByClass(Class<D> descriptorClazz) Get all enabled module descriptors that have a specific descriptor class and are considered active for the current request.
ClassLoader	getClassLoader() Retrieve the class loader responsible for loading classes and resources from plugins.
Iterable<ModuleDescriptor<?>>	getDynamicModules(Plugin plugin) Retrieve all currently registered dynamic modules i.e.
InputStream	getDynamicResourceAsStream(String resourcePath) Retrieve a resource from a currently loaded (and active) dynamically loaded plugin.
<D extends ModuleDescriptor<?>> List<D>	getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz) This method overrides the same method on PluginAccessor from the plugin system.
<M> List<M>	getEnabledModulesByClass(Class<M> moduleClass) This method overrides the same method on PluginAccessor from the plugin system.
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.
<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.
boolean	isPluginEnabled(String key) Whether or not a given plugin is currently enabled.
boolean	isPluginModuleEnabled(String completeKey) Whether or not a given plugin module is currently enabled.
boolean	isSystemPlugin(String key)
void	onPluginDisable(PluginDisabledEvent event) Clears the enabled module cache when any plugin is disabled.
void	onPluginEnable(PluginEnabledEvent event) Clears the cache when any plugin is enabled.
void	onPluginFrameworkShutdown(PluginFrameworkShutdownEvent event)
void	onPluginModuleDisabled(PluginModuleDisabledEvent event)
void	onPluginModuleEnabled(PluginModuleEnabledEvent event)

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, getClassLoader, getDynamicModules, getDynamicResourceAsStream, getEnabledPlugin, getEnabledPluginModule, getEnabledPlugins, getModuleDescriptors, getModuleDescriptors, getModules, getModules, getPlugin, getPluginModule, getPluginRestartState, getPlugins, getPlugins, getPlugins, isPluginEnabled, isPluginModuleEnabled, isSystemPlugin

Field Detail

delegate

protected final PluginAccessor delegate

Constructor Detail

EnabledModuleCachingPluginAccessor

public EnabledModuleCachingPluginAccessor(PluginAccessor delegate,
                                          PluginEventManager pluginEventManager,
                                          PluginController pluginController)

Method Detail

onPluginDisable

public void onPluginDisable(PluginDisabledEvent event)

Clears the enabled module cache when any plugin is disabled. This ensures old modules are never returned from disabled plugins.

Parameters:

event - The plugin disabled event

onPluginEnable

public void onPluginEnable(PluginEnabledEvent event)

Clears the cache when any plugin is enabled.

onPluginModuleEnabled

public void onPluginModuleEnabled(PluginModuleEnabledEvent event)

onPluginModuleDisabled

public void onPluginModuleDisabled(PluginModuleDisabledEvent event)

onPluginFrameworkShutdown

public void onPluginFrameworkShutdown(PluginFrameworkShutdownEvent event)

getEnabledModuleDescriptorsByClass

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

This method overrides the same method on PluginAccessor from the plugin system. We keep an up to date cache of (module descriptor class M -> collection of module descriptors of descriptor class M) so we can avoid the expensive call to the plugin system.

Specified by:

getEnabledModuleDescriptorsByClass in interface PluginAccessor

Parameters:

descriptorClazz - The module descriptor class you wish to find all enabled instances of

Returns:

A list of all instances of enabled plugin module descriptors of the specified descriptor class

getEnabledModulesByClass

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

This method overrides the same method on PluginAccessor from the plugin system. We keep an up to date cache of (module class M -> collection of module descriptors that have module class M) so we can avoid the expensive call to the plugin system.

Specified by:

getEnabledModulesByClass in interface PluginAccessor

Parameters:

moduleClass - The module class you wish to find all instances of

Returns:

A list of all instances of enabled plugin modules of the specified class

getClassLoader

public ClassLoader 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

getDynamicResourceAsStream

public InputStream getDynamicResourceAsStream(String resourcePath)

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:

resourcePath - the path to the resource to retrieve

Returns:

the dynamically loaded resource that matches that path, or null if no such resource is found

getActiveModuleDescriptorsByClass

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

Description copied from interface: PluginAccessor

Get all enabled module descriptors that have a specific descriptor class and are considered active for the current request.

Result of this method should not be cached across requests.

Specified by:

getActiveModuleDescriptorsByClass in interface PluginAccessor

Parameters:

descriptorClazz - module descriptor class

Returns:

List of ModuleDescriptors that implement or extend the given class and active for the current request.

See Also:

ScopeManager

getEnabledPlugin

public Plugin getEnabledPlugin(String pluginKey)
                        throws IllegalArgumentException

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.

Throws:

IllegalArgumentException - If the plugin key is null

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

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.

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.

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.

getPlugin

public Plugin getPlugin(String key)
                 throws IllegalArgumentException

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.

Throws:

IllegalArgumentException - If the plugin key is null

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

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

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.

isPluginEnabled

public boolean isPluginEnabled(String key)
                        throws IllegalArgumentException

Description copied from interface: PluginAccessor

Whether or not a given plugin is currently enabled.

Specified by:

isPluginEnabled in interface PluginAccessor

Throws:

IllegalArgumentException - If the plugin key is null

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)

isSystemPlugin

public boolean isSystemPlugin(String key)

Specified by:

isSystemPlugin in interface PluginAccessor

Returns:

true if the plugin is a system plugin.

getDynamicModules

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

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:

plugin - to query

Returns:

modules added, may be empty

See Also:

PluginController.addDynamicModule(Plugin, org.dom4j.Element), PluginController.removeDynamicModule(Plugin, ModuleDescriptor)