public interface

JiraHome

com.atlassian.jira.config.util.JiraHome
Known Indirect Subclasses

Class Overview

Get the location of JIRA's home directory.

Summary

Constants
String CACHES Name of the "Caching" directory in JIRA home.
String DATA Name of the "Data" directory in JIRA home.
String EXPORT Name of the "Export" directory in JIRA home.
String IMPORT Name of the "Import" directory in JIRA home.
String IMPORT_ATTACHMENTS Name of the "Import/Attachments" directory in JIRA home.
String LOG Name of the "Log" directory in JIRA home.
String PLUGINS Name of the "Plugins" directory in JIRA home.
Fields
public static final Set<String> localsubdirs
public static final Set<String> sharedsubdirs
public static final Set<String> subdirs This field is deprecated. since v6.1
Public Methods
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.
@Nonnull 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.
@Nonnull 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.
File getSharedCachesDirectory()
Get the File object representing the caches directory in JIRA home.

Constants

public static final String CACHES

Name of the "Caching" directory in JIRA home.

Constant Value: "caches"

public static final String DATA

Name of the "Data" directory in JIRA home.

Constant Value: "data"

public static final String EXPORT

Name of the "Export" directory in JIRA home.

Constant Value: "export"

public static final String IMPORT

Name of the "Import" directory in JIRA home.

Constant Value: "import"

public static final String IMPORT_ATTACHMENTS

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

Constant Value: "attachments"

public static final String LOG

Name of the "Log" directory in JIRA home.

Constant Value: "log"

public static final String PLUGINS

Name of the "Plugins" directory in JIRA home.

Constant Value: "plugins"

Fields

public static final Set<String> localsubdirs

public static final Set<String> sharedsubdirs

public static final Set<String> subdirs

This field is deprecated.
since v6.1

Public Methods

public 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.

public 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.

public 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.

@Nonnull public 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.

public String getHomePath ()

Get the canonical path to the JIRA home directory.

Returns
  • the String path
Throws
IllegalStateException if the JIRA home is not set.

public 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.

public 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.

@Nonnull public 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.

public 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.

public 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.

public 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.

public File getSharedCachesDirectory ()

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.