Package com.atlassian.jira.startup

Interface StartupCheck

All Superinterfaces:
FaultDescription
All Known Implementing Classes:
EmbeddedDatabaseTypeCheck, FailedStartupCheck, JiraHomeStartupCheck
public interface StartupCheck extends FaultDescription
Represents an individual check to be done on startup.
Since:
v4.0

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    default void
    stop()
    Called when the instance is coming down.

    Methods inherited from interface com.atlassian.jira.startup.FaultDescription

    getFaultDescription

  • Method Details

    • 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

    • getHTMLFaultDescription

      @Nullable 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

      default void stop()
      Called when the instance is coming down.