Package 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

  • Constructor Details

    • AbstractJiraHome

      public AbstractJiraHome()

  • Method Details

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

    • getExportBackupsDirectory

      public File getExportBackupsDirectory()
      Description copied from interface: JiraHome
      Get the File object representing the export/backups directory in JIRA home.
      Specified by:
      getExportBackupsDirectory 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 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