public class

UnloadablePlugin

extends StaticPlugin

java.lang.Object
↳	com.atlassian.plugin.impl.AbstractPlugin
	↳	com.atlassian.plugin.impl.StaticPlugin
		↳	com.atlassian.plugin.impl.UnloadablePlugin

Class Overview

This class represents a Plugin that was not able to be loaded by the PluginManager.

Summary

[Expand]

Inherited Fields

From interface com.atlassian.plugin.Plugin

Public Constructors
	UnloadablePlugin()
	UnloadablePlugin(String text)

Public Methods
void	close() Free any resources held by this plugin.
String	getErrorText()
boolean	isDeleteable()
boolean	isDynamicallyLoaded()
boolean	isEnabledByDefault()
boolean	isUninstallable() Static plugins loaded from the classpath can't be uninstalled.
void	setDeletable(boolean deletable)
void	setDynamicallyLoaded(boolean dynamic)
void	setErrorText(String errorText)
void	setUninstallable(boolean uninstallable)
String	toString()

Protected Methods
void	uninstallInternal() Perform any internal uninstallation logic.

[Expand]

Inherited Methods

From class com.atlassian.plugin.impl.StaticPlugin

From class com.atlassian.plugin.impl.AbstractPlugin

From class java.lang.Object

From interface com.atlassian.plugin.Plugin

abstract void	addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)
abstract void	close() This method is deprecated. Since 2.2.0, use `uninstall()` instead
abstract boolean	containsSystemModule()
abstract void	disable() Disables the plugin.
abstract void	enable() Enables the plugin.
abstract ClassLoader	getClassLoader() Get the classloader for the plugin.
abstract Date	getDateLoaded() The date this plugin was loaded into the system.
abstract String	getI18nNameKey() Returns the i18nKey used to get an internationalised name for this plugin.
abstract String	getKey()
abstract ModuleDescriptor<?>	getModuleDescriptor(String key) Get the `ModuleDescriptor` for a particular key.
abstract Collection<ModuleDescriptor<?>>	getModuleDescriptors() Get the Collection of `descriptors`.
abstract <M> List<ModuleDescriptor<M>>	getModuleDescriptorsByModuleClass(Class<M> moduleClass) Get the `descriptors` whose module class implements or is assignable from the supplied Class.
abstract String	getName() Returns the non-localised name of this plugin if defined.
abstract PluginInformation	getPluginInformation()
abstract PluginState	getPluginState() Returns this plugin's current state.
abstract int	getPluginsVersion() Gets the version of the plugins system to handle this plugin
abstract Set<String>	getRequiredPlugins()
abstract URL	getResource(String path) Retrieve the URL of the resource from the plugin.
abstract InputStream	getResourceAsStream(String name) Load a given resource from the plugin.
abstract void	install() Installs the plugin into any internal, managing container.
abstract boolean	isBundledPlugin() Whether the plugin is a "bundled" plugin that can't be removed.
abstract boolean	isDeleteable() Should the plugin file be deleted on unistall?
abstract boolean	isDynamicallyLoaded() Whether or not this plugin is loaded dynamically at runtime.
abstract boolean	isEnabled() This method is deprecated. since 2.2.0, use `getPluginState()` instead
abstract boolean	isEnabledByDefault()
abstract boolean	isSystemPlugin() This method is deprecated. since 2.6.0 use `isUserInstalled(Plugin)` instead, please keep in mind that the logic is reversed.
abstract boolean	isUninstallable() Whether or not this plugin can be 'uninstalled'.
abstract <T> Class<T>	loadClass(String clazz, Class<?> callingClass) Get the plugin to load a specific class.
abstract void	setEnabled(boolean enabled) This method is deprecated. Since 2.2.0, use `enable()` or `disable()` instead
abstract void	setEnabledByDefault(boolean enabledByDefault)
abstract void	setI18nNameKey(String i18nNameKey) Sets the i18nKey used to get an internationalised name for this plugin.
abstract void	setKey(String aPackage)
abstract void	setName(String name) Sets the non-localised name of this plugin.
abstract void	setPluginInformation(PluginInformation pluginInformation)
abstract void	setPluginsVersion(int version) Sets the version of the plugins system
abstract void	setResources(Resourced resources)
abstract void	setSystemPlugin(boolean system) This method is deprecated. since 2.6.0 provide `PluginMetadataManager` with information about the plugin instead. There is no way to programatically set this value now.
abstract void	uninstall() Uninstalls the plugin from any internal container.

From interface com.atlassian.plugin.Resourced

From interface java.lang.Comparable

Public Constructors

public UnloadablePlugin ()

public UnloadablePlugin (String text)

Parameters

text	The error text

Public Methods

public void close ()

Free any resources held by this plugin. To be called during uninstallation of the Plugin.

public String getErrorText ()

public boolean isDeleteable ()

public boolean isDynamicallyLoaded ()

public boolean isEnabledByDefault ()

public boolean isUninstallable ()

Static plugins loaded from the classpath can't be uninstalled.

public void setDeletable (boolean deletable)

public void setDynamicallyLoaded (boolean dynamic)

public void setErrorText (String errorText)

public void setUninstallable (boolean uninstallable)

public String toString ()

Protected Methods

protected void uninstallInternal ()

Perform any internal uninstallation logic. Subclasses should only throw PluginException.

Interfaces

Classes