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

java.lang.String	getApplicationKey()
java.io.File	getBundledPluginCacheDirectory()
java.net.URL	getBundledPluginUrl()
HostComponentProvider	getHostComponentProvider()
long	getHotDeployPollingPeriod()
ModuleDescriptorFactory	getModuleDescriptorFactory()
OsgiPersistentCache	getOsgiPersistentCache()
PackageScannerConfiguration	getPackageScannerConfiguration()
java.lang.String	getPluginDescriptorFilename()
java.io.File	getPluginDirectory()
PluginPersistentStateStore	getPluginStateStore()
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

java.lang.String getPluginDescriptorFilename()

Returns:

the name of the plugin descriptor file

getPluginDirectory

java.io.File getPluginDirectory()

Returns:

the directory containing plugins

getBundledPluginUrl

java.net.URL getBundledPluginUrl()

Returns:

the location of the bundled plugins zip

getBundledPluginCacheDirectory

java.io.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.

getApplicationKey

java.lang.String getApplicationKey()

Returns:

the application key to use to filter modules in the descriptor