com.atlassian.plugin.factories
Class XmlDynamicPluginFactory

java.lang.Object
  com.atlassian.plugin.factories.XmlDynamicPluginFactory

All Implemented Interfaces:

PluginFactory

public class XmlDynamicPluginFactory
extends java.lang.Object
implements PluginFactory

Deploys plugins that consist of an XML descriptor file.

Since:

2.1.0

Constructor Summary

XmlDynamicPluginFactory()
Deprecated. Since 2.2.0, use XmlDynamicPluginFactory(String) instead

XmlDynamicPluginFactory(java.util.Set<java.lang.String> applicationKeys)

XmlDynamicPluginFactory(java.lang.String applicationKey)

Method Summary

java.lang.String	canCreate(PluginArtifact pluginArtifact) Determines if this deployer can handle this artifact by looking for the plugin descriptor
Plugin	create(DeploymentUnit deploymentUnit, ModuleDescriptorFactory moduleDescriptorFactory) Deprecated. Since 2.2.0, use create(PluginArtifact,ModuleDescriptorFactory) instead
Plugin	create(PluginArtifact pluginArtifact, ModuleDescriptorFactory moduleDescriptorFactory) Deploys the plugin artifact

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDynamicPluginFactory

@Deprecated
public XmlDynamicPluginFactory()

Deprecated. Since 2.2.0, use XmlDynamicPluginFactory(String) instead

XmlDynamicPluginFactory

public XmlDynamicPluginFactory(java.lang.String applicationKey)

Parameters:

applicationKey - The application key to use to choose modules

Since:

2.2.0

XmlDynamicPluginFactory

public XmlDynamicPluginFactory(java.util.Set<java.lang.String> applicationKeys)

Parameters:

applicationKeys - The application key to use to choose modules

Since:

2.2.0

Method Detail

create

@Deprecated
public Plugin create(DeploymentUnit deploymentUnit,
                                ModuleDescriptorFactory moduleDescriptorFactory)
              throws PluginParseException

Deprecated. Since 2.2.0, use create(PluginArtifact,ModuleDescriptorFactory) instead

Description copied from interface: PluginFactory

Deploys the deployment unit by instantiating the plugin and configuring it. Should only be called if the respective PluginFactory.canCreate(PluginArtifact) call returned the plugin key

Specified by:

create in interface PluginFactory

Parameters:

deploymentUnit - the unit to deploy

moduleDescriptorFactory - the factory for the module descriptors

Returns:

the plugin loaded from the deployment unit, or an UnloadablePlugin instance if loading fails.

Throws:

PluginParseException - if the plugin could not be parsed

create

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

Deploys the plugin artifact

Specified by:

create in interface PluginFactory

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

canCreate

public java.lang.String canCreate(PluginArtifact pluginArtifact)
                           throws PluginParseException

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

Specified by:

canCreate in interface PluginFactory

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