Uses of Interface
com.atlassian.plugin.Plugin

Packages that use Plugin

Package	Description
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.exception
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.parsers
com.atlassian.plugin.predicate
com.atlassian.plugin.util
com.atlassian.plugin.util.collect
com.atlassian.plugin.util.resource	Classes having to do with resource loading, particularly from alternative locations.

Uses of Plugin in com.atlassian.plugin

Subinterfaces of Plugin in com.atlassian.plugin

Modifier and Type	Interface and Description
interface	PluginArtifactBackedPlugin Applied to Plugin implementations which are produced by PluginFactorys that are backed by PluginArtifacts

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

Modifier and Type	Field and Description
static java.util.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

Modifier and Type	Method and Description
static Plugin	Permissions.addPermission(Plugin plugin, java.lang.String permission, InstallationMode mode)
Plugin	PluginAccessor.getEnabledPlugin(java.lang.String pluginKey) Retrieve a given plugin if it is enabled.
Plugin	ModuleDescriptor.getPlugin()
Plugin	PluginAccessor.getPlugin(java.lang.String key) Retrieve a given plugin (whether enabled or not).

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

Modifier and Type	Method and Description
java.util.Collection<Plugin>	PluginAccessor.getEnabledPlugins() Get all of the currently enabled plugins.
java.util.Collection<Plugin>	PluginAccessor.getPlugins() Gets all of the currently installed plugins.
java.util.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

Modifier and Type	Method and Description
static Plugin	Permissions.addPermission(Plugin plugin, java.lang.String permission, InstallationMode mode)
void	ModuleDescriptor.destroy(Plugin plugin) Deprecated. The plugin parameter is redundant. Override ModuleDescriptor.destroy().
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

Modifier and Type	Method and Description
Plugin	PluginsClassLoader.getPluginForClass(java.lang.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

Modifier and Type	Method and Description
void	PluginsClassLoader.notifyUninstallPlugin(Plugin plugin)

Uses of Plugin in com.atlassian.plugin.descriptors

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

Modifier and Type	Field and Description
protected Plugin	AbstractModuleDescriptor.plugin

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

Modifier and Type	Method and Description
Plugin	AbstractModuleDescriptor.getPlugin()

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

Modifier and Type	Method and Description
static UnloadableModuleDescriptor	UnloadableModuleDescriptorFactory.createUnloadableModuleDescriptor(Plugin plugin, org.dom4j.Element element, java.lang.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, java.lang.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, java.lang.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) Deprecated.
void	AbstractModuleDescriptor.init(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	UnloadableModuleDescriptor.loadClass(Plugin plugin, org.dom4j.Element element)
protected void	AbstractModuleDescriptor.loadClass(Plugin plugin, java.lang.String clazz) Loads the module class that this descriptor provides, and will not necessarily be the implementation class.
protected void	UnloadableModuleDescriptor.loadClass(Plugin plugin, java.lang.String clazz)
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

Modifier and Type	Method and Description
Plugin	PluginRefreshedEvent.getPlugin()
Plugin	PluginEnabledEvent.getPlugin()
Plugin	PluginDisabledEvent.getPlugin()
Plugin	PluginUninstalledEvent.getPlugin()
Plugin	PluginUpgradedEvent.getPlugin()

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

Constructor and Description
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.exception

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

Modifier and Type	Method and Description
boolean	NoOpPluginExceptionInterception.onEnableException(Plugin plugin, java.lang.Exception pluginException)
boolean	PluginExceptionInterception.onEnableException(Plugin plugin, java.lang.Exception pluginException) This is called when a plugin cant be enabled because an exception has been thrown.

Uses of Plugin in com.atlassian.plugin.factories

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

Modifier and Type	Method and Description
Plugin	AbstractPluginFactory.create(DeploymentUnit deploymentUnit, ModuleDescriptorFactory moduleDescriptorFactory) Deprecated. Since 2.2.0, use PluginFactory.create(com.atlassian.plugin.PluginArtifact, com.atlassian.plugin.ModuleDescriptorFactory) instead
Plugin	PluginFactory.create(DeploymentUnit deploymentUnit, ModuleDescriptorFactory moduleDescriptorFactory) Deprecated. Since 2.2.0, use PluginFactory.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

Modifier and Type	Interface and Description
interface	DynamicPlugin Deprecated. since 2.2.0, use a wrapping plugin based on AbstractDelegatingPlugin instead

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

Modifier and Type	Class and Description
class	AbstractDelegatingPlugin Delegating plugin that supports easy wrapping Note: this class has a natural ordering that is inconsistent with equals
class	AbstractPlugin Represents the base class for all plugins.
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

Modifier and Type	Method and Description
Plugin	AbstractDelegatingPlugin.getDelegate()

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

Modifier and Type	Method and Description
int	AbstractDelegatingPlugin.compareTo(Plugin o)
int	AbstractPlugin.compareTo(Plugin otherPlugin) Compares this Plugin to another Plugin for order.
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

Constructor and Description
AbstractDelegatingPlugin(Plugin delegate)

Uses of Plugin in com.atlassian.plugin.loaders

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

Modifier and Type	Field and Description
protected java.util.Map<DeploymentUnit,Plugin>	ScanningPluginLoader.plugins
protected java.util.Collection<Plugin>	SinglePluginLoader.plugins

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

Modifier and Type	Method and Description
protected Plugin	ScanningPluginLoader.deployPluginFromUnit(DeploymentUnit deploymentUnit, ModuleDescriptorFactory moduleDescriptorFactory)
protected Plugin	SinglePluginLoader.loadPlugin(ModuleDescriptorFactory moduleDescriptorFactory)
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.
protected Plugin	BundledPluginLoader.postProcess(Plugin plugin)

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

Modifier and Type	Method and Description
java.lang.Iterable<Plugin>	PluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory) Loads all plugins that can be installed in the plugin system.
java.lang.Iterable<Plugin>	ScanningPluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
java.lang.Iterable<Plugin>	ClassPathPluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
java.lang.Iterable<Plugin>	SinglePluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
java.lang.Iterable<Plugin>	PermissionCheckingPluginLoader.loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
java.lang.Iterable<Plugin>	PluginLoader.loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory) Load all newly found plugins that can be installed in the plugin system.
java.lang.Iterable<Plugin>	ScanningPluginLoader.loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
java.lang.Iterable<Plugin>	ClassPathPluginLoader.loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
java.lang.Iterable<Plugin>	SinglePluginLoader.loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
java.lang.Iterable<Plugin>	PermissionCheckingPluginLoader.loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory)

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

Modifier and Type	Method and Description
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.
protected Plugin	BundledPluginLoader.postProcess(Plugin plugin)
void	PluginLoader.removePlugin(Plugin plugin) Remove a specific plugin
void	ScanningPluginLoader.removePlugin(Plugin plugin)
void	ClassPathPluginLoader.removePlugin(Plugin plugin)
void	SinglePluginLoader.removePlugin(Plugin plugin)
void	PermissionCheckingPluginLoader.removePlugin(Plugin plugin)

Uses of Plugin in com.atlassian.plugin.manager

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

Modifier and Type	Method and Description
Plugin	DefaultPluginManager.getEnabledPlugin(java.lang.String pluginKey)
Plugin	DefaultPluginManager.getPlugin(java.lang.String key)

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

Modifier and Type	Method and Description
java.util.Collection<Plugin>	DefaultPluginManager.getEnabledPlugins()
java.util.Collection<Plugin>	DefaultPluginManager.getPlugins()
java.util.Collection<Plugin>	DefaultPluginManager.getPlugins(PluginPredicate pluginPredicate)

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

Modifier and Type	Method and Description
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)
java.util.Map<java.lang.String,java.lang.Boolean>	PluginPersistentState.getPluginStateMap(Plugin plugin) Get state map of the given plugin and its modules
java.util.Map<java.lang.String,java.lang.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) Uninstalls the given plugin, emitting disabled and uninstalled events as it does so.
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

Modifier and Type	Method and Description
protected void	DefaultPluginManager.addPlugins(PluginLoader loader, java.util.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

Modifier and Type	Method and Description
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.isSystemProvided(Plugin plugin) A plugin is determined to be "system" if DefaultPluginMetadataManager.isUserInstalled(com.atlassian.plugin.Plugin) is false.
boolean	PluginMetadataManager.isSystemProvided(Plugin plugin) This is used to determine if the plugin was provided by the host application.
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) Determines if the plugin was installed by a user.
boolean	ClasspathFilePluginMetadata.required(Plugin plugin)

Uses of Plugin in com.atlassian.plugin.module

Subinterfaces of Plugin in com.atlassian.plugin.module

Modifier and Type	Interface and Description
interface	ContainerManagedPlugin A plugin that is managed by a container

Uses of Plugin in com.atlassian.plugin.parsers

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

Modifier and Type	Method and Description
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).
Plugin	XmlDescriptorParser.configurePlugin(ModuleDescriptorFactory moduleDescriptorFactory, Plugin plugin)

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

Modifier and Type	Method and Description
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).
Plugin	XmlDescriptorParser.configurePlugin(ModuleDescriptorFactory moduleDescriptorFactory, Plugin plugin)
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

Modifier and Type	Method and Description
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.util

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

Modifier and Type	Method and Description
static boolean	PluginUtils.doesPluginRequireRestart(Plugin plugin) Determines if a plugin requires a restart after being installed at runtime.
static java.util.Set<java.lang.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.util.collect

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

Modifier and Type	Method and Description
static java.lang.Iterable<java.lang.String>	Transforms.toPluginKeys(java.lang.Iterable<Plugin> plugins)

Uses of Plugin in com.atlassian.plugin.util.resource

Constructors in com.atlassian.plugin.util.resource with parameters of type Plugin

Constructor and Description
AlternativePluginResourceLoader(Plugin plugin)