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)
ClassLoader	getClassLoader()
Iterable<ModuleDescriptor<?>>	getDynamicModules(Plugin plugin)
Class<?>	getDynamicPluginClass(String className) Deprecated.
InputStream	getDynamicResourceAsStream(String resourcePath)
<D extends ModuleDescriptor<?>> List<D>	getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz) This method overrides the same method on PluginAccessor from the plugin system.
<D extends ModuleDescriptor<?>> List<D>	getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz, boolean verbose) Deprecated.
<M> List<ModuleDescriptor<M>>	getEnabledModuleDescriptorsByType(String type) Deprecated.
<M> List<M>	getEnabledModulesByClass(Class<M> moduleClass) This method overrides the same method on PluginAccessor from the plugin system.
<M> List<M>	getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>>[] descriptorClazz, Class<M> moduleClass) Deprecated.
<M> List<M>	getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>> descriptorClass, Class<M> moduleClass) Deprecated.
Plugin	getEnabledPlugin(String pluginKey)
ModuleDescriptor<?>	getEnabledPluginModule(String completeKey)
Collection<Plugin>	getEnabledPlugins()
<M> Collection<ModuleDescriptor<M>>	getModuleDescriptors(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)
<M> Collection<M>	getModules(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)
Plugin	getPlugin(String key)
ModuleDescriptor<?>	getPluginModule(String completeKey)
InputStream	getPluginResourceAsStream(String pluginKey, String resourcePath) Deprecated.
PluginRestartState	getPluginRestartState(String key)
Collection<Plugin>	getPlugins()
Collection<Plugin>	getPlugins(PluginPredicate pluginPredicate)
boolean	isPluginEnabled(String key)
boolean	isPluginModuleEnabled(String completeKey)
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, getDynamicPluginClass, getDynamicResourceAsStream, getEnabledModuleDescriptorsByClass, getEnabledModuleDescriptorsByType, getEnabledModulesByClassAndDescriptor, getEnabledModulesByClassAndDescriptor, getEnabledPlugin, getEnabledPluginModule, getEnabledPlugins, getModuleDescriptors, getModules, getPlugin, getPluginModule, getPluginResourceAsStream, getPluginRestartState, 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()

Specified by:

getClassLoader in interface PluginAccessor

getDynamicResourceAsStream

public InputStream getDynamicResourceAsStream(String resourcePath)

Specified by:

getDynamicResourceAsStream in interface PluginAccessor

getActiveModuleDescriptorsByClass

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

Specified by:

getActiveModuleDescriptorsByClass in interface PluginAccessor

getEnabledPlugin

public Plugin getEnabledPlugin(String pluginKey)
                        throws IllegalArgumentException

Specified by:

getEnabledPlugin in interface PluginAccessor

Throws:

IllegalArgumentException

getEnabledPluginModule

public ModuleDescriptor<?> getEnabledPluginModule(String completeKey)

Specified by:

getEnabledPluginModule in interface PluginAccessor

getEnabledPlugins

public Collection<Plugin> getEnabledPlugins()

Specified by:

getEnabledPlugins in interface PluginAccessor

getModuleDescriptors

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

Specified by:

getModuleDescriptors in interface PluginAccessor

getModules

public <M> Collection<M> getModules(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)

Specified by:

getModules in interface PluginAccessor

getPlugin

public Plugin getPlugin(String key)
                 throws IllegalArgumentException

Specified by:

getPlugin in interface PluginAccessor

Throws:

IllegalArgumentException

getPluginModule

public ModuleDescriptor<?> getPluginModule(String completeKey)

Specified by:

getPluginModule in interface PluginAccessor

getPluginRestartState

public PluginRestartState getPluginRestartState(String key)

Specified by:

getPluginRestartState in interface PluginAccessor

getPlugins

public Collection<Plugin> getPlugins()

Specified by:

getPlugins in interface PluginAccessor

getPlugins

public Collection<Plugin> getPlugins(PluginPredicate pluginPredicate)

Specified by:

getPlugins in interface PluginAccessor

isPluginEnabled

public boolean isPluginEnabled(String key)
                        throws IllegalArgumentException

Specified by:

isPluginEnabled in interface PluginAccessor

Throws:

IllegalArgumentException

isPluginModuleEnabled

public boolean isPluginModuleEnabled(String completeKey)

Specified by:

isPluginModuleEnabled in interface PluginAccessor

isSystemPlugin

public boolean isSystemPlugin(String key)

Specified by:

isSystemPlugin in interface PluginAccessor

getDynamicModules

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

Specified by:

getDynamicModules in interface PluginAccessor

getDynamicPluginClass

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

Deprecated.

Specified by:

getDynamicPluginClass in interface PluginAccessor

Throws:

ClassNotFoundException

getEnabledModuleDescriptorsByClass

@Deprecated
public <D extends ModuleDescriptor<?>> List<D> getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz,
                                                                                              boolean verbose)

Deprecated.

Specified by:

getEnabledModuleDescriptorsByClass in interface PluginAccessor

getEnabledModuleDescriptorsByType

@Deprecated
public <M> List<ModuleDescriptor<M>> getEnabledModuleDescriptorsByType(String type)
                                                                            throws PluginParseException

Deprecated.

Specified by:

getEnabledModuleDescriptorsByType in interface PluginAccessor

Throws:

PluginParseException

getEnabledModulesByClassAndDescriptor

@Deprecated
public <M> List<M> getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>> descriptorClass,
                                                                     Class<M> moduleClass)

Deprecated.

Specified by:

getEnabledModulesByClassAndDescriptor in interface PluginAccessor

getEnabledModulesByClassAndDescriptor

@Deprecated
public <M> List<M> getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>>[] descriptorClazz,
                                                                     Class<M> moduleClass)

Deprecated.

Specified by:

getEnabledModulesByClassAndDescriptor in interface PluginAccessor

getPluginResourceAsStream

@Deprecated
public InputStream getPluginResourceAsStream(String pluginKey,
                                                         String resourcePath)

Deprecated.

Specified by:

getPluginResourceAsStream in interface PluginAccessor