com.atlassian.jira.config.util
Interface JiraHome

All Known Implementing Classes:

AbstractJiraHome, DefaultJiraHome

public interface JiraHome

Get the location of JIRA's home directory.

Field Summary

static java.lang.String	CACHES Name of the "Caching" directory in JIRA home.
static java.lang.String	DATA Name of the "Data" directory in JIRA home.
static java.lang.String	EXPORT Name of the "Export" directory in JIRA home.
static java.lang.String	IMPORT Name of the "Import" directory in JIRA home.
static java.lang.String	IMPORT_ATTACHMENTS Name of the "Import/Attachments" directory in JIRA home.
static java.lang.String	LOG Name of the "Log" directory in JIRA home.
static java.lang.String	PLUGINS Name of the "Plugins" directory in JIRA home.
static java.util.Set<java.lang.String>	subdirs The subdirectories of jira-home.

Method Summary

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

Field Detail

CACHES

static final java.lang.String CACHES

Name of the "Caching" directory in JIRA home.

See Also:

Constant Field Values

DATA

static final java.lang.String DATA

Name of the "Data" directory in JIRA home.

See Also:

Constant Field Values

PLUGINS

static final java.lang.String PLUGINS

Name of the "Plugins" directory in JIRA home.

See Also:

Constant Field Values

EXPORT

static final java.lang.String EXPORT

Name of the "Export" directory in JIRA home.

See Also:

Constant Field Values

IMPORT

static final java.lang.String IMPORT

Name of the "Import" directory in JIRA home.

See Also:

Constant Field Values

IMPORT_ATTACHMENTS

static final java.lang.String IMPORT_ATTACHMENTS

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

See Also:

Constant Field Values

LOG

static final java.lang.String LOG

Name of the "Log" directory in JIRA home.

See Also:

Constant Field Values

subdirs

static final java.util.Set<java.lang.String> subdirs

The subdirectories of jira-home. See https://extranet.atlassian.com/display/DEV/Product+Home+Directory+Specification+v1.1 Currently JIRA does not use tmp or config

Method Detail

getHomePath

java.lang.String getHomePath()

Get the canonical path to the JIRA home directory.

Returns:

the String path

Throws:

java.lang.IllegalStateException - if the JIRA home is not set.

getHome

java.io.File getHome()

Get the File object representing the JIRA home directory.

Returns:

the file path, must be a directory

Throws:

java.lang.IllegalStateException - if the JIRA home is not set.

getLogDirectory

java.io.File getLogDirectory()

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

Returns:

the file path, must be a directory.

Throws:

java.lang.IllegalStateException - if the JIRA home is not set.

getCachesDirectory

java.io.File getCachesDirectory()

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

Returns:

the file path, must be a directory.

Throws:

java.lang.IllegalStateException - if the JIRA home is not set.

getExportDirectory

java.io.File getExportDirectory()

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

Returns:

the file path, must be a directory.

Throws:

java.lang.IllegalStateException - if the JIRA home is not set.

getImportDirectory

java.io.File getImportDirectory()

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

Returns:

the file path, must be a directory.

Throws:

java.lang.IllegalStateException - if the JIRA home is not set.

getImportAttachmentsDirectory

java.io.File getImportAttachmentsDirectory()

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

Returns:

the file path, must be a directory.

Throws:

java.lang.IllegalStateException - if the JIRA home is not set.

getPluginsDirectory

java.io.File getPluginsDirectory()

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

Returns:

the file path, must be a directory.

Throws:

java.lang.IllegalStateException - if the JIRA home is not set.

getDataDirectory

java.io.File getDataDirectory()

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

Returns:

the file path, must be a directory.

Throws:

java.lang.IllegalStateException - if the JIRA home is not set.