com.atlassian.jira.functest.config

Class BackupChecker

java.lang.Object

com.atlassian.jira.functest.config.BackupChecker

All Implemented Interfaces:

ConfigurationCheck

public final class BackupChecker
extends Object
implements ConfigurationCheck

Check to make sure that there are no backup service configured. There are two things to check here:

1. The backup service. We can delete the service, or tell it to use the default directory if the service actually needs to be in the file.
The default (aka global) JIRA backup directory. This is used by the upgrade manager to backup the database before an upgrade on direct database upgrade.

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	BACKUP_SERVICE Name of the class for the export service used in JIRA.
static String	CHECK_BACKUP_SERVICE ID of the check that looks for the backup service.
static String	CHECK_BACKUP_SERVICE_DIRECTORY ID of the check that makes sure the backup path is set to the default if the backup service is required.
static String	CHECK_BACKUP_SERVICE_HOME ID of the check that makes sure the backup path is using JIRA.HOME.
static String	CHECK_GLOBAL_BACKUP_DIRECTORY ID of the check that cleans up JIRA's global backup path.

Constructor Summary

Constructors

Constructor and Description
BackupChecker()

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

CHECK_BACKUP_SERVICE

public static final String CHECK_BACKUP_SERVICE

ID of the check that looks for the backup service.

See Also:

Constant Field Values

CHECK_BACKUP_SERVICE_HOME

public static final String CHECK_BACKUP_SERVICE_HOME

ID of the check that makes sure the backup path is using JIRA.HOME.

See Also:

Constant Field Values

CHECK_BACKUP_SERVICE_DIRECTORY

public static final String CHECK_BACKUP_SERVICE_DIRECTORY

ID of the check that makes sure the backup path is set to the default if the backup service is required.

See Also:

Constant Field Values

CHECK_GLOBAL_BACKUP_DIRECTORY

public static final String CHECK_GLOBAL_BACKUP_DIRECTORY

ID of the check that cleans up JIRA's global backup path. This global backup path is used by the upgrade manager when performing a database upgrade.

See Also:

Constant Field Values

BACKUP_SERVICE

public static final String BACKUP_SERVICE

Name of the class for the export service used in JIRA.

See Also:

Constant Field Values

Constructor Detail

BackupChecker

public BackupChecker()

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.