public class

IndexDirectoryChecker

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

Class Overview

A check to make sure that indexing is correctly configured in JIRA XML data.

Summary

Constants
String CHECKID_INDEX_DIRECTORY The check that will set the index directory to #FUNC_TEST_INDEX.
String CHECKID_INDEX_ENABLED The check to ensure that indexing is enabled.
String CHECKID_INDEX_HOME The check ID to ensure that we are using JIRA.HOME for indexing.
Public Constructors
IndexDirectoryChecker()
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_INDEX_DIRECTORY

The check that will set the index directory to #FUNC_TEST_INDEX.

Constant Value: "indexdirectory"

public static final String CHECKID_INDEX_ENABLED

The check to ensure that indexing is enabled.

Constant Value: "indexenabled"

public static final String CHECKID_INDEX_HOME

The check ID to ensure that we are using JIRA.HOME for indexing.

Constant Value: "indexhome"

Public Constructors

public IndexDirectoryChecker ()

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.