Package com.atlassian.jira.config.util

Interface JiraHome

All Known Implementing Classes:
AbstractJiraHome, DefaultJiraHome, JiraHomeLocator.SystemJiraHome, MockJiraHome, SecondaryJiraHome, StartupJiraHome
public interface JiraHome
Get the location of JIRA's home directory.

  • Field Details

  • Method Details

    • 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

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

    • getLocalHome

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

    • getLocalHomePath

      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.

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

    • getSharedCachesDirectory

      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.

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

    • getExportBackupsDirectory

      File getExportBackupsDirectory()
      Get the File object representing the export/backups 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.

    • getIndexSnapshotsDirectory

      File getIndexSnapshotsDirectory()
      Get the File object representing the index snapshots directory in JIRA home.
      Returns:
      the file path, must be a directory.
      Throws:
      IllegalStateException - if the JIRA home is not set.