com.atlassian.jira.config.util
Interface JiraHome

All Known Implementing Classes:

AbstractJiraHome, DefaultJiraHome, JiraHomeLocator.SystemJiraHome, MockJiraHome, StartupJiraHome

public interface JiraHome

Get the location of JIRA's home directory.

Field Summary

static String	CACHES Name of the "Caching" directory in JIRA home.
static String	DATA Name of the "Data" directory in JIRA home.
static String	EXPORT Name of the "Export" directory in JIRA home.
static String	IMPORT Name of the "Import" directory in JIRA home.
static String	IMPORT_ATTACHMENTS Name of the "Import/Attachments" directory in JIRA home.
static Set<String>	localsubdirs
static String	LOG Name of the "Log" directory in JIRA home.
static String	PLUGINS Name of the "Plugins" directory in JIRA home.
static Set<String>	sharedsubdirs
static Set<String>	subdirs Deprecated. since v6.1

Method Summary

File	getCachesDirectory() Get the File object representing the caches directory in JIRA home.
File	getDataDirectory() Get the File object representing the data directory in JIRA home.
File	getExportDirectory() Get the File object representing the export directory in JIRA home.
File	getHome() Get the File object representing the JIRA home directory.
String	getHomePath() Get the canonical path to the JIRA home directory.
File	getImportAttachmentsDirectory() Get the File object representing the import/attachments directory in JIRA home.
File	getImportDirectory() Get the File object representing the import directory in JIRA home.
File	getLocalHome() Get the File object representing the JIRA local home directory.
String	getLocalHomePath() Get the canonical path to the JIRA local home directory.
File	getLogDirectory() Get the File object representing the log directory in JIRA home.
File	getPluginsDirectory() Get the File object representing the plugins directory in JIRA home.

Field Detail

CACHES

static final String CACHES

Name of the "Caching" directory in JIRA home.

See Also:

Constant Field Values

DATA

static final String DATA

Name of the "Data" directory in JIRA home.

See Also:

Constant Field Values

PLUGINS

static final String PLUGINS

Name of the "Plugins" directory in JIRA home.

See Also:

Constant Field Values

EXPORT

static final String EXPORT

Name of the "Export" directory in JIRA home.

See Also:

Constant Field Values

IMPORT

static final String IMPORT

Name of the "Import" directory in JIRA home.

See Also:

Constant Field Values

IMPORT_ATTACHMENTS

static final String IMPORT_ATTACHMENTS

Name of the "Import/Attachments" directory in JIRA home.

See Also:

Constant Field Values

LOG

static final String LOG

Name of the "Log" directory in JIRA home.

See Also:

Constant Field Values

subdirs

@Deprecated
static final Set<String> subdirs

Deprecated. since v6.1

localsubdirs

static final Set<String> localsubdirs

sharedsubdirs

static final Set<String> sharedsubdirs

Method Detail

getHomePath

String getHomePath()

Get the canonical path to the JIRA home directory.

Returns:

the String path

Throws:

IllegalStateException - if the JIRA home is not set.

getHome

@Nonnull
File getHome()

Get the File object representing the JIRA home directory.

Returns:

the file path, must be a directory

Throws:

IllegalStateException - if the JIRA home is not set.

getLocalHome

@Nonnull
File getLocalHome()

Get the File object representing the JIRA local home directory. In a clustered or HA deployment this will be different from jira.home, but in a standalone installation will generally be the same as jira.home.

Returns:

the file path, must be a directory

Throws:

IllegalStateException - if the JIRA home is not set.

getLocalHomePath

String getLocalHomePath()

Get the canonical path to the JIRA local home directory. In a clustered or HA deployment this will be different from jira.home, but in a standalone installation will generally be the same as jira.home.

Returns:

the String path

Throws:

IllegalStateException - if the JIRA home is not set.

getLogDirectory

File getLogDirectory()

Get the File object representing the log directory in JIRA home.

Returns:

the file path, must be a directory.

Throws:

IllegalStateException - if the JIRA home is not set.

getCachesDirectory

File getCachesDirectory()

Get the File object representing the caches directory in JIRA home.

Returns:

the file path, must be a directory.

Throws:

IllegalStateException - if the JIRA home is not set.

getExportDirectory

File getExportDirectory()

Get the File object representing the export directory in JIRA home.

Returns:

the file path, must be a directory.

Throws:

IllegalStateException - if the JIRA home is not set.

getImportDirectory

File getImportDirectory()

Get the File object representing the import directory in JIRA home.

Returns:

the file path, must be a directory.

Throws:

IllegalStateException - if the JIRA home is not set.

getImportAttachmentsDirectory

File getImportAttachmentsDirectory()

Get the File object representing the import/attachments directory in JIRA home.

Returns:

the file path, must be a directory.

Throws:

IllegalStateException - if the JIRA home is not set.

getPluginsDirectory

File getPluginsDirectory()

Get the File object representing the plugins directory in JIRA home.

Returns:

the file path, must be a directory.

Throws:

IllegalStateException - if the JIRA home is not set.

getDataDirectory

File getDataDirectory()

Get the File object representing the data directory in JIRA home.

Returns:

the file path, must be a directory.

Throws:

IllegalStateException - if the JIRA home is not set.