public final class EnabledModuleCachingPluginAccessor extends java.lang.Object implements PluginAccessor
getEnabledModuleDescriptorsByClass(Class) on PluginAccessor interface.PluginAccessor.Descriptor| Modifier and Type | Field and Description |
|---|---|
protected PluginAccessor |
delegate |
| Constructor and Description |
|---|
EnabledModuleCachingPluginAccessor(PluginAccessor delegate,
PluginEventManager pluginEventManager) |
EnabledModuleCachingPluginAccessor(PluginAccessor delegate,
PluginEventManager pluginEventManager,
ConcurrentCacheFactory<java.lang.Class<ModuleDescriptor<java.lang.Object>>,PluginModuleTracker<java.lang.Object,ModuleDescriptor<java.lang.Object>>> pluginModuleTrackerCacheFactory) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.ClassLoader |
getClassLoader()
Retrieve the class loader responsible for loading classes and resources from plugins.
|
java.lang.Class<?> |
getDynamicPluginClass(java.lang.String className)
Deprecated.
|
java.io.InputStream |
getDynamicResourceAsStream(java.lang.String resourcePath)
Retrieve a resource from a currently loaded (and active) dynamically loaded plugin.
|
<D extends ModuleDescriptor<?>> |
getEnabledModuleDescriptorsByClass(java.lang.Class<D> descriptorClazz)
Get all enabled module descriptors that have a specific descriptor class.
|
<D extends ModuleDescriptor<?>> |
getEnabledModuleDescriptorsByClass(java.lang.Class<D> descriptorClazz,
boolean verbose)
Deprecated.
|
<M> java.util.List<ModuleDescriptor<M>> |
getEnabledModuleDescriptorsByType(java.lang.String type)
Deprecated.
|
<M> java.util.List<M> |
getEnabledModulesByClass(java.lang.Class<M> moduleClass)
Retrieve all plugin modules that implement or extend a specific class.
|
<M> java.util.List<M> |
getEnabledModulesByClassAndDescriptor(java.lang.Class<ModuleDescriptor<M>>[] descriptorClazz,
java.lang.Class<M> moduleClass)
Deprecated.
|
<M> java.util.List<M> |
getEnabledModulesByClassAndDescriptor(java.lang.Class<ModuleDescriptor<M>> descriptorClass,
java.lang.Class<M> moduleClass)
Deprecated.
|
Plugin |
getEnabledPlugin(java.lang.String pluginKey)
Retrieve a given plugin if it is enabled.
|
ModuleDescriptor<?> |
getEnabledPluginModule(java.lang.String completeKey)
Retrieve an enabled plugin module by complete module key.
|
java.util.Collection<Plugin> |
getEnabledPlugins()
Get all of the currently enabled plugins.
|
<M> java.util.Collection<ModuleDescriptor<M>> |
getModuleDescriptors(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)
Gets all module descriptors of installed modules that match the given predicate.
|
<M> java.util.Collection<M> |
getModules(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)
Gets all installed modules that match the given predicate.
|
Plugin |
getPlugin(java.lang.String key)
Retrieve a given plugin (whether enabled or not).
|
ModuleDescriptor<?> |
getPluginModule(java.lang.String completeKey)
Retrieve any plugin module by complete module key.
|
java.io.InputStream |
getPluginResourceAsStream(java.lang.String pluginKey,
java.lang.String resourcePath)
Deprecated.
|
PluginRestartState |
getPluginRestartState(java.lang.String key)
Gets the state of the plugin upon restart.
|
java.util.Collection<Plugin> |
getPlugins()
Gets all of the currently installed plugins.
|
java.util.Collection<Plugin> |
getPlugins(PluginPredicate pluginPredicate)
Gets all installed plugins that match the given predicate.
|
boolean |
isPluginEnabled(java.lang.String key)
Whether or not a given plugin is currently enabled.
|
boolean |
isPluginModuleEnabled(java.lang.String completeKey)
Whether or not a given plugin module is currently enabled.
|
boolean |
isSystemPlugin(java.lang.String key) |
void |
onPluginDisable(PluginDisabledEvent event)
Clears the enabled module cache when any plugin is disabled.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetClassLoader, getDynamicPluginClass, getDynamicResourceAsStream, getEnabledModuleDescriptorsByClass, getEnabledModuleDescriptorsByType, getEnabledModulesByClass, getEnabledModulesByClassAndDescriptor, getEnabledModulesByClassAndDescriptor, getEnabledPlugin, getEnabledPluginModule, getEnabledPlugins, getModuleDescriptors, getModules, getPlugin, getPluginModule, getPluginResourceAsStream, getPluginRestartState, getPlugins, getPlugins, isPluginEnabled, isPluginModuleEnabled, isSystemPluginprotected final PluginAccessor delegate
public EnabledModuleCachingPluginAccessor(PluginAccessor delegate, PluginEventManager pluginEventManager)
public EnabledModuleCachingPluginAccessor(PluginAccessor delegate, PluginEventManager pluginEventManager, ConcurrentCacheFactory<java.lang.Class<ModuleDescriptor<java.lang.Object>>,PluginModuleTracker<java.lang.Object,ModuleDescriptor<java.lang.Object>>> pluginModuleTrackerCacheFactory)
public <D extends ModuleDescriptor<?>> java.util.List<D> getEnabledModuleDescriptorsByClass(java.lang.Class<D> descriptorClazz)
PluginAccessorgetEnabledModuleDescriptorsByClass in interface PluginAccessordescriptorClazz - module descriptor classModuleDescriptors that implement or extend the given class.public void onPluginDisable(PluginDisabledEvent event)
event - The plugin disabled eventpublic java.lang.ClassLoader getClassLoader()
PluginAccessorgetClassLoader in interface PluginAccessorpublic java.io.InputStream getDynamicResourceAsStream(java.lang.String resourcePath)
PluginAccessorgetDynamicResourceAsStream in interface PluginAccessorresourcePath - the path to the resource to retrievepublic <M> java.util.List<M> getEnabledModulesByClass(java.lang.Class<M> moduleClass)
PluginAccessorgetEnabledModulesByClass in interface PluginAccessorpublic Plugin getEnabledPlugin(java.lang.String pluginKey) throws java.lang.IllegalArgumentException
PluginAccessorgetEnabledPlugin in interface PluginAccessorjava.lang.IllegalArgumentException - If the plugin key is nullpublic ModuleDescriptor<?> getEnabledPluginModule(java.lang.String completeKey)
PluginAccessorgetEnabledPluginModule in interface PluginAccessorpublic java.util.Collection<Plugin> getEnabledPlugins()
PluginAccessorgetEnabledPlugins in interface PluginAccessorPlugins.public <M> java.util.Collection<ModuleDescriptor<M>> getModuleDescriptors(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)
PluginAccessorgetModuleDescriptors in interface PluginAccessormoduleDescriptorPredicate - the ModuleDescriptorPredicate to match.ModuleDescriptors that match the given predicate.public <M> java.util.Collection<M> getModules(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)
PluginAccessorgetModules in interface PluginAccessormoduleDescriptorPredicate - the ModuleDescriptorPredicate to match.ModuleDescriptor.getModule() that match the given predicate.public Plugin getPlugin(java.lang.String key) throws java.lang.IllegalArgumentException
PluginAccessorgetPlugin in interface PluginAccessorkey - The plugin key. Cannot be null.java.lang.IllegalArgumentException - If the plugin key is nullpublic ModuleDescriptor<?> getPluginModule(java.lang.String completeKey)
PluginAccessorNote: the module may or may not be disabled.
getPluginModule in interface PluginAccessorpublic PluginRestartState getPluginRestartState(java.lang.String key)
PluginAccessorgetPluginRestartState in interface PluginAccessorkey - The plugin keypublic java.util.Collection<Plugin> getPlugins()
PluginAccessorgetPlugins in interface PluginAccessorPlugins.public java.util.Collection<Plugin> getPlugins(PluginPredicate pluginPredicate)
PluginAccessorgetPlugins in interface PluginAccessorpluginPredicate - the PluginPredicate to match.Plugins that match the given predicate.public boolean isPluginEnabled(java.lang.String key)
throws java.lang.IllegalArgumentException
PluginAccessorisPluginEnabled in interface PluginAccessorjava.lang.IllegalArgumentException - If the plugin key is nullpublic boolean isPluginModuleEnabled(java.lang.String completeKey)
PluginAccessorisPluginModuleEnabled in interface PluginAccessorPluginAccessor.isPluginEnabled(String)public boolean isSystemPlugin(java.lang.String key)
isSystemPlugin in interface PluginAccessor@Deprecated
public java.lang.Class<?> getDynamicPluginClass(java.lang.String className)
throws java.lang.ClassNotFoundException
PluginAccessorgetDynamicPluginClass in interface PluginAccessorclassName - the name of the class to retrievejava.lang.ClassNotFoundException - thrown if no classes by that name could be found in any of the enabled dynamic plugins@Deprecated public <D extends ModuleDescriptor<?>> java.util.List<D> getEnabledModuleDescriptorsByClass(java.lang.Class<D> descriptorClazz, boolean verbose)
PluginAccessorgetEnabledModuleDescriptorsByClass in interface PluginAccessordescriptorClazz - module descriptor classverbose - log verbose messages flagModuleDescriptors that implement or extend the given class.@Deprecated public <M> java.util.List<ModuleDescriptor<M>> getEnabledModuleDescriptorsByType(java.lang.String type) throws PluginParseException
PluginAccessorgetEnabledModuleDescriptorsByType in interface PluginAccessorModuleDescriptors that are of a given type.PluginParseException@Deprecated public <M> java.util.List<M> getEnabledModulesByClassAndDescriptor(java.lang.Class<ModuleDescriptor<M>> descriptorClass, java.lang.Class<M> moduleClass)
PluginAccessorgetEnabledModulesByClassAndDescriptor in interface PluginAccessordescriptorClass - @NotNullmoduleClass - @NotNull@Deprecated public <M> java.util.List<M> getEnabledModulesByClassAndDescriptor(java.lang.Class<ModuleDescriptor<M>>[] descriptorClazz, java.lang.Class<M> moduleClass)
PluginAccessorgetEnabledModulesByClassAndDescriptor in interface PluginAccessordescriptorClazz - @NotNullmoduleClass - @NotNull@Deprecated
public java.io.InputStream getPluginResourceAsStream(java.lang.String pluginKey,
java.lang.String resourcePath)
PluginAccessorgetPluginResourceAsStream in interface PluginAccessorCopyright © 2013 Atlassian. All Rights Reserved.