com.atlassian.plugin.PluginAccessor |
Known Indirect Subclasses |
Allows access to the current plugin system state
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
PluginAccessor.Descriptor | The plugin descriptor file. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Retrieve the class loader responsible for loading classes and resources from plugins.
| |||||||||||
This method is deprecated.
since 0.21 this method is not used, use
getPlugin(String) .getClassLoader() .loadClass(String)
| |||||||||||
Retrieve a resource from a currently loaded (and active) dynamically loaded plugin.
| |||||||||||
Get all enabled module descriptors that have a specific descriptor class.
| |||||||||||
This method is deprecated.
Since 2.3.0, use #getEnabledModuleDescriptorsByClass(Class
| |||||||||||
This method is deprecated.
since 0.17, use
getModuleDescriptors(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.
| |||||||||||
Retrieve all plugin modules that implement or extend a specific class.
| |||||||||||
This method is deprecated.
since 0.17, use
getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.
| |||||||||||
This method is deprecated.
since 0.17, use
getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.
| |||||||||||
Retrieve a given plugin if it is enabled.
| |||||||||||
Retrieve an enabled plugin module by complete module key.
| |||||||||||
Get all of the currently enabled plugins.
| |||||||||||
Gets all module descriptors of installed modules that match the given predicate.
| |||||||||||
Gets all installed modules that match the given predicate.
| |||||||||||
Retrieve a given plugin (whether enabled or not).
| |||||||||||
Retrieve any plugin module by complete module key.
| |||||||||||
This method is deprecated.
since 0.21 this method is not used, use
getPlugin(String) .getClassLoader() .getResourceAsStream(String)
| |||||||||||
Gets the state of the plugin upon restart.
| |||||||||||
Gets all of the currently installed plugins.
| |||||||||||
Gets all installed plugins that match the given predicate.
| |||||||||||
Whether or not a given plugin is currently enabled.
| |||||||||||
Whether or not a given plugin module is currently enabled.
| |||||||||||
Retrieve the class loader responsible for loading classes and resources from plugins.
This method is 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.
className | the name of the class to retrieve |
---|
ClassNotFoundException | thrown if no classes by that name could be found in any of the enabled dynamic plugins |
---|
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.
resourcePath | the path to the resource to retrieve |
---|
Get all enabled module descriptors that have a specific descriptor class.
descriptorClazz | module descriptor class |
---|
ModuleDescriptor
s that implement or extend the given class.
This method is deprecated.
Since 2.3.0, use #getEnabledModuleDescriptorsByClass(Class
Get all enabled module descriptors that have a specific descriptor class.
descriptorClazz | module descriptor class |
---|---|
verbose | log verbose messages flag |
ModuleDescriptor
s that implement or extend the given class.
This method is 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.
ModuleDescriptor
s that are of a given type.PluginParseException |
---|
Retrieve all plugin modules that implement or extend a specific class.
This method is 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
descriptorClass | @NotNull |
---|---|
moduleClass | @NotNull |
This method is 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
descriptorClazz | @NotNull |
---|---|
moduleClass | @NotNull |
Retrieve a given plugin if it is enabled.
IllegalArgumentException | If the plugin key is null |
---|
Retrieve an enabled plugin module by complete module key.
Get all of the currently enabled plugins.
Plugin
s.
Gets all module descriptors of installed modules that match the given predicate.
moduleDescriptorPredicate | the ModuleDescriptorPredicate to match. |
---|
ModuleDescriptor
s that match the given predicate.Gets all installed modules that match the given predicate.
moduleDescriptorPredicate | the ModuleDescriptorPredicate to match. |
---|
getModule()
that match the given predicate.Retrieve a given plugin (whether enabled or not).
key | The plugin key. Cannot be null. |
---|
IllegalArgumentException | If the plugin key is null |
---|
Retrieve any plugin module by complete module key.
Note: the module may or may not be disabled.
This method is 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.
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
key | The plugin key |
---|
Gets all of the currently installed plugins.
Plugin
s.
Gets all installed plugins that match the given predicate.
pluginPredicate | the PluginPredicate to match. |
---|
Plugin
s that match the given predicate.Whether or not a given plugin is currently enabled.
IllegalArgumentException | If the plugin key is null |
---|
Whether or not a given plugin module is currently enabled. This also checks if the plugin it is contained within is enabled also