XmlDynamicPlugin

Class Overview

A dynamic XML plugin that consists of the Atlassian plugin descriptor

Summary

[Expand] Inherited Fields

From interface com.atlassian.plugin.Plugin public static final Comparator<Plugin> NAME_COMPARATOR This field is 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.

[Expand] Inherited Methods
From class com.atlassian.plugin.impl.AbstractPlugin void addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor) void close() Free any resources held by this plugin. boolean compareAndSetPluginState(PluginState requiredExistingState, PluginState desiredState) Only sets the plugin state if it is in the expected state. int compareTo(Plugin otherPlugin) Compares this Plugin to another Plugin for order. boolean containsSystemModule() final void disable() Disables the plugin. void disableInternal() Perform any internal disabling logic. final void enable() Enables the plugin. PluginState enableInternal() Perform any internal enabling logic. Date getDateLoaded() The date this plugin was loaded into the system. String getI18nNameKey() Returns the i18nKey used to get an internationalised name for this plugin. String getKey() Logger getLog() ModuleDescriptor<?> getModuleDescriptor(String key) Get the ModuleDescriptor for a particular key. Collection<ModuleDescriptor<?>> getModuleDescriptors() Returns the module descriptors for this plugin <T> List<ModuleDescriptor<T>> getModuleDescriptorsByModuleClass(Class<T> aClass) String getName() Returns the non-localised name of this plugin if defined. PluginInformation getPluginInformation() PluginState getPluginState() Returns this plugin's current state. int getPluginsVersion() Gets the version of the plugins system to handle this plugin Set<String> getRequiredPlugins() ResourceDescriptor getResourceDescriptor(String type, String name) This method is deprecated. No replacement. List<ResourceDescriptor> getResourceDescriptors() Get a List of all the descriptors . List<ResourceDescriptor> getResourceDescriptors(String type) Get a list of all descriptors of a particular type. ResourceLocation getResourceLocation(String type, String name) Get a ResourceLocation of a particular type and name. final void install() Installs the plugin into any internal, managing container. void installInternal() Perform any internal installation logic. boolean isBundledPlugin() Whether the plugin is a "bundled" plugin that can't be removed. boolean isEnabled() boolean isEnabledByDefault() boolean isSystemPlugin() Whether the plugin is a "system" plugin that shouldn't be made visible to the user. void removeModuleDescriptor(String key) void setEnabled(boolean enabled) Setter for the enabled state of a plugin. void setEnabledByDefault(boolean enabledByDefault) void setI18nNameKey(String i18nNameKey) Sets the i18nKey used to get an internationalised name for this plugin. void setKey(String aPackage) void setName(String name) Sets the non-localised name of this plugin. void setPluginInformation(PluginInformation pluginInformation) void setPluginState(PluginState state) void setPluginsVersion(int pluginsVersion) Sets the version of the plugins system void setResources(Resourced resources) void setSystemPlugin(boolean system) String toString() final void uninstall() Uninstalls the plugin from any internal container. void uninstallInternal() Perform any internal uninstallation logic.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
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 abstract ResourceDescriptor getResourceDescriptor(String type, String name) Get a ResourceDescriptor of a particular type and name. abstract List<ResourceDescriptor> getResourceDescriptors(String type) This method is deprecated. since 2.5.0 use getResourceDescriptors() and filter as required abstract List<ResourceDescriptor> getResourceDescriptors() Get a List of all the descriptors . abstract ResourceLocation getResourceLocation(String type, String name) Get a ResourceLocation of a particular type and name.
From interface java.lang.Comparable abstract int compareTo(T arg0)