com.atlassian.jira.startup
Class JiraHomeStartupCheck

java.lang.Object
  extended by com.atlassian.jira.startup.JiraHomeStartupCheck
All Implemented Interfaces:
StartupCheck

public class JiraHomeStartupCheck
extends java.lang.Object
implements StartupCheck

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.

Since:
v4.0

Constructor Summary
JiraHomeStartupCheck(JiraHomePathLocator locator)
           
 
Method Summary
 java.lang.String getFaultDescription()
          Implement this method to return the description of the fault.
 java.lang.String getHTMLFaultDescription()
          Implement this method to return the error message of the fault.
 java.io.File getJiraHomeDirectory()
           
 java.lang.String getName()
          Implement this method to return the name of this check
static JiraHomeStartupCheck getProductionCheck()
           
 boolean isInitialised()
           
 boolean isOk()
          Implement this method to return true if the check is positive and false in the case of negative result.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JiraHomeStartupCheck

public JiraHomeStartupCheck(JiraHomePathLocator locator)
Method Detail

getProductionCheck

public static JiraHomeStartupCheck getProductionCheck()

getName

public java.lang.String getName()
Description copied from interface: StartupCheck
Implement this method to return the name of this check

Specified by:
getName in interface StartupCheck
Returns:
name

isOk

public boolean isOk()
Description copied from interface: StartupCheck
Implement this method to return true if the check is positive and false in the case of negative result.

Specified by:
isOk in interface StartupCheck
Returns:
true if positive

isInitialised

public boolean isInitialised()

getFaultDescription

public java.lang.String getFaultDescription()
Description copied from interface: StartupCheck
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

Specified by:
getFaultDescription in interface StartupCheck
Returns:
fault description

getHTMLFaultDescription

public java.lang.String getHTMLFaultDescription()
Description copied from interface: StartupCheck
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.

Specified by:
getHTMLFaultDescription in interface StartupCheck
Returns:
HTML formatted fault description

getJiraHomeDirectory

public java.io.File getJiraHomeDirectory()


Copyright © 2002-2010 Atlassian. All Rights Reserved.