com.atlassian.plugin.impl
Class XmlDynamicPlugin

java.lang.Object
  com.atlassian.plugin.impl.AbstractPlugin
      com.atlassian.plugin.impl.XmlDynamicPlugin

All Implemented Interfaces:

DynamicPlugin, Plugin, Resourced, java.lang.Comparable<Plugin>

public class XmlDynamicPlugin
extends AbstractPlugin
implements DynamicPlugin

A dynamic XML plugin that consists of the Atlassian plugin descriptor

Since:

2.1.0

Field Summary

Fields inherited from interface com.atlassian.plugin.Plugin

NAME_COMPARATOR

Constructor Summary

XmlDynamicPlugin()

Method Summary

void	close() Free any resources held by this plugin.
java.lang.ClassLoader	getClassLoader() Get the classloader for the plugin.
java.net.URL	getResource(java.lang.String name) Retrieve the URL of the resource from the plugin.
java.io.InputStream	getResourceAsStream(java.lang.String name) Load a given resource from the plugin.
boolean	isBundledPlugin() Whether the plugin is a "bundled" plugin that can't be removed.
boolean	isDeleteable() Should the plugin file be deleted on unistall?
boolean	isDynamicallyLoaded() Whether or not this plugin is loaded dynamically at runtime
boolean	isUninstallable() Whether or not this plugin can be 'uninstalled'.
java.lang.Class<?>	loadClass(java.lang.String clazz, java.lang.Class callingClass) Get the plugin to load a specific class.
void	setBundled(boolean bundled)
void	setDeletable(boolean deletable)

Methods inherited from class com.atlassian.plugin.impl.AbstractPlugin

addModuleDescriptor, compareTo, containsSystemModule, getDateLoaded, getI18nNameKey, getKey, getModuleDescriptor, getModuleDescriptors, getModuleDescriptorsByModuleClass, getName, getPluginInformation, getPluginsVersion, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabled, isEnabledByDefault, isSystemPlugin, removeModuleDescriptor, setEnabled, setEnabledByDefault, setI18nNameKey, setKey, setName, setPluginInformation, setPluginsVersion, setResources, setSystemPlugin, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.Plugin

addModuleDescriptor, containsSystemModule, getDateLoaded, getI18nNameKey, getKey, getModuleDescriptor, getModuleDescriptors, getModuleDescriptorsByModuleClass, getName, getPluginInformation, getPluginsVersion, isEnabled, isEnabledByDefault, isSystemPlugin, setEnabled, setEnabledByDefault, setI18nNameKey, setKey, setName, setPluginInformation, setPluginsVersion, setResources, setSystemPlugin

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

XmlDynamicPlugin

public XmlDynamicPlugin()

Method Detail

isBundledPlugin

public boolean isBundledPlugin()

Description copied from interface: Plugin

Whether the plugin is a "bundled" plugin that can't be removed.

Specified by:

isBundledPlugin in interface Plugin

isUninstallable

public boolean isUninstallable()

Description copied from interface: Plugin

Whether or not this plugin can be 'uninstalled'.

Specified by:

isUninstallable in interface Plugin

isDeleteable

public boolean isDeleteable()

Description copied from interface: Plugin

Should the plugin file be deleted on unistall?

Specified by:

isDeleteable in interface Plugin

isDynamicallyLoaded

public boolean isDynamicallyLoaded()

Description copied from interface: Plugin

Whether or not this plugin is loaded dynamically at runtime

Specified by:

isDynamicallyLoaded in interface Plugin

close

public void close()

Description copied from interface: Plugin

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

Specified by:

close in interface Plugin

setDeletable

public void setDeletable(boolean deletable)

Specified by:

setDeletable in interface DynamicPlugin

setBundled

public void setBundled(boolean bundled)

Specified by:

setBundled in interface DynamicPlugin

loadClass

public java.lang.Class<?> loadClass(java.lang.String clazz,
                                    java.lang.Class callingClass)
                             throws java.lang.ClassNotFoundException

Description copied from interface: Plugin

Get the plugin to load a specific class.

Specified by:

loadClass in interface Plugin

Parameters:

clazz - The name of the class to be loaded

callingClass - The class calling the loading (used to help find a classloader)

Returns:

The loaded class.

Throws:

java.lang.ClassNotFoundException

getClassLoader

public java.lang.ClassLoader getClassLoader()

Description copied from interface: Plugin

Get the classloader for the plugin.

Specified by:

getClassLoader in interface Plugin

Returns:

The classloader used to load classes for this plugin

getResource

public java.net.URL getResource(java.lang.String name)

Description copied from interface: Plugin

Retrieve the URL of the resource from the plugin.

Specified by:

getResource in interface Plugin

Parameters:

name - the name of the resource to be loaded

Returns:

The URL to the resource, or null if the resource is not found

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String name)

Description copied from interface: Plugin

Load a given resource from the plugin. Plugins that are loaded dynamically will need to implement this in a way that loads the resource from the same context as the plugin. Static plugins can just pull them from their own classloader.

Specified by:

getResourceAsStream in interface Plugin

Parameters:

name - The name of the resource to be loaded.

Returns:

An InputStream for the resource, or null if the resource is not found.