Summary: Methods | [Expand All]
public interface

StartupCheck

com.atlassian.jira.startup.StartupCheck
Known Indirect Subclasses

Class Overview

Represents an individual check to be done on startup.

Summary

Public Methods
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

Public Methods

public 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

public 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

public String getName ()

Implement this method to return the name of this check

Returns
  • name

public 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

public void stop ()

Called when the tenant / instance is coming down