com.atlassian.plugin.factories

Class LegacyDynamicPluginFactory

java.lang.Object

com.atlassian.plugin.factories.AbstractPluginFactory

com.atlassian.plugin.factories.LegacyDynamicPluginFactory

All Implemented Interfaces:

PluginFactory

public final class LegacyDynamicPluginFactory
extends AbstractPluginFactory

Deploys version 1.0 plugins into the legacy custom classloader structure that gives each plugin its own classloader.

Since:

2.0.0

Field Summary

Fields inherited from class com.atlassian.plugin.factories.AbstractPluginFactory

applications, descriptorParserFactory

Constructor Summary

Constructors

Constructor and Description
LegacyDynamicPluginFactory(String pluginDescriptorFileName)
LegacyDynamicPluginFactory(String pluginDescriptorFileName, File tempDirectory)
LegacyDynamicPluginFactory(String pluginDescriptorFileName, File tempDirectory, XmlDescriptorParserFactory xmlDescriptorParserFactory)

Method Summary

Modifier and Type	Method and Description
Plugin	create(PluginArtifact pluginArtifact, ModuleDescriptorFactory moduleDescriptorFactory) Deploys the plugin artifact
ModuleDescriptor<?>	createModule(Plugin plugin, org.dom4j.Element module, ModuleDescriptorFactory moduleDescriptorFactory) If this factory is capable of loading a plugin of the type passed, attempt to create a module descriptor.
protected Plugin	createPlugin(PluginArtifact pluginArtifact, PluginClassLoader loader) Creates the plugin.
protected InputStream	getDescriptorInputStream(PluginArtifact pluginArtifact)
protected Predicate<Integer>	isValidPluginsVersion()

Methods inherited from class com.atlassian.plugin.factories.AbstractPluginFactory

canCreate, getPluginKeyFromDescriptor, hasDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyDynamicPluginFactory

public LegacyDynamicPluginFactory(String pluginDescriptorFileName)

LegacyDynamicPluginFactory

public LegacyDynamicPluginFactory(String pluginDescriptorFileName,
                                  File tempDirectory)

LegacyDynamicPluginFactory

public LegacyDynamicPluginFactory(String pluginDescriptorFileName,
                                  File tempDirectory,
                                  XmlDescriptorParserFactory xmlDescriptorParserFactory)

Method Detail

getDescriptorInputStream

protected InputStream getDescriptorInputStream(PluginArtifact pluginArtifact)

Specified by:

getDescriptorInputStream in class AbstractPluginFactory

isValidPluginsVersion

protected Predicate<Integer> isValidPluginsVersion()

Specified by:

isValidPluginsVersion in class AbstractPluginFactory

create

public Plugin create(PluginArtifact pluginArtifact,
                     ModuleDescriptorFactory moduleDescriptorFactory)
              throws PluginParseException

Deploys the plugin artifact

Parameters:

pluginArtifact - the plugin artifact to deploy

moduleDescriptorFactory - The factory for plugin modules

Returns:

The instantiated and populated plugin

Throws:

PluginParseException - If the descriptor cannot be parsed

Since:

2.2.0

createModule

public ModuleDescriptor<?> createModule(Plugin plugin,
                                        org.dom4j.Element module,
                                        ModuleDescriptorFactory moduleDescriptorFactory)

Description copied from interface: PluginFactory

If this factory is capable of loading a plugin of the type passed, attempt to create a module descriptor. Add that module descriptor to the plugin.

If capable, always return a ModuleDescriptor, even if it indicates a failure case. Caller is responsible for handling exceptional ModuleDescriptor.

Implementors should use (plugin instanceof <plugin-class>) to determine their capability; subclasses of implementors should override this if special handling is required.

Parameters:

plugin - that the module will be a member of

module - to create

moduleDescriptorFactory - basic factory, may be overridden

Returns:

null plugin was not created by this PluginFactory

createPlugin

protected Plugin createPlugin(PluginArtifact pluginArtifact,
                              PluginClassLoader loader)

Creates the plugin. Override to use a different Plugin class

Parameters:

pluginArtifact - The plugin artifact

loader - The plugin loader

Returns:

The plugin instance

Since:

2.2.0