com.atlassian.confluence.it.plugin
Interface PluginHelper

All Known Implementing Classes:
RpcPluginHelper, WebTestPluginHelper

public interface PluginHelper

Provides methods for administering Confluence plugins via the web interface for testing purposes.


Method Summary
 void disablePlugin(Plugin plugin)
          Disable the plugin.
 void disablePluginModule(Plugin plugin, java.lang.String moduleKey)
           
 void enablePlugin(Plugin plugin)
          Enable the plugin.
 void enablePluginModule(Plugin plugin, java.lang.String moduleKey)
           
 void installPlugin(UploadablePlugin plugin)
          Install the plugin as the currently logged in User.
 boolean isPluginEnabled(Plugin plugin)
          Returns true if the given plugin is currently enabled, otherwise false.
 boolean isPluginInstalled(Plugin plugin)
          Returns true if the given plugin is currently installed, otherwise false.
 void uninstallPlugin(Plugin plugin)
          Uninstall the plugin as the currently logged in User.
 

Method Detail

installPlugin

void installPlugin(UploadablePlugin plugin)
                   throws java.io.IOException
Install the plugin as the currently logged in User.

Throws:
java.lang.RuntimeException - if the plugin is already installed.
java.io.FileNotFoundException - if the plugin file does not exist locally
java.io.IOException
See Also:
isPluginInstalled(Plugin)

uninstallPlugin

void uninstallPlugin(Plugin plugin)
Uninstall the plugin as the currently logged in User.

Throws:
java.lang.RuntimeException - if the plugin is not installed.
See Also:
isPluginInstalled(Plugin)

isPluginInstalled

boolean isPluginInstalled(Plugin plugin)
Returns true if the given plugin is currently installed, otherwise false. Requires the logged in user to have admin access.


enablePlugin

void enablePlugin(Plugin plugin)
Enable the plugin. Requires the logged in user to have admin access.

Throws:
java.lang.RuntimeException - if the plugin is already enabled.
See Also:
isPluginEnabled(Plugin)

disablePlugin

void disablePlugin(Plugin plugin)
Disable the plugin. Requires the logged in user to have admin access.

Throws:
java.lang.RuntimeException - if the plugin is not enabled.
See Also:
isPluginEnabled(Plugin)

isPluginEnabled

boolean isPluginEnabled(Plugin plugin)
Returns true if the given plugin is currently enabled, otherwise false.


enablePluginModule

void enablePluginModule(Plugin plugin,
                        java.lang.String moduleKey)

disablePluginModule

void disablePluginModule(Plugin plugin,
                         java.lang.String moduleKey)


Copyright © 2003-2011 Atlassian. All Rights Reserved.