PluginAccessor (atlassian-plugins-api 4.5.1 API)

```
public interface PluginAccessor
```
Allows access to the current plugin system state

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class PluginAccessor.Descriptor
The plugin descriptor file.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`PluginAccessor.Descriptor` The plugin descriptor file.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default <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.
`Class<?>`	`getDynamicPluginClass(String className)` Deprecated. since 0.21 this method is not used, use `getPlugin(String)`.`getClassLoader()`.`loadClass(String)`
`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)` Get all enabled module descriptors that have a specific descriptor class.
`<D extends ModuleDescriptor<?>> List<D>`	`getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz, boolean verbose)` Deprecated. Since 2.3.0, use `#getEnabledModuleDescriptorsByClass(Class)` instead
`<M> List<ModuleDescriptor<M>>`	`getEnabledModuleDescriptorsByType(String type)` Deprecated. since 0.17, use `getModuleDescriptors(com.atlassian.plugin.predicate.ModuleDescriptorPredicate)` with an appropriate predicate instead.
`<M> List<M>`	`getEnabledModulesByClass(Class<M> moduleClass)` Retrieve all plugin modules that implement or extend a specific class.
`<M> List<M>`	`getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>>[] descriptorClazz, Class<M> moduleClass)` Deprecated. since 0.17, use `getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate)` with an appropriate predicate instead.
`<M> List<M>`	`getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>> descriptorClass, Class<M> moduleClass)` Deprecated. since 0.17, use `getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate)` with an appropriate predicate instead.
`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(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)` Gets all module descriptors of installed modules that match the given predicate.
`<M> Collection<M>`	`getModules(ModuleDescriptorPredicate<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.
`InputStream`	`getPluginResourceAsStream(String pluginKey, String resourcePath)` Deprecated. since 0.21 this method is not used, use `getPlugin(String)`.`getClassLoader()`.`getResourceAsStream(String)`
`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(PluginPredicate 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)`

- Method Detail
  - getPlugins
```
Collection<Plugin> getPlugins()
```
    Gets all of the currently installed plugins.
    
    Returns:
    
    a collection of installed Plugins.
  - getPlugins
```
Collection<Plugin> getPlugins(PluginPredicate pluginPredicate)
```
    Gets all installed plugins that match the given predicate.
    
    Parameters:
    
    pluginPredicate - the PluginPredicate to match.
    
    Returns:
    
    a collection of Plugins that match the given predicate.
    
    Since:
    
    0.17
  - getEnabledPlugins
```
Collection<Plugin> getEnabledPlugins()
```
    Get all of the currently enabled plugins.
    
    Returns:
    
    a collection of installed and enabled Plugins.
  - getModules
```
<M> Collection<M> getModules(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)
```
    Gets all installed modules that match the given predicate.
    
    Parameters:
    
    moduleDescriptorPredicate - the ModuleDescriptorPredicate to match.
    
    Returns:
    
    a collection of modules as per ModuleDescriptor.getModule() that match the given predicate.
    
    Since:
    
    0.17
  - getModuleDescriptors
```
<M> Collection<ModuleDescriptor<M>> getModuleDescriptors(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)
```
    Gets all module descriptors of installed modules that match the given predicate.
    
    Parameters:
    
    moduleDescriptorPredicate - the ModuleDescriptorPredicate to match.
    
    Returns:
    
    a collection of ModuleDescriptors that match the given predicate.
    
    Since:
    
    0.17
  - getPlugin
```
Plugin getPlugin(String key)
          throws IllegalArgumentException
```
    Retrieve a given plugin (whether enabled or not).
    
    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
  - getEnabledPlugin
```
Plugin getEnabledPlugin(String pluginKey)
                 throws IllegalArgumentException
```
    Retrieve a given plugin if it is enabled.
    
    Returns:
    
    The enabled plugin, or null if that plugin does not exist or is disabled.
    
    Throws:
    
    IllegalArgumentException - If the plugin key is null
  - getPluginModule
```
ModuleDescriptor<?> getPluginModule(String completeKey)
```
    Retrieve any plugin module by complete module key.
    Note: the module may or may not be disabled.
  - getEnabledPluginModule
```
ModuleDescriptor<?> getEnabledPluginModule(String completeKey)
```
    Retrieve an enabled plugin module by complete module key.
  - isPluginEnabled
```
boolean isPluginEnabled(String key)
                 throws IllegalArgumentException
```
    Whether or not a given plugin is currently enabled.
    
    Throws:
    
    IllegalArgumentException - If the plugin key is null
  - isPluginModuleEnabled
```
boolean isPluginModuleEnabled(String completeKey)
```
    Whether or not a given plugin module is currently enabled. This also checks if the plugin it is contained within is enabled also
    
    See Also:
    
    isPluginEnabled(String)
  - getEnabledModulesByClass
```
<M> List<M> getEnabledModulesByClass(Class<M> moduleClass)
```
    Retrieve all plugin modules that implement or extend a specific class.
    
    Returns:
    
    List of modules that implement or extend the given class.
  - getEnabledModulesByClassAndDescriptor
```
@Deprecated
<M> List<M> getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>>[] descriptorClazz,
                                                              Class<M> moduleClass)
```
    Deprecated. since 0.17, use getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.
    
    Retrieve all plugin modules that implement or extend a specific class, and has a descriptor class as one of descriptorClazz
    
    Parameters:
    
    descriptorClazz - @Nonnull
    
    moduleClass - @Nonnull
    
    Returns:
    
    List of modules that implement or extend the given class. Empty list if none found
  - getEnabledModulesByClassAndDescriptor
```
@Deprecated
<M> List<M> getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>> descriptorClass,
                                                              Class<M> moduleClass)
```
    Deprecated. since 0.17, use getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.
    
    Retrieve all plugin modules that implement or extend a specific class, and has a descriptor class as the descriptorClazz
    
    Parameters:
    
    descriptorClass - @Nonnull
    
    moduleClass - @Nonnull
    
    Returns:
    
    List of modules that implement or extend the given class. Empty list if none found
  - getEnabledModuleDescriptorsByClass
```
<D extends ModuleDescriptor<?>> List<D> getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz)
```
    Get all enabled module descriptors that have a specific descriptor class.
    
    Parameters:
    
    descriptorClazz - module descriptor class
    
    Returns:
    
    List of ModuleDescriptors that implement or extend the given class.
  - getActiveModuleDescriptorsByClass
```
default <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. Result of this method should not be cached across requests.
    
    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
  - getEnabledModuleDescriptorsByClass
```
@Deprecated
<D extends ModuleDescriptor<?>> List<D> getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz,
                                                                                       boolean verbose)
```
    Deprecated. Since 2.3.0, use #getEnabledModuleDescriptorsByClass(Class) instead
    
    Get all enabled module descriptors that have a specific descriptor class.
    
    Parameters:
    
    descriptorClazz - module descriptor class
    
    verbose - log verbose messages flag
    
    Returns:
    
    List of ModuleDescriptors that implement or extend the given class.
  - getEnabledModuleDescriptorsByType
```
@Deprecated
<M> List<ModuleDescriptor<M>> getEnabledModuleDescriptorsByType(String type)
                                                                     throws PluginParseException
```
    Deprecated. since 0.17, use getModuleDescriptors(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.
    
    Get all enabled module descriptors that have a specific descriptor type.
    
    Returns:
    
    List of ModuleDescriptors that are of a given type.
    
    Throws:
    
    PluginParseException
  - getDynamicResourceAsStream
```
InputStream getDynamicResourceAsStream(String resourcePath)
```
    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 eratically.
    
    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
  - getPluginResourceAsStream
```
@Deprecated
InputStream getPluginResourceAsStream(String pluginKey,
                                                  String resourcePath)
```
    Deprecated. since 0.21 this method is not used, use getPlugin(String).getClassLoader().getResourceAsStream(String)
    
    Retrieve a resource from a currently loaded (and active) plugin. For statically loaded plugins, this just means pulling the resource from the PluginManager's classloader. For dynamically loaded plugins, this means retrieving the resource from the plugin's private classloader.
  - getDynamicPluginClass
```
@Deprecated
Class<?> getDynamicPluginClass(String className)
                                    throws ClassNotFoundException
```
    Deprecated. since 0.21 this method is not used, use getPlugin(String).getClassLoader().loadClass(String)
    
    Retrieve a class from a currently loaded (and active) dynamically loaded plugin. Will return the first class found, so plugins with overlapping class names will behave eratically.
    
    Parameters:
    
    className - the name of the class to retrieve
    
    Returns:
    
    the dynamically loaded class that matches that name
    
    Throws:
    
    ClassNotFoundException - thrown if no classes by that name could be found in any of the enabled dynamic plugins
  - getClassLoader
```
ClassLoader getClassLoader()
```
    Retrieve the class loader responsible for loading classes and resources from plugins.
    
    Returns:
    
    the class loader
    
    Since:
    
    0.21
  - isSystemPlugin
```
boolean isSystemPlugin(String key)
```
    Returns:
    
    true if the plugin is a system plugin.
  - getPluginRestartState
```
PluginRestartState getPluginRestartState(String key)
```
    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
    
    Parameters:
    
    key - The plugin key
    
    Returns:
    
    The state of the plugin on restart
  - getDynamicModules
```
Iterable<ModuleDescriptor<?>> getDynamicModules(Plugin plugin)
```
    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).
    
    Parameters:
    
    plugin - to query
    
    Returns:
    
    modules added, may be empty
    
    See Also:
    
    PluginController.addDynamicModule(Plugin, org.dom4j.Element), PluginController.removeDynamicModule(Plugin, ModuleDescriptor)

Interface PluginAccessor

Nested Class Summary

Method Summary

Method Detail

getPlugins

getPlugins

getEnabledPlugins

getModules

getModuleDescriptors

getPlugin

getEnabledPlugin

getPluginModule

getEnabledPluginModule

isPluginEnabled

isPluginModuleEnabled

getEnabledModulesByClass

getEnabledModulesByClassAndDescriptor

getEnabledModulesByClassAndDescriptor

getEnabledModuleDescriptorsByClass

getActiveModuleDescriptorsByClass

getEnabledModuleDescriptorsByClass

getEnabledModuleDescriptorsByType

getDynamicResourceAsStream

getPluginResourceAsStream

getDynamicPluginClass

getClassLoader

isSystemPlugin

getPluginRestartState

getDynamicModules