public interface

PluginsConfiguration

com.atlassian.plugin.main.PluginsConfiguration

Class Overview

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

Summary

Public Methods
abstract String getApplicationKey()
abstract File getBundledPluginCacheDirectory()
abstract URL getBundledPluginUrl()
abstract HostComponentProvider getHostComponentProvider()
abstract long getHotDeployPollingPeriod()
abstract ModuleDescriptorFactory getModuleDescriptorFactory()
abstract OsgiPersistentCache getOsgiPersistentCache()
abstract PackageScannerConfiguration getPackageScannerConfiguration()
abstract String getPluginDescriptorFilename()
abstract File getPluginDirectory()
abstract PluginPersistentStateStore getPluginStateStore()
abstract boolean isUseLegacyDynamicPluginDeployer()

Public Methods

public abstract String getApplicationKey ()

Returns
  • the application key to use to filter modules in the descriptor

public abstract File getBundledPluginCacheDirectory ()

Returns
  • the directory to unzip the bundled plugins into

public abstract URL getBundledPluginUrl ()

Returns
  • the location of the bundled plugins zip

public abstract HostComponentProvider getHostComponentProvider ()

Returns
  • the host component provider

public abstract long getHotDeployPollingPeriod ()

Returns
  • the number of milliseconds between polling. Zero to disable.

public abstract ModuleDescriptorFactory getModuleDescriptorFactory ()

Returns
  • the factory for module descriptors

public abstract OsgiPersistentCache getOsgiPersistentCache ()

Returns
  • the persistent cache configuration

public abstract PackageScannerConfiguration getPackageScannerConfiguration ()

Returns
  • The package scanner configuration

public abstract String getPluginDescriptorFilename ()

Returns
  • the name of the plugin descriptor file

public abstract File getPluginDirectory ()

Returns
  • the directory containing plugins

public abstract PluginPersistentStateStore getPluginStateStore ()

Returns
  • the plugin state store implementation

public abstract boolean isUseLegacyDynamicPluginDeployer ()

Returns
  • whether to use the legacy plugin deployer or not.