com.atlassian.plugin.factories

Class XmlDynamicPluginFactory

java.lang.Object

com.atlassian.plugin.factories.AbstractPluginFactory

com.atlassian.plugin.factories.XmlDynamicPluginFactory

All Implemented Interfaces:

PluginFactory

public final class XmlDynamicPluginFactory
extends AbstractPluginFactory

Deploys plugins that consist of an XML descriptor file.

Since:

2.1.0

Field Summary

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

applications, descriptorParserFactory

Constructor Summary

Constructors

Constructor and Description
XmlDynamicPluginFactory(Application application)
XmlDynamicPluginFactory(Set<Application> applications)

Method Summary

Modifier and Type	Method and Description
String	canCreate(PluginArtifact pluginArtifact) Determines if this deployer can handle this artifact by looking for the plugin descriptor
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 InputStream	getDescriptorInputStream(PluginArtifact pluginArtifact)
protected Predicate<Integer>	isValidPluginsVersion()

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

getPluginKeyFromDescriptor, hasDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDynamicPluginFactory

public XmlDynamicPluginFactory(Application application)

Parameters:

application - The application key to use to choose modules

Since:

3.0

XmlDynamicPluginFactory

public XmlDynamicPluginFactory(Set<Application> applications)

Parameters:

applications - The application key to use to choose modules

Since:

3.0

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

canCreate

public String canCreate(PluginArtifact pluginArtifact)
                 throws PluginParseException

Description copied from class: AbstractPluginFactory

Determines if this deployer can handle this artifact by looking for the plugin descriptor

Specified by:

canCreate in interface PluginFactory

Overrides:

canCreate in class AbstractPluginFactory

Parameters:

pluginArtifact - The artifact to test

Returns:

The plugin key, null if it cannot load the plugin

Throws:

PluginParseException - If there are exceptions parsing the plugin configuration when the deployer should have been able to deploy the plugin

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