com.atlassian.jira.plugin

Class PluginPath.JiraHomeAdapter

java.lang.Object

com.atlassian.jira.plugin.PluginPath.JiraHomeAdapter

All Implemented Interfaces:

PluginPath

Enclosing interface:

PluginPath

public static class PluginPath.JiraHomeAdapter
extends Object
implements PluginPath

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.plugin.PluginPath

PluginPath.JiraHomeAdapter

Field Summary

Fields inherited from interface com.atlassian.jira.plugin.PluginPath

BUNDLED_SUBDIR, FREEZE_FILE_PATH, INSTALLED_PLUGINS_SUBDIR, OSGI_SUBDIR, PLUGINS_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
JiraHomeAdapter(JiraProperties jiraProperties)

Method Summary

Modifier and Type	Method and Description
File	getBundledPluginsDirectory() The directory where bundled plugins were stored historically.
File	getCustomPluginsDirectory() The custom directory specified by the system property atlassian.jira.plugin.scan.directory to load plugins from.
File	getInstalledPluginsDirectory() The directory where plugins are placed to install them.
com.atlassian.plugin.osgi.container.OsgiPersistentCache	getOsgiPersistentCache() Bascially handles caching of plugin jars (bundled etc) and clearing those directories.
File	getPluginsFreezeFile() A file just like the roster file that is used to "freeze" the state of the installed plugins directory.
File	getPluginsRosterFile() The roster file specified by the system property atlassian.jira.plugin.roster.file to load plugins from.
boolean	isConfigured()

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraHomeAdapter

public JiraHomeAdapter(JiraProperties jiraProperties)

Method Detail

isConfigured

public boolean isConfigured()

Specified by:

isConfigured in interface PluginPath

getInstalledPluginsDirectory

public File getInstalledPluginsDirectory()

Description copied from interface: PluginPath

The directory where plugins are placed to install them.

Specified by:

getInstalledPluginsDirectory in interface PluginPath

Returns:

a File that points to the root plugins dir (ie. ${jira.home}/plugins/installed-plugins)

getBundledPluginsDirectory

public File getBundledPluginsDirectory()

Description copied from interface: PluginPath

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

Specified by:

getBundledPluginsDirectory in interface PluginPath

Returns:

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

getCustomPluginsDirectory

public File getCustomPluginsDirectory()

Description copied from interface: PluginPath

The custom directory specified by the system property atlassian.jira.plugin.scan.directory to load plugins from.

Specified by:

getCustomPluginsDirectory in interface PluginPath

Returns:

A file that points to the path specified by the system property atlassian.jira.plugin.scan.directory.

See Also:

SystemPropertyKeys.CUSTOM_PLUGIN_PATH

getPluginsRosterFile

public File getPluginsRosterFile()

Description copied from interface: PluginPath

The roster file specified by the system property atlassian.jira.plugin.roster.file to load plugins from.

Specified by:

getPluginsRosterFile in interface PluginPath

Returns:

A file that points to the path specified by the system property atlassian.jira.plugin.roster.file.

See Also:

SystemPropertyKeys.PLUGIN_ROSTER_PATH

getPluginsFreezeFile

public File getPluginsFreezeFile()

Description copied from interface: PluginPath

A file just like the roster file that is used to "freeze" the state of the installed plugins directory.

Specified by:

getPluginsFreezeFile in interface PluginPath

Returns:

A file that points to the path specified by the system property atlassian.jira.plugin.roster.file.

getOsgiPersistentCache

public com.atlassian.plugin.osgi.container.OsgiPersistentCache getOsgiPersistentCache()

Description copied from interface: PluginPath

Bascially handles caching of plugin jars (bundled etc) and clearing those directories.

Specified by:

getOsgiPersistentCache in interface PluginPath

Returns:

A OsgiPersistentCache