com.atlassian.plugin.osgi.factory

Class OsgiPluginXmlDescriptorParser

java.lang.Object

com.atlassian.plugin.parsers.XmlDescriptorParser

com.atlassian.plugin.osgi.factory.OsgiPluginXmlDescriptorParser

All Implemented Interfaces:

DescriptorParser

public class OsgiPluginXmlDescriptorParser
extends XmlDescriptorParser

Descriptor parser that handles special tasks for osgi plugins such as recording the originating module descriptor elements. Must only be used with OsgiPlugin instances.

Since:

2.1.2

Constructor Summary

Constructors

Constructor and Description
OsgiPluginXmlDescriptorParser(InputStream source, Iterable<InputStream> supplementalSources, Set<Application> applications) Creates a DescriptorParser that can read multiple XML files
OsgiPluginXmlDescriptorParser(InputStream source, Set<Application> applications)

Method Summary

Modifier and Type	Method and Description
ModuleDescriptor<?>	addModule(ModuleDescriptorFactory moduleDescriptorFactory, Plugin plugin, org.dom4j.Element module) Passes module descriptor elements back to the OsgiPlugin
protected ModuleDescriptor<?>	createModuleDescriptor(Plugin plugin, org.dom4j.Element element, ModuleDescriptorFactory moduleDescriptorFactory) Passes module descriptor elements back to the OsgiPlugin

Methods inherited from class com.atlassian.plugin.parsers.XmlDescriptorParser

configurePlugin, createDocument, createPluginInformation, getDocument, getKey, getPluginInformation, getPluginsVersion, isSystemPlugin, mergeDocuments

Methods inherited from class java.lang.Object

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

Constructor Detail

OsgiPluginXmlDescriptorParser

public OsgiPluginXmlDescriptorParser(InputStream source,
                                     Set<Application> applications)
                              throws PluginParseException

Parameters:

source - The XML descriptor source

applications - The application keys to limit modules to, null for only unspecified

Throws:

PluginParseException - if there is a problem reading the descriptor from the XML InputStream.

OsgiPluginXmlDescriptorParser

public OsgiPluginXmlDescriptorParser(InputStream source,
                                     Iterable<InputStream> supplementalSources,
                                     Set<Application> applications)
                              throws PluginParseException

Creates a DescriptorParser that can read multiple XML files

Parameters:

source - The descriptor stream

supplementalSources - streams that contain additional module descriptors

applications - the application key to filter modules with, null for all unspecified

Throws:

PluginParseException - if there is a problem reading the descriptor from the XML InputStream.

Since:

3.2.16

Method Detail

createModuleDescriptor

protected ModuleDescriptor<?> createModuleDescriptor(Plugin plugin,
                                                     org.dom4j.Element element,
                                                     ModuleDescriptorFactory moduleDescriptorFactory)
                                              throws PluginParseException

Passes module descriptor elements back to the OsgiPlugin

Overrides:

createModuleDescriptor in class XmlDescriptorParser

Parameters:

plugin - The plugin

element - The module element

moduleDescriptorFactory - The module descriptor factory

Returns:

The module, or null if the module cannot be found

Throws:

PluginParseException

addModule

public ModuleDescriptor<?> addModule(ModuleDescriptorFactory moduleDescriptorFactory,
                                     Plugin plugin,
                                     org.dom4j.Element module)

Passes module descriptor elements back to the OsgiPlugin

Specified by:

addModule in interface DescriptorParser

Overrides:

addModule in class XmlDescriptorParser

Parameters:

moduleDescriptorFactory - basic factory, may be overridden

plugin - that the module will be initialised with

module - to create