com.atlassian.plugin.osgi.factory

Class UnloadableStaticPluginFactory

java.lang.Object

com.atlassian.plugin.factories.AbstractPluginFactory

com.atlassian.plugin.osgi.factory.UnloadableStaticPluginFactory

All Implemented Interfaces:

PluginFactory

public final class UnloadableStaticPluginFactory
extends AbstractPluginFactory

Creates unloadable plugins from static plugins. Used to handle when a static plugin (version 1) is deployed to a directory that only accepts OSGi plugins. This should be placed last in the chain of plugin factories and only if LegacyDynamicPluginFactory is not used.

Since:

2.2.3

Field Summary

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

applications, descriptorParserFactory

Constructor Summary

Constructors

Constructor and Description
UnloadableStaticPluginFactory(String pluginDescriptorFileName)

Method Summary

Modifier and Type	Method and Description
Plugin	create(PluginArtifact pluginArtifact, ModuleDescriptorFactory moduleDescriptorFactory) Creates an unloadable plugin
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 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

UnloadableStaticPluginFactory

public UnloadableStaticPluginFactory(String pluginDescriptorFileName)

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

Creates an unloadable plugin

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

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