Interface PluginPath

All Known Implementing Classes:
PluginPath.JiraHomeAdapter

public interface PluginPath
  • Field Details

    • PLUGINS_DIRECTORY

      static final String PLUGINS_DIRECTORY
      See Also:
    • INSTALLED_PLUGINS_SUBDIR

      static final String INSTALLED_PLUGINS_SUBDIR
    • FREEZE_FILE_PATH

      static final String FREEZE_FILE_PATH
    • OSGI_SUBDIR

      static final String OSGI_SUBDIR
    • BUNDLED_SUBDIR

      static final String BUNDLED_SUBDIR
      Although we no longer copy bundled plugins to this directory, we maintain it (empty) in order to return from getBundledPluginsDirectory(), until we have a plugins with PLUGDEV-43 and we can move this defintion to an upgrade task which removes the directory entirely.

      TODO: https://jdog.jira-dev.com/browse/JDEV-27508

  • Method Details

    • isConfigured

      boolean isConfigured()
    • getInstalledPluginsDirectory

      File getInstalledPluginsDirectory()
      The directory where plugins are placed to install them.
      Returns:
      a File that points to the root plugins dir (ie. ${jira.home}/plugins/installed-plugins)
    • getBundledPluginsDirectory

      File getBundledPluginsDirectory()
      Deprecated.
      This method should not be used by new code, and will be removed when plugins is upgraded.
      The directory where bundled plugins were stored historically.

      This is being maintained to provide a directory for the BundledPluginLoader until we have a plugins with PLUGDEV-43 and can remove this entirely.

      TODO: https://jdog.jira-dev.com/browse/JDEV-27508

      Returns:
      A file that points to the old bundled plugins directory. (ie. ${jira.home}/plugins/.bundled-plugins)
    • getCustomPluginsDirectory

      File getCustomPluginsDirectory()
      The custom directory specified by the system property atlassian.jira.plugin.scan.directory to load plugins from.
      Returns:
      A file that points to the path specified by the system property atlassian.jira.plugin.scan.directory.
      See Also:
    • getPluginsRosterFile

      File getPluginsRosterFile()
      The roster file specified by the system property atlassian.jira.plugin.roster.file to load plugins from.
      Returns:
      A file that points to the path specified by the system property atlassian.jira.plugin.roster.file.
      See Also:
    • getPluginsFreezeFile

      File getPluginsFreezeFile()
      A file just like the roster file that is used to "freeze" the state of the installed plugins directory.
      Returns:
      A file that points to the path specified by the system property atlassian.jira.plugin.roster.file.
    • getOsgiPersistentCache

      com.atlassian.plugin.osgi.container.OsgiPersistentCache getOsgiPersistentCache()
      Bascially handles caching of plugin jars (bundled etc) and clearing those directories.
      Returns:
      A OsgiPersistentCache