com.atlassian.plugin.impl

Class DefaultDynamicPlugin

java.lang.Object

com.atlassian.plugin.impl.AbstractPlugin

com.atlassian.plugin.impl.DefaultDynamicPlugin

All Implemented Interfaces:

Plugin, PluginArtifactBackedPlugin, Resourced, Comparable<Plugin>

public class DefaultDynamicPlugin
extends AbstractPlugin
implements PluginArtifactBackedPlugin

A dynamically loaded plugin is loaded through the plugin class loader.

Field Summary

Fields inherited from interface com.atlassian.plugin.Plugin

NAME_COMPARATOR, VERSION_1, VERSION_2, VERSION_3

Constructor Summary

Constructors

Constructor and Description
DefaultDynamicPlugin(DeploymentUnit deploymentUnit, PluginClassLoader loader)
DefaultDynamicPlugin(PluginArtifact pluginArtifact, PluginClassLoader loader)

Method Summary

Methods

Modifier and Type	Method and Description
ClassLoader	getClassLoader() Get the classloader for the plugin.
DeploymentUnit	getDeploymentUnit() Deprecated. Since 2.2.0, use getPluginArtifact() instead
PluginArtifact	getPluginArtifact()
URL	getResource(String name) Retrieve the URL of the resource from the plugin.
InputStream	getResourceAsStream(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() This plugin is dynamically loaded, so returns true.
boolean	isUninstallable() Whether or not this plugin can be 'uninstalled'.
<T> Class<T>	loadClass(String clazz, Class<?> callingClass) Get the plugin to load a specific class.
protected void	uninstallInternal() Perform any internal uninstallation logic.

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

addModuleDescriptor, close, compareAndSetPluginState, compareTo, containsSystemModule, disable, disableInternal, enable, enableInternal, getActivePermissions, getDateInstalled, getDateLoaded, getI18nNameKey, getInstallationMode, getKey, getLog, getModuleDescriptor, getModuleDescriptors, getModuleDescriptorsByModuleClass, getName, getPluginInformation, getPluginState, getPluginsVersion, getRequiredPlugins, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hasAllPermissions, install, installInternal, isEnabled, isEnabledByDefault, isSystemPlugin, removeModuleDescriptor, setEnabled, setEnabledByDefault, setI18nNameKey, setKey, setName, setPluginInformation, setPluginState, setPluginsVersion, setResources, setSystemPlugin, toString, uninstall

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, close, containsSystemModule, disable, enable, getActivePermissions, getDateInstalled, getDateLoaded, getI18nNameKey, getInstallationMode, getKey, getModuleDescriptor, getModuleDescriptors, getModuleDescriptorsByModuleClass, getName, getPluginInformation, getPluginState, getPluginsVersion, getRequiredPlugins, hasAllPermissions, install, isEnabled, isEnabledByDefault, isSystemPlugin, setEnabled, setEnabledByDefault, setI18nNameKey, setKey, setName, setPluginInformation, setPluginsVersion, setResources, setSystemPlugin, uninstall

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

DefaultDynamicPlugin

public DefaultDynamicPlugin(DeploymentUnit deploymentUnit,
                    PluginClassLoader loader)

DefaultDynamicPlugin

public DefaultDynamicPlugin(PluginArtifact pluginArtifact,
                    PluginClassLoader loader)

Method Detail

loadClass

public <T> Class<T> loadClass(String clazz,
                     Class<?> callingClass)
                   throws 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:

ClassNotFoundException - if the class cannot be located.

isUninstallable

public boolean isUninstallable()

Description copied from interface: Plugin

Whether or not this plugin can be 'uninstalled'.

Specified by:

isUninstallable in interface Plugin

Returns:

true if this plugin can be 'uninstalled'.

getResource

public URL getResource(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 InputStream getResourceAsStream(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.

getClassLoader

public 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

isDynamicallyLoaded

public boolean isDynamicallyLoaded()

This plugin is dynamically loaded, so returns true.

Specified by:

isDynamicallyLoaded in interface Plugin

Returns:

true

getDeploymentUnit

public DeploymentUnit getDeploymentUnit()

Deprecated. Since 2.2.0, use getPluginArtifact() instead

getPluginArtifact

public PluginArtifact getPluginArtifact()

Specified by:

getPluginArtifact in interface PluginArtifactBackedPlugin

Returns:

the original, unprocessed or transformed PluginArtifact used to create this plugin instance. Cannot be null.

Since:

2.2.0

isDeleteable

public boolean isDeleteable()

Description copied from interface: Plugin

Should the plugin file be deleted on unistall?

Specified by:

isDeleteable in interface Plugin

Returns:

true if this plugin file should be deleted on unistall.

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

Overrides:

isBundledPlugin in class AbstractPlugin

Returns:

true if this plugin is a "bundled" plugin.

uninstallInternal

protected void uninstallInternal()

Description copied from class: AbstractPlugin

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

Overrides:

uninstallInternal in class AbstractPlugin