public class

JiraHomeStartupCheck

extends Object
implements StartupCheck
java.lang.Object
   ↳ com.atlassian.jira.startup.JiraHomeStartupCheck

Class Overview

This StartupCheck will check that there is a valid jira.home configured that we can get an exclusive lock on.

Note: this has the side effect that the jira.home directory is created, if required, and "locked". These side-effects are REQUIRED in order to return valid results.

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.
synchronized static JiraHomeStartupCheck getInstance()
File getJiraHomeDirectory()
String getName()
Implement this method to return the name of this check
boolean isInitialised()
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 instance is coming down
String toString()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.startup.StartupCheck

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 static synchronized JiraHomeStartupCheck getInstance ()

public File getJiraHomeDirectory ()

public String getName ()

Implement this method to return the name of this check

Returns
  • name

public boolean isInitialised ()

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 instance is coming down

public String toString ()