com.atlassian.jira.config.util

Class AbstractJiraHome

java.lang.Object

com.atlassian.jira.config.util.AbstractJiraHome

All Implemented Interfaces:

JiraHome

Direct Known Subclasses:

DefaultJiraHome, JiraHomeLocator.SystemJiraHome, MockJiraHome, SecondaryJiraHome, StartupJiraHome

public abstract class AbstractJiraHome
extends Object
implements JiraHome

Class that helps with the implementation of the JiraHome interface.

Since:

v4.1

Field Summary

Fields inherited from interface com.atlassian.jira.config.util.JiraHome

CACHES, DATA, EXPORT, IMPORT, IMPORT_ATTACHMENTS, INDEX_SNAPSHOTS, INDEXES_DIR, localsubdirs, LOG, PLUGINS, sharedsubdirs, subdirs

Constructor Summary

Constructors

Constructor and Description
AbstractJiraHome()

Method Summary

Modifier and Type	Method and Description
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	getIndexSnapshotsDirectory() Get the File object representing the index snapshots directory in JIRA home.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.jira.config.util.JiraHome

getLocalHome

Constructor Detail

AbstractJiraHome

public AbstractJiraHome()

Method Detail

getHome

@Nonnull
public File getHome()

Description copied from interface: JiraHome

Get the File object representing the JIRA home directory.

Specified by:

getHome in interface JiraHome

Returns:

the file path, must be a directory

getLogDirectory

public final File getLogDirectory()

Description copied from interface: JiraHome

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

Specified by:

getLogDirectory in interface JiraHome

Returns:

the file path, must be a directory.

getCachesDirectory

public final File getCachesDirectory()

Description copied from interface: JiraHome

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

Specified by:

getCachesDirectory in interface JiraHome

Returns:

the file path, must be a directory.

getSharedCachesDirectory

public File getSharedCachesDirectory()

Description copied from interface: JiraHome

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

Specified by:

getSharedCachesDirectory in interface JiraHome

Returns:

the file path, must be a directory.

getExportDirectory

public final File getExportDirectory()

Description copied from interface: JiraHome

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

Specified by:

getExportDirectory in interface JiraHome

Returns:

the file path, must be a directory.

getImportDirectory

public final File getImportDirectory()

Description copied from interface: JiraHome

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

Specified by:

getImportDirectory in interface JiraHome

Returns:

the file path, must be a directory.

getImportAttachmentsDirectory

public final File getImportAttachmentsDirectory()

Description copied from interface: JiraHome

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

Specified by:

getImportAttachmentsDirectory in interface JiraHome

Returns:

the file path, must be a directory.

getPluginsDirectory

public final File getPluginsDirectory()

Description copied from interface: JiraHome

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

Specified by:

getPluginsDirectory in interface JiraHome

Returns:

the file path, must be a directory.

getDataDirectory

public final File getDataDirectory()

Description copied from interface: JiraHome

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

Specified by:

getDataDirectory in interface JiraHome

Returns:

the file path, must be a directory.

getIndexSnapshotsDirectory

public final File getIndexSnapshotsDirectory()

Description copied from interface: JiraHome

Get the File object representing the index snapshots directory in JIRA home.

Specified by:

getIndexSnapshotsDirectory in interface JiraHome

Returns:

the file path, must be a directory.

getHomePath

public final String getHomePath()

Description copied from interface: JiraHome

Get the canonical path to the JIRA home directory.

Specified by:

getHomePath in interface JiraHome

Returns:

the String path

getLocalHomePath

public final String getLocalHomePath()

Description copied from interface: JiraHome

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.

Specified by:

getLocalHomePath in interface JiraHome

Returns:

the String path