com.atlassian.confluence.it.plugin
Interface PluginHelper

All Known Implementing Classes:

WebTestPluginHelper

public interface PluginHelper

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

Method Summary

void	disablePlugin(java.lang.String pluginDisplayName, User user) Disable the plugin.
void	disablePluginModule(java.lang.String pluginKey, java.lang.String moduleKey, User user)
void	enablePlugin(java.lang.String pluginDisplayName, User user) Enable the plugin.
void	enablePluginModule(java.lang.String pluginKey, java.lang.String moduleKey, User user)
void	installPlugin(UploadablePlugin plugin, User user) Install the plugin.
boolean	isPluginEnabled(java.lang.String pluginDisplayName, User user) Returns true if the given plugin is currently enabled, otherwise false.
boolean	isPluginInstalled(UploadablePlugin plugin, User user) Returns true if the given plugin is currently installed, otherwise false.
boolean	isPluginInstalledWithDisplayName(java.lang.String pluginName, User user) Returns true if a plugin with the given display name is installed, otherwise false.
void	uninstallPlugin(UploadablePlugin plugin, User user) Uninstall the plugin.

Method Detail

installPlugin

void installPlugin(UploadablePlugin plugin,
                   User user)
                   throws java.io.FileNotFoundException

Install the plugin.

Throws:

java.lang.RuntimeException - if the plugin is already installed.

java.io.FileNotFoundException - if the plugin file does not exist locally

See Also:

isPluginInstalled(com.atlassian.confluence.it.plugin.UploadablePlugin,com.atlassian.confluence.it.User)

uninstallPlugin

void uninstallPlugin(UploadablePlugin plugin,
                     User user)

Uninstall the plugin.

Throws:

java.lang.RuntimeException - if the plugin is not installed.

See Also:

isPluginInstalled(UploadablePlugin,User)

isPluginInstalled

boolean isPluginInstalled(UploadablePlugin plugin,
                          User user)

Returns true if the given plugin is currently installed, otherwise false.

isPluginInstalledWithDisplayName

boolean isPluginInstalledWithDisplayName(java.lang.String pluginName,
                                         User user)

Returns true if a plugin with the given display name is installed, otherwise false.

Parameters:

pluginName - name of the plugin as displayed in the plugin page.

user - who will log in if necessary to view the admin screen. Must have admin permission

Returns:

true if the plugin name is shown in the plugin page

enablePlugin

void enablePlugin(java.lang.String pluginDisplayName,
                  User user)

Enable the plugin.

Throws:

java.lang.RuntimeException - if the plugin is already enabled.

See Also:

isPluginEnabled(String,User)

disablePlugin

void disablePlugin(java.lang.String pluginDisplayName,
                   User user)

Disable the plugin.

Throws:

java.lang.RuntimeException - if the plugin is not enabled.

See Also:

isPluginEnabled(String,User)

isPluginEnabled

boolean isPluginEnabled(java.lang.String pluginDisplayName,
                        User user)

Returns true if the given plugin is currently enabled, otherwise false.

enablePluginModule

void enablePluginModule(java.lang.String pluginKey,
                        java.lang.String moduleKey,
                        User user)

disablePluginModule

void disablePluginModule(java.lang.String pluginKey,
                         java.lang.String moduleKey,
                         User user)