public class

DashboardConfigurationCheck

extends Object
implements ConfigurationCheck
java.lang.Object
   ↳ com.atlassian.jira.functest.config.dashboard.DashboardConfigurationCheck

Class Overview

Configuration check that ensures dashboard configuration is clean and consistent.

Summary

Constants
String CHECKID_ABSOLUTE Check to see if there are any gadets with absolute URLs are defined.
String CHECKID_DASHBOARDS Check to see if there are non-system dashboards.
String CHECKID_EXTERNAL Check to see if there are any external gadgets defined.
String CHECKID_GADGETS Check to see if there are gadgets on the dashboards.
Public Constructors
DashboardConfigurationCheck()
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.functest.config.ConfigurationCheck

Constants

public static final String CHECKID_ABSOLUTE

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

Constant Value: "absolutegadgets"

public static final String CHECKID_DASHBOARDS

Check to see if there are non-system dashboards.

Constant Value: "dashboards"

public static final String CHECKID_EXTERNAL

Check to see if there are any external gadgets defined.

Constant Value: "externalgadgets"

public static final String CHECKID_GADGETS

Check to see if there are gadgets on the dashboards.

Constant Value: "gadgets"

Public Constructors

public DashboardConfigurationCheck ()

Public Methods

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

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).

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.

public void fixConfiguration (JiraConfig config, CheckOptions options)

Fix the passed JIRA configuration and remove any errors.

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.