com.atlassian.confluence.it.plugin
Class WebTestPluginHelper

java.lang.Object
  com.atlassian.confluence.it.plugin.WebTestPluginHelper

All Implemented Interfaces:

PluginHelper

public class WebTestPluginHelper
extends java.lang.Object
implements PluginHelper

Uses its own WebTester to perform and test administrative actions on a server with a given base url. The possession of the WebTester implies that the Dialog between this helper and the server is separate to any other conversation, so the logged in user and response (ie currently viewed page) are also separate..

Constructor Summary

WebTestPluginHelper(java.lang.String baseUrl)
Opens a separate dialog with the server for the purpose of installing plugins.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebTestPluginHelper

public WebTestPluginHelper(java.lang.String baseUrl)

Opens a separate dialog with the server for the purpose of installing plugins. It does this to not interface with any ongoing dialog in the calling code.

Parameters:

baseUrl - base URL of the Confluence instance to talk to

Method Detail

installPlugin

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

Description copied from interface: PluginHelper

Install the plugin.

Specified by:

installPlugin in interface PluginHelper

Throws:

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

See Also:

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

uninstallPlugin

public void uninstallPlugin(UploadablePlugin plugin,
                            User user)

Description copied from interface: PluginHelper

Uninstall the plugin.

Specified by:

uninstallPlugin in interface PluginHelper

See Also:

PluginHelper.isPluginInstalled(UploadablePlugin,User)

isPluginInstalled

public boolean isPluginInstalled(UploadablePlugin plugin,
                                 User user)

Description copied from interface: PluginHelper

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

Specified by:

isPluginInstalled in interface PluginHelper

isPluginInstalledWithDisplayName

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

Description copied from interface: PluginHelper

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

Specified by:

isPluginInstalledWithDisplayName in interface PluginHelper

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

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

Description copied from interface: PluginHelper

Enable the plugin.

Specified by:

enablePlugin in interface PluginHelper

See Also:

PluginHelper.isPluginEnabled(String,User)

enablePluginModule

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

Specified by:

enablePluginModule in interface PluginHelper

disablePluginModule

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

Specified by:

disablePluginModule in interface PluginHelper

disablePlugin

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

Description copied from interface: PluginHelper

Disable the plugin.

Specified by:

disablePlugin in interface PluginHelper

See Also:

PluginHelper.isPluginEnabled(String,User)

isPluginEnabled

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

Description copied from interface: PluginHelper

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

Specified by:

isPluginEnabled in interface PluginHelper