com.atlassian.jira.config.util
Interface JiraHome

All Known Implementing Classes:
AbstractJiraHome, DefaultJiraHome, JiraHomeLocator.SystemJiraHome, MockJiraHome

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 String LOG
          Name of the "Log" directory in JIRA home.
static String PLUGINS
          Name of the "Plugins" directory in JIRA home.
static Set<String> subdirs
          The subdirectories of jira-home.
 
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 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

static final Set<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

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

@NotNull
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.

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.


Copyright © 2002-2013 Atlassian. All Rights Reserved.