com.atlassian.jira.functest.config

Class IndexDirectoryChecker

java.lang.Object

com.atlassian.jira.functest.config.IndexDirectoryChecker

All Implemented Interfaces:

ConfigurationCheck

public class IndexDirectoryChecker
extends Object
implements ConfigurationCheck

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

Since:

v4.0

Nested Class Summary

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

ConfigurationCheck.Result

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECKID_INDEX_DIRECTORY The check that will set the index directory to FUNC_TEST_INDEX.
static String	CHECKID_INDEX_ENABLED The check to ensure that indexing is enabled.
static String	CHECKID_INDEX_HOME The check ID to ensure that we are using JIRA.HOME for indexing.

Constructor Summary

Constructors

Constructor and Description
IndexDirectoryChecker()

Method Summary

Modifier and Type	Method and Description
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_INDEX_HOME

public static final String CHECKID_INDEX_HOME

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

See Also:

Constant Field Values

CHECKID_INDEX_ENABLED

public static final String CHECKID_INDEX_ENABLED

The check to ensure that indexing is enabled.

See Also:

Constant Field Values

CHECKID_INDEX_DIRECTORY

public static final String CHECKID_INDEX_DIRECTORY

The check that will set the index directory to FUNC_TEST_INDEX.

See Also:

Constant Field Values

Constructor Detail

IndexDirectoryChecker

public IndexDirectoryChecker()

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.