com.atlassian.plugin.main

Interface PluginsConfiguration

public interface PluginsConfiguration

Configuration for the Atlassian Plugins Framework. Instances of this class should be created via the PluginsConfigurationBuilder.

Method Summary

Modifier and Type	Method and Description
Application	getApplication()
File	getBundledPluginCacheDirectory()
URL	getBundledPluginUrl()
File	getFrameworkBundleDirectory()
HostComponentProvider	getHostComponentProvider()
long	getHotDeployPollingPeriod()
ModuleDescriptorFactory	getModuleDescriptorFactory()
OsgiPersistentCache	getOsgiPersistentCache()
PackageScannerConfiguration	getPackageScannerConfiguration()
String	getPluginDescriptorFilename()
File	getPluginDirectory()
PluginPersistentStateStore	getPluginStateStore()
ScopeManager	getScopeManager() Deprecated. in 5.0 for removal in 6.0 when ScopeManager is removed
boolean	isUseLegacyDynamicPluginDeployer()

Method Detail

getPackageScannerConfiguration

PackageScannerConfiguration getPackageScannerConfiguration()

Returns:

The package scanner configuration

getHostComponentProvider

HostComponentProvider getHostComponentProvider()

Returns:

the host component provider

getOsgiPersistentCache

OsgiPersistentCache getOsgiPersistentCache()

Returns:

the persistent cache configuration

getPluginDescriptorFilename

String getPluginDescriptorFilename()

Returns:

the name of the plugin descriptor file

getPluginDirectory

File getPluginDirectory()

Returns:

the directory containing plugins

getBundledPluginUrl

URL getBundledPluginUrl()

Returns:

the location of the bundled plugins zip

getBundledPluginCacheDirectory

File getBundledPluginCacheDirectory()

Returns:

the directory to unzip the bundled plugins into

getModuleDescriptorFactory

ModuleDescriptorFactory getModuleDescriptorFactory()

Returns:

the factory for module descriptors

getPluginStateStore

PluginPersistentStateStore getPluginStateStore()

Returns:

the plugin state store implementation

getHotDeployPollingPeriod

long getHotDeployPollingPeriod()

Returns:

the number of milliseconds between polling. Zero to disable.

isUseLegacyDynamicPluginDeployer

boolean isUseLegacyDynamicPluginDeployer()

Returns:

whether to use the legacy plugin deployer or not.

getApplication

Application getApplication()

Returns:

the application to use to filter modules in the descriptor

getFrameworkBundleDirectory

File getFrameworkBundleDirectory()

Returns:

the directory containing framework bundles

getScopeManager

@Deprecated
ScopeManager getScopeManager()

Deprecated. in 5.0 for removal in 6.0 when ScopeManager is removed

Returns:

the scope manager