public interface

ConfigurationCheck

com.atlassian.jira.functest.config.ConfigurationCheck
Known Indirect Subclasses

Class Overview

Interface for objects that wish to check the correctness of some JIRA xml.

Summary

Nested Classes
interface ConfigurationCheck.Result  
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.

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.