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 abstract ClassLoader getClassLoader() Retrieve the class loader responsible for loading classes and resources from plugins. abstract Class<?> getDynamicPluginClass(String className) This method is deprecated. since 0.21 this method is not used, use getPlugin(String).getClassLoader().loadClass(String) abstract InputStream getDynamicResourceAsStream(String resourcePath) Retrieve a resource from a currently loaded (and active) dynamically loaded plugin. abstract <D extends ModuleDescriptor<?>> List<D> getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz) Get all enabled module descriptors that have a specific descriptor class. abstract <D extends ModuleDescriptor<?>> List<D> getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz, boolean verbose) This method is deprecated. Since 2.3.0, use #getEnabledModuleDescriptorsByClass(Class) instead abstract <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. abstract <M> List<M> getEnabledModulesByClass(Class<M> moduleClass) Retrieve all plugin modules that implement or extend a specific class. abstract <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. abstract <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. abstract Plugin getEnabledPlugin(String pluginKey) Retrieve a given plugin if it is enabled. abstract ModuleDescriptor<?> getEnabledPluginModule(String completeKey) Retrieve an enabled plugin module by complete module key. abstract Collection<Plugin> getEnabledPlugins() Get all of the currently enabled plugins. abstract <M> Collection<ModuleDescriptor<M>> getModuleDescriptors(ModuleDescriptorPredicate<M> moduleDescriptorPredicate) Gets all module descriptors of installed modules that match the given predicate. abstract <M> Collection<M> getModules(ModuleDescriptorPredicate<M> moduleDescriptorPredicate) Gets all installed modules that match the given predicate. abstract Plugin getPlugin(String key) Retrieve a given plugin (whether enabled or not). abstract ModuleDescriptor<?> getPluginModule(String completeKey) Retrieve any plugin module by complete module key. abstract InputStream getPluginResourceAsStream(String pluginKey, String resourcePath) This method is deprecated. since 0.21 this method is not used, use getPlugin(String).getClassLoader().getResourceAsStream(String) abstract PluginRestartState getPluginRestartState(String key) Gets the state of the plugin upon restart. abstract Collection<Plugin> getPlugins() Gets all of the currently installed plugins. abstract Collection<Plugin> getPlugins(PluginPredicate pluginPredicate) Gets all installed plugins that match the given predicate. abstract boolean isPluginEnabled(String key) Whether or not a given plugin is currently enabled. abstract boolean isPluginModuleEnabled(String completeKey) Whether or not a given plugin module is currently enabled. abstract boolean isSystemPlugin(String key)
From interface com.atlassian.plugin.PluginController abstract void disablePlugin(String key) Disables the plugin with the given key. abstract void disablePluginModule(String completeKey) Disable a plugin module by key. abstract void disablePluginWithoutPersisting(String key) Disables the plugin with the given key without persisting the disabled state. abstract void enablePlugin(String key) This method is deprecated. since 2.5.0, use {#link enablePlugins(String... keys)} instead abstract void enablePluginModule(String completeKey) Enable a plugin module by key. abstract void enablePlugins(String... keys) Enable a set of plugins by key. abstract String installPlugin(PluginArtifact pluginArtifact) This method is deprecated. Since 2.3.0, use installPlugins(PluginArtifact) instead abstract Set<String> installPlugins(PluginArtifact... pluginArtifacts) Installs multiple plugins and returns the list of plugin keys. abstract void revertRestartRequiredChange(String pluginKey) Restores the state of any plugin requiring a restart that had been removed, upgraded, or installed. abstract int scanForNewPlugins() Search all loaders and add any new plugins you find. abstract void uninstall(Plugin plugin) Uninstall the plugin, disabling it first.
From interface com.atlassian.plugin.PluginSystemLifecycle abstract void init() Initialise the plugin system. abstract void shutdown() Destroys the plugin manager. abstract void warmRestart() Restart all plugins by disabling and enabling them in the order they were loaded (by plugin loader)