Class XmlHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.felix.scr.impl.xml.XmlHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class XmlHandler
extends DefaultHandler

XML Parser for the component XML

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	firstElement	Flag for detecting the first element.
protected boolean	isComponent	Flag for elements inside a component element
private final org.osgi.framework.Bundle	m_bundle
private List<ComponentMetadata>	m_components
private ComponentMetadata	m_currentComponent
private ServiceMetadata	m_currentService
private final boolean	m_globalDelayedKeepInstances
private final boolean	m_globalObsoleteFactoryComponentFactory
private final BundleLogger	m_logger
private PropertyMetadata	m_pendingFactoryProperty
private PropertyMetadata	m_pendingProperty
protected String	overrideNamespace	Override namespace.
private StringBuilder	propertyBuilder

Constructor Summary

Constructors

Constructor	Description
XmlHandler(org.osgi.framework.Bundle bundle, BundleLogger logger, boolean globalObsoleteFactoryComponentFactory, boolean globalDelayedKeepInstances)

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)
void	endElement(String uri, String localName, String qName)
List<ComponentMetadata>	getComponentMetadataList()	Called to retrieve the service descriptors
private Properties	readPropertiesEntry(String entryName)	Reads the name property file from the bundle owning this descriptor.
void	startElement(String uri, String localName, String qName, Attributes attributes)

Methods inherited from class DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class Object

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

Field Details

m_bundle

private final org.osgi.framework.Bundle m_bundle

m_logger

private final BundleLogger m_logger

m_globalObsoleteFactoryComponentFactory

private final boolean m_globalObsoleteFactoryComponentFactory

m_globalDelayedKeepInstances

private final boolean m_globalDelayedKeepInstances

m_currentComponent

private ComponentMetadata m_currentComponent

m_currentService

private ServiceMetadata m_currentService

m_components

private List<ComponentMetadata> m_components

m_pendingProperty

private PropertyMetadata m_pendingProperty

m_pendingFactoryProperty

private PropertyMetadata m_pendingFactoryProperty

propertyBuilder

private StringBuilder propertyBuilder

firstElement

protected boolean firstElement

Flag for detecting the first element.

overrideNamespace

protected String overrideNamespace

Override namespace.

isComponent

protected boolean isComponent

Flag for elements inside a component element

Constructor Details

XmlHandler

public XmlHandler(org.osgi.framework.Bundle bundle,
 BundleLogger logger,
 boolean globalObsoleteFactoryComponentFactory,
 boolean globalDelayedKeepInstances)

Method Details

getComponentMetadataList

public List<ComponentMetadata> getComponentMetadataList()

Called to retrieve the service descriptors

Returns:

A list of service descriptors

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String uri,
 String localName,
 String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

readPropertiesEntry

private Properties readPropertiesEntry(String entryName)
                                throws SAXException

Reads the name property file from the bundle owning this descriptor. All properties read from the properties file are added to the current component's property meta data list.

Parameters:

entryName - The name of the bundle entry containing the propertes to be added. This must not be null.

Throws:

SAXException - If the entry name is null or no entry with the given name exists in the bundle or an error occurrs reading the properties file.