com.atlassian.plugin
Interface PluginController

All Known Subinterfaces:
PluginManager
All Known Implementing Classes:
DefaultPluginManager, DefaultPluginManager

public interface PluginController

Interface to control the state of the plugin system


Method Summary
 void disablePlugin(java.lang.String key)
          Disable a plugin by key.
 void disablePluginModule(java.lang.String completeKey)
          Disable a plugin module by key.
 void enablePlugin(java.lang.String key)
          Enable a plugin by key.
 void enablePluginModule(java.lang.String completeKey)
          Enable a plugin module by key.
 java.lang.String installPlugin(PluginArtifact pluginArtifact)
          Installs a plugin and returns the plugin key
 int scanForNewPlugins()
          Search all loaders and add any new plugins you find.
 void uninstall(Plugin plugin)
          Uninstall the plugin, disabling it first.
 

Method Detail

enablePlugin

void enablePlugin(java.lang.String key)
Enable a plugin by key.


disablePlugin

void disablePlugin(java.lang.String key)
Disable a plugin by key.


enablePluginModule

void enablePluginModule(java.lang.String completeKey)
Enable a plugin module by key.


disablePluginModule

void disablePluginModule(java.lang.String completeKey)
Disable a plugin module by key.


installPlugin

java.lang.String installPlugin(PluginArtifact pluginArtifact)
                               throws PluginParseException
Installs a plugin and returns the plugin key

Throws:
PluginParseException - if the plugin is not a valid plugin

uninstall

void uninstall(Plugin plugin)
               throws PluginException
Uninstall the plugin, disabling it first.

Throws:
PluginException - if there was some problem uninstalling the plugin.

scanForNewPlugins

int scanForNewPlugins()
                      throws PluginParseException
Search all loaders and add any new plugins you find.

Returns:
The number of new plugins found.
Throws:
PluginParseException


Copyright © 2009 Atlassian Pty Ltd. All Rights Reserved.