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, com.atlassian.plugin.event.PluginEventManager pluginEventManager) Default constructor
OsgiPluginFactory(String pluginDescriptorFileName, Set<Application> applications, OsgiPersistentCache persistentCache, OsgiContainerManager osgi, com.atlassian.plugin.event.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)
Plugin	create(PluginArtifact pluginArtifact, ModuleDescriptorFactory moduleDescriptorFactory) Deploys the plugin artifact.
ModuleDescriptor<?>	createModule(Plugin plugin, org.dom4j.Element module, ModuleDescriptorFactory moduleDescriptorFactory)
protected InputStream	getDescriptorInputStream(PluginArtifact pluginArtifact)
protected com.google.common.base.Predicate<Integer>	isValidPluginsVersion()

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

create, 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,
                         com.atlassian.plugin.event.PluginEventManager pluginEventManager)

Default constructor

OsgiPluginFactory

public OsgiPluginFactory(String pluginDescriptorFileName,
                         Set<Application> applications,
                         OsgiPersistentCache persistentCache,
                         OsgiContainerManager osgi,
                         com.atlassian.plugin.event.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

Specified by:

canCreate in interface PluginFactory

Overrides:

canCreate in class AbstractPluginFactory

Throws:

PluginParseException

getDescriptorInputStream

protected InputStream getDescriptorInputStream(PluginArtifact pluginArtifact)

Specified by:

getDescriptorInputStream in class AbstractPluginFactory

isValidPluginsVersion

protected com.google.common.base.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)