Uses of Interface
com.atlassian.plugin.Plugin

Packages that use Plugin

com.atlassian.plugin
com.atlassian.plugin.classloader
com.atlassian.plugin.descriptors
com.atlassian.plugin.event.events	This package contains events that will be fired by the framework.
com.atlassian.plugin.factories
com.atlassian.plugin.impl
com.atlassian.plugin.loaders
com.atlassian.plugin.manager
com.atlassian.plugin.metadata
com.atlassian.plugin.module
com.atlassian.plugin.osgi.bridge.external
com.atlassian.plugin.osgi.factory	Deployers for OSGi-related plugins
com.atlassian.plugin.osgi.factory.descriptor
com.atlassian.plugin.parsers
com.atlassian.plugin.predicate
com.atlassian.plugin.servlet
com.atlassian.plugin.servlet.descriptors
com.atlassian.plugin.util
com.atlassian.plugin.web
com.atlassian.plugin.web.descriptors
com.atlassian.plugin.web.model
com.atlassian.plugin.web.renderer
com.atlassian.plugin.webresource

Uses of Plugin in com.atlassian.plugin

Fields in com.atlassian.plugin with type parameters of type Plugin

static Comparator<Plugin>

Plugin.NAME_COMPARATOR Deprecated. since 2.2.0. This comparator only takes into account the plugin name and assumes it is not null, yet a) that constraint is not validated anywhere in plugin loading and b) the plugin could have used the i18n name, and only the application can resolve that to a name useful for comparisons.

Methods in com.atlassian.plugin that return Plugin

Plugin	PluginAccessor.getEnabledPlugin(String pluginKey) Retrieve a given plugin if it is enabled.
Plugin	ModuleDescriptor.getPlugin()
Plugin	PluginAccessor.getPlugin(String key) Retrieve a given plugin (whether enabled or not).

Methods in com.atlassian.plugin that return types with arguments of type Plugin

Collection<Plugin>	PluginAccessor.getEnabledPlugins() Get all of the currently enabled plugins.
Collection<Plugin>	PluginAccessor.getPlugins() Gets all of the currently installed plugins.
Collection<Plugin>	PluginAccessor.getPlugins(PluginPredicate pluginPredicate) Gets all installed plugins that match the given predicate.

Methods in com.atlassian.plugin with parameters of type Plugin

void	ModuleDescriptor.destroy(Plugin plugin) Override this if your plugin needs to clean up when it's been removed.
void	ModuleDescriptor.init(Plugin plugin, org.dom4j.Element element) Initialise a module given it's parent plugin and the XML element representing the module.
void	PluginController.uninstall(Plugin plugin) Uninstall the plugin, disabling it first.

Uses of Plugin in com.atlassian.plugin.classloader

Methods in com.atlassian.plugin.classloader that return Plugin

Plugin

PluginsClassLoader.getPluginForClass(String className) Returns the Plugin that will be used to load the given class name.

Methods in com.atlassian.plugin.classloader with parameters of type Plugin

void	PluginsClassLoader.notifyUninstallPlugin(Plugin plugin)

Uses of Plugin in com.atlassian.plugin.descriptors

Fields in com.atlassian.plugin.descriptors declared as Plugin

protected Plugin

AbstractModuleDescriptor.plugin

Methods in com.atlassian.plugin.descriptors that return Plugin

Plugin

AbstractModuleDescriptor.getPlugin()

Methods in com.atlassian.plugin.descriptors with parameters of type Plugin

static UnloadableModuleDescriptor	UnloadableModuleDescriptorFactory.createUnloadableModuleDescriptor(Plugin plugin, org.dom4j.Element element, Throwable e, ModuleDescriptorFactory moduleDescriptorFactory) Creates a new UnloadableModuleDescriptor, for when a problem occurs during the construction of the ModuleDescriptor itself.
static UnloadableModuleDescriptor	UnloadableModuleDescriptorFactory.createUnloadableModuleDescriptor(Plugin plugin, ModuleDescriptor<?> descriptor, Throwable e) Creates a new UnloadableModuleDescriptor based on an existing ModuleDescriptor, descriptor This method uses the information in an existing descriptor to construct a new UnloadableModuleDescriptor.
static UnrecognisedModuleDescriptor	UnrecognisedModuleDescriptorFactory.createUnrecognisedModuleDescriptor(Plugin plugin, org.dom4j.Element element, Throwable e, ModuleDescriptorFactory moduleDescriptorFactory) Creates a new UnrecognisedModuleDescriptor, for when a problem occurs during the retrieval of the ModuleDescriptor itself.
void	AbstractModuleDescriptor.destroy(Plugin plugin) Override this if your plugin needs to clean up when it's been removed.
void	AbstractModuleDescriptor.init(Plugin plugin, org.dom4j.Element element)
protected void	UnloadableModuleDescriptor.loadClass(Plugin plugin, org.dom4j.Element element)
protected void	AbstractModuleDescriptor.loadClass(Plugin plugin, org.dom4j.Element element) Deprecated. Since 2.1.0, use AbstractModuleDescriptor.loadClass(Plugin,String) instead
protected void	AbstractModuleDescriptor.loadClass(Plugin plugin, String clazz) Loads the module class that this descriptor provides, and will not necessarily be the implementation class.
void	AbstractModuleDescriptor.setPlugin(Plugin plugin) Sets the plugin for the ModuleDescriptor

Uses of Plugin in com.atlassian.plugin.event.events

Methods in com.atlassian.plugin.event.events that return Plugin

Plugin	PluginEnabledEvent.getPlugin()
Plugin	PluginDisabledEvent.getPlugin()
Plugin	PluginRefreshedEvent.getPlugin()
Plugin	PluginUninstalledEvent.getPlugin()
Plugin	PluginUpgradedEvent.getPlugin()

Constructors in com.atlassian.plugin.event.events with parameters of type Plugin

PluginDisabledEvent(Plugin plugin)

PluginEnabledEvent(Plugin plugin)

PluginRefreshedEvent(Plugin plugin)

PluginUninstalledEvent(Plugin plugin)

PluginUpgradedEvent(Plugin plugin)
Constructs the event

Uses of Plugin in com.atlassian.plugin.factories

Methods in com.atlassian.plugin.factories that return Plugin

Plugin	XmlDynamicPluginFactory.create(DeploymentUnit deploymentUnit, ModuleDescriptorFactory moduleDescriptorFactory) Deprecated. Since 2.2.0, use XmlDynamicPluginFactory.create(PluginArtifact,ModuleDescriptorFactory) instead
Plugin	PluginFactory.create(DeploymentUnit deploymentUnit, ModuleDescriptorFactory moduleDescriptorFactory) Deprecated. Since 2.2.0, use PluginFactory.create(PluginArtifact,ModuleDescriptorFactory) instead
Plugin	LegacyDynamicPluginFactory.create(DeploymentUnit deploymentUnit, ModuleDescriptorFactory moduleDescriptorFactory) Deprecated. Since 2.2.0, use LegacyDynamicPluginFactory.create(PluginArtifact,ModuleDescriptorFactory) instead
Plugin	XmlDynamicPluginFactory.create(PluginArtifact pluginArtifact, ModuleDescriptorFactory moduleDescriptorFactory) Deploys the plugin artifact
Plugin	PluginFactory.create(PluginArtifact pluginArtifact, ModuleDescriptorFactory moduleDescriptorFactory) Deploys the plugin artifact by instantiating the plugin and configuring it.
Plugin	LegacyDynamicPluginFactory.create(PluginArtifact pluginArtifact, ModuleDescriptorFactory moduleDescriptorFactory) Deploys the plugin artifact
protected Plugin	LegacyDynamicPluginFactory.createPlugin(DeploymentUnit deploymentUnit, PluginClassLoader loader) Deprecated. Since 2.2.0, use LegacyDynamicPluginFactory.createPlugin(PluginArtifact,PluginClassLoader) instead
protected Plugin	LegacyDynamicPluginFactory.createPlugin(PluginArtifact pluginArtifact, PluginClassLoader loader) Creates the plugin.

Uses of Plugin in com.atlassian.plugin.impl

Subinterfaces of Plugin in com.atlassian.plugin.impl

interface

DynamicPlugin Deprecated. since 2.2.0, use a wrapping plugin based on AbstractDelegatingPlugin instead

Classes in com.atlassian.plugin.impl that implement Plugin

class	AbstractDelegatingPlugin Delegating plugin that supports easy wrapping
class	AbstractPlugin
class	DefaultDynamicPlugin A dynamically loaded plugin is loaded through the plugin class loader.
class	StaticPlugin
class	UnloadablePlugin This class represents a Plugin that was not able to be loaded by the PluginManager.
class	XmlDynamicPlugin A dynamic XML plugin that consists of the Atlassian plugin descriptor

Methods in com.atlassian.plugin.impl that return Plugin

Plugin

AbstractDelegatingPlugin.getDelegate()

Methods in com.atlassian.plugin.impl with parameters of type Plugin

int	AbstractPlugin.compareTo(Plugin otherPlugin) Compares this Plugin to another Plugin for order.
int	AbstractDelegatingPlugin.compareTo(Plugin o)
static UnloadablePlugin	UnloadablePluginFactory.createUnloadablePlugin(Plugin oldPlugin) Creates an UnloadablePlugin instance from a given plugin, when there were problems loading the modules or the plugin itself
static UnloadablePlugin	UnloadablePluginFactory.createUnloadablePlugin(Plugin oldPlugin, UnloadableModuleDescriptor unloadableDescriptor) Creates an UnloadablePlugin instance from a given plugin.

Constructors in com.atlassian.plugin.impl with parameters of type Plugin

AbstractDelegatingPlugin(Plugin delegate)

Uses of Plugin in com.atlassian.plugin.loaders

Fields in com.atlassian.plugin.loaders with type parameters of type Plugin

protected Collection<Plugin>	SinglePluginLoader.plugins
protected Map<DeploymentUnit,Plugin>	ScanningPluginLoader.plugins

Methods in com.atlassian.plugin.loaders that return Plugin

protected Plugin	ScanningPluginLoader.deployPluginFromUnit(DeploymentUnit deploymentUnit, ModuleDescriptorFactory moduleDescriptorFactory)
protected Plugin	SinglePluginLoader.loadPlugin(ModuleDescriptorFactory moduleDescriptorFactory)
protected Plugin	BundledPluginLoader.postProcess(Plugin plugin)
protected Plugin	ScanningPluginLoader.postProcess(Plugin plugin) Template method that can be used by a specific PluginLoader to add information to a Plugin after it has been loaded.

Methods in com.atlassian.plugin.loaders that return types with arguments of type Plugin

Collection<Plugin>	SinglePluginLoader.addFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
Collection<Plugin>	ClassPathPluginLoader.addFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
Collection<Plugin>	ScanningPluginLoader.addFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
Collection<Plugin>	PluginLoader.addFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
Collection<Plugin>	SinglePluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
Collection<Plugin>	ClassPathPluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
Collection<Plugin>	ScanningPluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
Collection<Plugin>	PluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory)

Methods in com.atlassian.plugin.loaders with parameters of type Plugin

protected Plugin	BundledPluginLoader.postProcess(Plugin plugin)
protected Plugin	ScanningPluginLoader.postProcess(Plugin plugin) Template method that can be used by a specific PluginLoader to add information to a Plugin after it has been loaded.
void	SinglePluginLoader.removePlugin(Plugin plugin)
void	ClassPathPluginLoader.removePlugin(Plugin plugin)
void	ScanningPluginLoader.removePlugin(Plugin plugin)
void	PluginLoader.removePlugin(Plugin plugin) Remove a specific plugin

Uses of Plugin in com.atlassian.plugin.manager

Methods in com.atlassian.plugin.manager that return Plugin

Plugin	DefaultPluginManager.getEnabledPlugin(String pluginKey)
Plugin	DefaultPluginManager.getPlugin(String key)

Methods in com.atlassian.plugin.manager that return types with arguments of type Plugin

Collection<Plugin>	DefaultPluginManager.getEnabledPlugins()
Collection<Plugin>	DefaultPluginManager.getPlugins()
Collection<Plugin>	DefaultPluginManager.getPlugins(PluginPredicate pluginPredicate)

Methods in com.atlassian.plugin.manager with parameters of type Plugin

protected void	DefaultPluginManager.addPlugin(PluginLoader loader, Plugin plugin) Deprecated. Since 2.0.2, use #addPlugins(PluginLoader,Collection...) instead
protected void	DefaultPluginManager.disablePluginState(Plugin plugin, PluginPersistentStateStore stateStore)
protected void	DefaultPluginManager.enablePluginState(Plugin plugin, PluginPersistentStateStore stateStore)
Map<String,Boolean>	PluginPersistentState.getPluginStateMap(Plugin plugin) Get state map of the given plugin and its modules
Map<String,Boolean>	DefaultPluginPersistentState.getPluginStateMap(Plugin plugin)
boolean	PluginPersistentState.isEnabled(Plugin plugin) Whether or not a plugin is enabled, calculated from it's current state AND default state.
boolean	DefaultPluginPersistentState.isEnabled(Plugin plugin)
protected void	DefaultPluginManager.notifyPluginDisabled(Plugin plugin)
protected void	DefaultPluginManager.notifyPluginEnabled(Plugin plugin) Called on all clustered application nodes, rather than DefaultPluginManager.enablePlugin(String) to just update the local state, state aware modules and loaders, but not affect the global plugin state.
protected void	DefaultPluginManager.notifyUninstallPlugin(Plugin plugin)
protected void	DefaultPluginManager.removeStateFromStore(PluginPersistentStateStore stateStore, Plugin plugin)
PluginPersistentState.Builder	PluginPersistentState.Builder.setEnabled(Plugin plugin, boolean isEnabled)
void	DefaultPluginManager.uninstall(Plugin plugin)
protected void	DefaultPluginManager.uninstallNoEvent(Plugin plugin) Preforms an uninstallation without broadcasting the uninstallation event.
protected void	DefaultPluginManager.unloadPlugin(Plugin plugin) Unload a plugin.
protected void	DefaultPluginManager.updatePlugin(Plugin oldPlugin, Plugin newPlugin) Replace an already loaded plugin with another version.

Method parameters in com.atlassian.plugin.manager with type arguments of type Plugin

protected void

DefaultPluginManager.addPlugins(PluginLoader loader, Collection<Plugin> pluginsToInstall) Update the local plugin state and enable state aware modules.

Uses of Plugin in com.atlassian.plugin.metadata

Methods in com.atlassian.plugin.metadata with parameters of type Plugin

boolean	ClasspathFilePluginMetadata.applicationProvided(Plugin plugin)
boolean	DefaultPluginMetadataManager.isOptional(Plugin plugin) A plugin is determined to be optional if the host application has not indicated to the plugins system that it is required or if any of its modules have been flagged as not optional.
boolean	PluginMetadataManager.isOptional(Plugin plugin) This is used to determine if a plugin is considered optional.
boolean	DefaultPluginMetadataManager.isUserInstalled(Plugin plugin) A plugin is determined to be non-user if isBundledPlugin() is true or if the host application has indicated to the plugins system that a plugin was provided by it.
boolean	PluginMetadataManager.isUserInstalled(Plugin plugin) This is used to determine if the plugin was provided by the host application or provided by a user.
boolean	ClasspathFilePluginMetadata.required(Plugin plugin)

Uses of Plugin in com.atlassian.plugin.module

Subinterfaces of Plugin in com.atlassian.plugin.module

interface

ContainerManagedPlugin A plugin that is managed by a container

Uses of Plugin in com.atlassian.plugin.osgi.bridge.external

Methods in com.atlassian.plugin.osgi.bridge.external that return Plugin

Plugin

PluginRetrievalService.getPlugin()

Uses of Plugin in com.atlassian.plugin.osgi.factory

Classes in com.atlassian.plugin.osgi.factory that implement Plugin

class	OsgiBundlePlugin Plugin that wraps an OSGi bundle that has no plugin descriptor.
class	OsgiPlugin Plugin that wraps an OSGi bundle that does contain a plugin descriptor.

Methods in com.atlassian.plugin.osgi.factory that return Plugin

Plugin	OsgiBundleFactory.create(DeploymentUnit deploymentUnit, ModuleDescriptorFactory moduleDescriptorFactory) Deprecated. Since 2.2.0, use OsgiBundleFactory.create(PluginArtifact,ModuleDescriptorFactory) instead
Plugin	OsgiPluginFactory.create(DeploymentUnit deploymentUnit, ModuleDescriptorFactory moduleDescriptorFactory) Deprecated. Since 2.2.0, use OsgiPluginFactory.create(PluginArtifact,ModuleDescriptorFactory) instead
Plugin	UnloadableStaticPluginFactory.create(DeploymentUnit deploymentUnit, ModuleDescriptorFactory moduleDescriptorFactory) Deprecated. Since 2.2.0, use UnloadableStaticPluginFactory.create(PluginArtifact,ModuleDescriptorFactory) instead
Plugin	OsgiBundleFactory.create(PluginArtifact pluginArtifact, ModuleDescriptorFactory moduleDescriptorFactory) Deploys the plugin artifact
Plugin	OsgiPluginFactory.create(PluginArtifact pluginArtifact, ModuleDescriptorFactory moduleDescriptorFactory) Deploys the plugin artifact
Plugin	UnloadableStaticPluginFactory.create(PluginArtifact pluginArtifact, ModuleDescriptorFactory moduleDescriptorFactory) Creates an unloadable plugin

Methods in com.atlassian.plugin.osgi.factory with parameters of type Plugin

protected ModuleDescriptor<?>

OsgiPluginXmlDescriptorParser.createModuleDescriptor(Plugin plugin, org.dom4j.Element element, ModuleDescriptorFactory moduleDescriptorFactory) Passes module descriptor elements back to the OsgiPlugin

Uses of Plugin in com.atlassian.plugin.osgi.factory.descriptor

Methods in com.atlassian.plugin.osgi.factory.descriptor with parameters of type Plugin

protected void

ComponentModuleDescriptor.loadClass(Plugin plugin, String clazz)

Uses of Plugin in com.atlassian.plugin.parsers

Methods in com.atlassian.plugin.parsers that return Plugin

Plugin	XmlDescriptorParser.configurePlugin(ModuleDescriptorFactory moduleDescriptorFactory, Plugin plugin)
Plugin	DescriptorParser.configurePlugin(ModuleDescriptorFactory moduleDescriptorFactory, Plugin plugin) Sets the configuration on the plugin argument to match the configuration specified in the plugin descriptor (typically an XML file).

Methods in com.atlassian.plugin.parsers with parameters of type Plugin

Plugin	XmlDescriptorParser.configurePlugin(ModuleDescriptorFactory moduleDescriptorFactory, Plugin plugin)
Plugin	DescriptorParser.configurePlugin(ModuleDescriptorFactory moduleDescriptorFactory, Plugin plugin) Sets the configuration on the plugin argument to match the configuration specified in the plugin descriptor (typically an XML file).
protected ModuleDescriptor<?>	XmlDescriptorParser.createModuleDescriptor(Plugin plugin, org.dom4j.Element element, ModuleDescriptorFactory moduleDescriptorFactory)

Uses of Plugin in com.atlassian.plugin.predicate

Methods in com.atlassian.plugin.predicate with parameters of type Plugin

boolean	PluginPredicate.matches(Plugin plugin) Will match a plugin according to implementation rules.
boolean	EnabledPluginPredicate.matches(Plugin plugin)

Uses of Plugin in com.atlassian.plugin.servlet

Constructors in com.atlassian.plugin.servlet with parameters of type Plugin

DownloadableClasspathResource(Plugin plugin, ResourceLocation resourceLocation, String extraPath)

DownloadableWebResource(Plugin plugin, ResourceLocation resourceLocation, String extraPath, javax.servlet.ServletContext servletContext, boolean disableMinification)

PluginServletContextWrapper(Plugin plugin, javax.servlet.ServletContext context, ConcurrentMap<String,Object> attributes, Map<String,String> initParams)

Uses of Plugin in com.atlassian.plugin.servlet.descriptors

Methods in com.atlassian.plugin.servlet.descriptors with parameters of type Plugin

void	BaseServletModuleDescriptor.init(Plugin plugin, org.dom4j.Element element)
void	ServletContextParamModuleDescriptor.init(Plugin plugin, org.dom4j.Element element)
void	ServletFilterModuleDescriptor.init(Plugin plugin, org.dom4j.Element element)

Uses of Plugin in com.atlassian.plugin.util

Methods in com.atlassian.plugin.util with parameters of type Plugin

static boolean	PluginUtils.doesPluginRequireRestart(Plugin plugin) Determines if a plugin requires a restart after being installed at runtime.
static Set<String>	PluginUtils.getPluginModulesThatRequireRestart(Plugin plugin) Gets a list of all the module keys in a plugin that require restart.

Uses of Plugin in com.atlassian.plugin.web

Methods in com.atlassian.plugin.web with parameters of type Plugin

Condition	WebFragmentHelper.loadCondition(String className, Plugin plugin) Creates a condition instance.
ContextProvider	WebFragmentHelper.loadContextProvider(String className, Plugin plugin) Creates a context provider instance.

Uses of Plugin in com.atlassian.plugin.web.descriptors

Methods in com.atlassian.plugin.web.descriptors that return Plugin

Plugin

DefaultAbstractWebFragmentModuleDescriptor.getPlugin()

Methods in com.atlassian.plugin.web.descriptors with parameters of type Plugin

void	DefaultAbstractWebFragmentModuleDescriptor.destroy(Plugin plugin)
void	AbstractWebFragmentModuleDescriptor.init(Plugin plugin, org.dom4j.Element element)
void	DefaultAbstractWebFragmentModuleDescriptor.init(Plugin plugin, org.dom4j.Element element)
void	DefaultWebPanelModuleDescriptor.init(Plugin plugin, org.dom4j.Element element)
void	WebPanelRendererModuleDescriptor.init(Plugin plugin, org.dom4j.Element element)
void	DefaultWebSectionModuleDescriptor.init(Plugin plugin, org.dom4j.Element element)
void	DefaultWebItemModuleDescriptor.init(Plugin plugin, org.dom4j.Element element)

Uses of Plugin in com.atlassian.plugin.web.model

Fields in com.atlassian.plugin.web.model declared as Plugin

protected Plugin

AbstractWebPanel.plugin

Methods in com.atlassian.plugin.web.model with parameters of type Plugin

void	AbstractWebPanel.setPlugin(Plugin plugin)

Uses of Plugin in com.atlassian.plugin.web.renderer

Methods in com.atlassian.plugin.web.renderer with parameters of type Plugin

void	WebPanelRenderer.render(String templateName, Plugin plugin, Map<String,Object> context, Writer writer) Renders the template to the writer.
void	StaticWebPanelRenderer.render(String templateName, Plugin plugin, Map<String,Object> context, Writer writer)
String	WebPanelRenderer.renderFragment(String fragment, Plugin plugin, Map<String,Object> context) Renders the fragment using the given context and adding I18nResolver and WebResourceManager.
String	StaticWebPanelRenderer.renderFragment(String fragment, Plugin plugin, Map<String,Object> context)

Uses of Plugin in com.atlassian.plugin.webresource

Methods in com.atlassian.plugin.webresource with parameters of type Plugin

void	WebResourceModuleDescriptor.init(Plugin plugin, org.dom4j.Element element)