com.atlassian.plugin.PluginController |
Known Indirect Subclasses |
Interface to control the state of the plugin system
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Disables the plugin with the given key.
| |||||||||||
Disable a plugin module by key.
| |||||||||||
Disables the plugin with the given key without persisting the disabled state.
| |||||||||||
This method is deprecated.
since 2.5.0, use {#link enablePlugins(String... keys)} instead
| |||||||||||
Enable a plugin module by key.
| |||||||||||
Enable a set of plugins by key.
| |||||||||||
This method is deprecated.
Since 2.3.0, use
installPlugins(PluginArtifact) instead
| |||||||||||
Installs multiple plugins and returns the list of plugin keys.
| |||||||||||
Restores the state of any plugin requiring a restart that had been removed, upgraded, or installed.
| |||||||||||
Search all loaders and add any new plugins you find.
| |||||||||||
Uninstall the plugin, disabling it first.
|
Disables the plugin with the given key.
Calling this method will persist the disabled state so that the plugin will also be disabled on next startup. This would normally be used when a user manually disables a plugin.
If you extend DefaultPluginManager and override this method, you will also need to override disablePluginWithoutPersisting(String)
.
key | The plugin key. |
---|
Disable a plugin module by key.
completeKey | The "complete key" of the plugin module. |
---|
Disables the plugin with the given key without persisting the disabled state.
Calling this method will NOT persist the disabled state so that the framework will try to enable the plugin on next startup. This is used when a plugin has errors on startup.
If you extend DefaultPluginManager and override disablePlugin(String)
, you will also need to override this method.
key | The plugin key. |
---|
This method is deprecated.
since 2.5.0, use {#link enablePlugins(String... keys)} instead
Enable a plugin by key.
key | The plugin key. |
---|
Enable a plugin module by key.
completeKey | The "complete key" of the plugin module. |
---|
Enable a set of plugins by key. This will implicitly and recursively enable all dependent plugins
keys | The plugin keys. Must not be null. |
---|
This method is deprecated.
Since 2.3.0, use installPlugins(PluginArtifact)
instead
Installs a plugin and returns the plugin key
pluginArtifact | The plugin artifact to install |
---|
PluginParseException | if the plugin is not a valid plugin |
---|
Installs multiple plugins and returns the list of plugin keys. All plugin artifacts must be for valid plugins or none will be installed.
pluginArtifacts | The list of plugin artifacts to install |
---|
PluginParseException | if any plugin is not a valid plugin |
---|
Restores the state of any plugin requiring a restart that had been removed, upgraded, or installed. If marked as removed, the mark will be deleted. If marked as upgrade, an attempt to restore the original plugin artifact will be made. If marked as install, the artifact will be deleted.
pluginKey | The plugin key |
---|
PluginException | if there was some problem reverting the plugin state. |
---|---|
IllegalArgumentException | if the plugin key is null or cannot be resolved to a plugin |
Search all loaders and add any new plugins you find.
PluginParseException |
---|
Uninstall the plugin, disabling it first.
plugin | The plugin. |
---|
PluginException | if there was some problem uninstalling the plugin. |
---|