com.atlassian.jira.startup
Interface StartupCheck

All Known Implementing Classes:

Build178SchemaCheck, BuildVersionCheck, FailedStartupCheck, JiraHomeStartupCheck, MinimumUpgradableVersionCheck, PostgresSchemaConfigCheck, PublicSchemaConfigCheck, SystemPluginsEnabledStartupCheck

public interface StartupCheck

Represents an individual check to be done on startup.

Since:

v4.0

Method Summary

String	getFaultDescription() Implement this method to return the description of the fault.
String	getHTMLFaultDescription() Implement this method to return the error message of the fault.
String	getName() Implement this method to return the name of this check
boolean	isOk() Implement this method to return true if the check is positive and false in the case of negative result.
void	stop() Called when the tenant / instance is coming down

Method Detail

getName

String getName()

Implement this method to return the name of this check

Returns:

name

isOk

boolean isOk()

Implement this method to return true if the check is positive and false in the case of negative result.

Returns:

true if positive

getFaultDescription

String getFaultDescription()

Implement this method to return the description of the fault. This method should return null in the case the check was positive. This message is used to present the user with a message to the console

Returns:

fault description

getHTMLFaultDescription

String getHTMLFaultDescription()

Implement this method to return the error message of the fault. This method should return null in the case the check was positive. This message is used to present the user with a message viewable in a web browser.

Returns:

HTML formatted fault description

stop

void stop()

Called when the tenant / instance is coming down