com.atlassian.plugin.osgi.factory

Class OsgiPluginFactory

java.lang.Object

com.atlassian.plugin.factories.AbstractPluginFactory

com.atlassian.plugin.osgi.factory.OsgiPluginFactory

All Implemented Interfaces:

PluginFactory

public final class OsgiPluginFactory
extends AbstractPluginFactory

Plugin loader that starts an OSGi container and loads plugins into it, wrapped as OSGi bundles. Supports

• Dynamic loading of module descriptors via OSGi services
• Delayed enabling until the plugin container is active
• XML or Jar manifest configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OsgiPluginFactory.DefaultPluginTransformerFactory
static interface	OsgiPluginFactory.PluginTransformerFactory

Field Summary

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

descriptorParserFactory

Constructor Summary

Constructors

Constructor and Description
OsgiPluginFactory(String pluginDescriptorFileName, Set<Application> applications, OsgiPersistentCache persistentCache, OsgiContainerManager osgi, PluginEventManager pluginEventManager) Default constructor
OsgiPluginFactory(String pluginDescriptorFileName, Set<Application> applications, OsgiPersistentCache persistentCache, OsgiContainerManager osgi, PluginEventManager pluginEventManager, OsgiPluginFactory.PluginTransformerFactory pluginTransformerFactory) Constructor for implementations that want to override the DefaultPluginTransformer with a custom implementation

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

OsgiPluginFactory

public OsgiPluginFactory(String pluginDescriptorFileName,
                         Set<Application> applications,
                         OsgiPersistentCache persistentCache,
                         OsgiContainerManager osgi,
                         PluginEventManager pluginEventManager)

Default constructor

OsgiPluginFactory

public OsgiPluginFactory(String pluginDescriptorFileName,
                         Set<Application> applications,
                         OsgiPersistentCache persistentCache,
                         OsgiContainerManager osgi,
                         PluginEventManager pluginEventManager,
                         OsgiPluginFactory.PluginTransformerFactory pluginTransformerFactory)

Constructor for implementations that want to override the DefaultPluginTransformer with a custom implementation

Method Detail

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

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. The artifact will only undergo transformation if a plugin descriptor can be found and the "Atlassian-Plugin-Key" value is not already defined in the manifest.

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

IllegalArgumentException - If the plugin descriptor isn't found, and the plugin key and bundle version aren't specified in the manifest

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