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

Public Methods

public String getApplicationKey ()

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

public File getBundledPluginCacheDirectory ()

Returns
  • the directory to unzip the bundled plugins into

public URL getBundledPluginUrl ()

Returns
  • the location of the bundled plugins zip

public HostComponentProvider getHostComponentProvider ()

Returns
  • the host component provider

public long getHotDeployPollingPeriod ()

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

public ModuleDescriptorFactory getModuleDescriptorFactory ()

Returns
  • the factory for module descriptors

public OsgiPersistentCache getOsgiPersistentCache ()

Returns
  • the persistent cache configuration

public PackageScannerConfiguration getPackageScannerConfiguration ()

Returns
  • The package scanner configuration

public String getPluginDescriptorFilename ()

Returns
  • the name of the plugin descriptor file

public File getPluginDirectory ()

Returns
  • the directory containing plugins

public PluginPersistentStateStore getPluginStateStore ()

Returns
  • the plugin state store implementation

public boolean isUseLegacyDynamicPluginDeployer ()

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