PluginManager

This interface is deprecated.
since 2006-09-26 the preferred technique is to use the interfaces that this on e extends directly.

Class Overview

A plugin manager is responsible for retrieving plugins and modules, as well as managing plugin loading and state.

Summary

[Expand] Inherited Methods
From interface com.atlassian.plugin.PluginAccessor ClassLoader getClassLoader() Retrieve the class loader responsible for loading classes and resources from plugins. @Deprecated Class<?> getDynamicPluginClass(String className) This method is 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) This method is deprecated. Since 2.3.0, use #getEnabledModuleDescriptorsByClass(Class) instead @Deprecated <M> List<ModuleDescriptor<M>> getEnabledModuleDescriptorsByType(String type) This method is 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. @Deprecated <M> List<M> getEnabledModulesByClassAndDescriptor(Class<ModuleDescriptor<M>> descriptorClass, Class<M> moduleClass) This method is deprecated. since 0.17, use getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead. @Deprecated <M> List<M> getEnabledModulesByClassAndDescriptor(Class[]<ModuleDescriptor<M>> descriptorClazz, Class<M> moduleClass) This method is 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. @Deprecated InputStream getPluginResourceAsStream(String pluginKey, String resourcePath) This method is 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)
From interface com.atlassian.plugin.PluginController void disablePlugin(String key) Disables the plugin with the given key. void disablePluginModule(String completeKey) Disable a plugin module by key. void disablePluginWithoutPersisting(String key) Disables the plugin with the given key without persisting the disabled state. void enablePlugin(String key) This method is deprecated. since 2.5.0, use {#link enablePlugins(String... keys)} instead void enablePluginModule(String completeKey) Enable a plugin module by key. void enablePlugins(String... keys) Enable a set of plugins by key. String installPlugin(PluginArtifact pluginArtifact) This method is deprecated. Since 2.3.0, use installPlugins(PluginArtifact) instead Set<String> installPlugins(PluginArtifact... pluginArtifacts) Installs multiple plugins and returns the list of plugin keys. void revertRestartRequiredChange(String pluginKey) Restores the state of any plugin requiring a restart that had been removed, upgraded, or installed. int scanForNewPlugins() Search all loaders and add any new plugins you find. void uninstall(Plugin plugin) Uninstall the plugin, disabling it first.
From interface com.atlassian.plugin.PluginSystemLifecycle void init() Initialise the plugin system. void shutdown() Destroys the plugin manager. void warmRestart() Restart all plugins by disabling and enabling them in the order they were loaded (by plugin loader)