com.atlassian.jira.functest.config.dashboard
Class DashboardConfigurationCheck

java.lang.Object
  com.atlassian.jira.functest.config.dashboard.DashboardConfigurationCheck

All Implemented Interfaces:

ConfigurationCheck

public class DashboardConfigurationCheck
extends Object
implements ConfigurationCheck

Configuration check that ensures dashboard configuration is clean and consistent.

Since:

v4.2

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.functest.config.ConfigurationCheck

ConfigurationCheck.Result

Field Summary

static String	CHECKID_ABSOLUTE Check to see if there are any gadets with absolute URLs are defined.
static String	CHECKID_DASHBOARDS Check to see if there are non-system dashboards.
static String	CHECKID_EXTERNAL Check to see if there are any external gadgets defined.
static String	CHECKID_GADGETS Check to see if there are gadgets on the dashboards.

Constructor Summary

DashboardConfigurationCheck()

Method Summary

ConfigurationCheck.Result	checkConfiguration(JiraConfig config, CheckOptions options) Check the correctness of the passed JIRA XML.
void	fixConfiguration(JiraConfig config, CheckOptions options) Fix the passed JIRA configuration and remove any errors.

Methods inherited from class java.lang.Object

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

Field Detail

CHECKID_DASHBOARDS

public static final String CHECKID_DASHBOARDS

Check to see if there are non-system dashboards.

See Also:

Constant Field Values

CHECKID_GADGETS

public static final String CHECKID_GADGETS

Check to see if there are gadgets on the dashboards.

See Also:

Constant Field Values

CHECKID_EXTERNAL

public static final String CHECKID_EXTERNAL

Check to see if there are any external gadgets defined.

See Also:

Constant Field Values

CHECKID_ABSOLUTE

public static final String CHECKID_ABSOLUTE

Check to see if there are any gadets with absolute URLs are defined.

See Also:

Constant Field Values

Constructor Detail

DashboardConfigurationCheck

public DashboardConfigurationCheck()

Method Detail

checkConfiguration

public ConfigurationCheck.Result checkConfiguration(JiraConfig config,
                                                    CheckOptions options)

Description copied from interface: ConfigurationCheck

Check the correctness of the passed JIRA XML. It must be possible to call this method multiple times with different agruments (i.e. the object should be stateless).

Specified by:

checkConfiguration in interface ConfigurationCheck

Parameters:

config - the configuration to check.

options - the context for the check. This is where errors can be reported.

Returns:

the errors that were found in the passed configuration file.

fixConfiguration

public void fixConfiguration(JiraConfig config,
                             CheckOptions options)

Description copied from interface: ConfigurationCheck

Fix the passed JIRA configuration and remove any errors.

Specified by:

fixConfiguration in interface ConfigurationCheck

Parameters:

config - the configuration to check.

options - the context for the check. This can be used to see what checks are currently enabled for the passed configuration.