org.apache.felix.scrplugin.xml

Class ComponentDescriptorIO

java.lang.Object

org.apache.felix.scrplugin.xml.ComponentDescriptorIO

public class ComponentDescriptorIO
extends java.lang.Object

ComponentDescriptorIO is a helper class to read and write component descriptor files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ComponentDescriptorIO.XmlHandler A content handler for parsing the component descriptions.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ATTR_CARDINALITY
private static java.lang.String	ATTR_DESCRIPTION
private static java.lang.String	ATTR_LABEL
private static java.lang.String	ATTR_NAME General attribute for the name (component, reference, property)
private static java.lang.String	COMPONENT The component element.
private static java.lang.String	COMPONENT_ATTR_ACTIVATE Component: The activate attribute.
private static java.lang.String	COMPONENT_ATTR_CONFIGURATION_PID Component: The configuration pid attribute.
private static java.lang.String	COMPONENT_ATTR_DEACTIVATE Component: The deactivate attribute.
private static java.lang.String	COMPONENT_ATTR_ENABLED The enabled attribute.
private static java.lang.String	COMPONENT_ATTR_FACTORY Component: The factory attribute.
private static java.lang.String	COMPONENT_ATTR_IMMEDIATE Component: The immediate attribute.
private static java.lang.String	COMPONENT_ATTR_MODIFIED Component: The modified attribute.
private static java.lang.String	COMPONENT_ATTR_POLICY Component: The policy attribute.
private static java.lang.String	COMPONENT_QNAME The qualified component element.
private static java.lang.String	COMPONENTS The root element.
private static java.lang.String	IMPLEMENTATION
private static java.lang.String	IMPLEMENTATION_ATTR_CLASS
private static java.lang.String	IMPLEMENTATION_QNAME
static java.lang.String	INNER_NAMESPACE_URI The inner namespace - used for all inner elements.
private static java.lang.String	INTERFACE
private static java.lang.String	INTERFACE_ATTR_NAME
private static java.lang.String	INTERFACE_QNAME
private static java.lang.String	PARENT_NAME
private static java.lang.String	PREFIX The prefix used for the namespace.
private static java.lang.String	PROPERTIES
private static java.lang.String	PROPERTY
private static java.lang.String	PROPERTY_ATTR_PRIVATE
private static java.lang.String	PROPERTY_ATTR_TYPE
private static java.lang.String	PROPERTY_ATTR_VALUE
private static java.lang.String	PROPERTY_QNAME
private static java.lang.String	REFERENCE
private static java.lang.String	REFERENCE_ATTR_BIND
private static java.lang.String	REFERENCE_ATTR_POLICY
private static java.lang.String	REFERENCE_ATTR_POLICY_OPTION
private static java.lang.String	REFERENCE_ATTR_STRATEGY
private static java.lang.String	REFERENCE_ATTR_TARGET
private static java.lang.String	REFERENCE_ATTR_UNBIND
private static java.lang.String	REFERENCE_ATTR_UPDATED
private static java.lang.String	REFERENCE_QNAME
private static java.lang.String	SERVICE
private static java.lang.String	SERVICE_ATTR_FACTORY
private static java.lang.String	SERVICE_QNAME

Constructor Summary

Constructors

Constructor and Description
ComponentDescriptorIO()

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.String>	generateDescriptorFiles(DescriptionContainer module, Options options, Log logger) Generate descriptor file(s)
private static void	generateImplementationXML(ComponentContainer component, org.xml.sax.ContentHandler contentHandler, int indent) Write the xml for an Implementation.
private static void	generatePropertyXML(PropertyDescription property, org.xml.sax.ContentHandler contentHandler, int indent) Write the xml for a property.
private static void	generateReferenceXML(ComponentDescription component, DescriptionContainer module, ReferenceDescription reference, org.xml.sax.ContentHandler contentHandler, int indent) Write the xml for a Reference.
private static void	generateServiceXML(ServiceDescription service, org.xml.sax.ContentHandler contentHandler, int indent) Write the xml for a service.
private static void	generateServiceXML(java.lang.String interfaceName, org.xml.sax.ContentHandler contentHandler, int indent) Write the xml for a interface
private static void	generateXML(DescriptionContainer module, java.util.List<ComponentContainer> components, java.io.File descriptorFile, Log logger) Generate the xml top level element and start streaming the components.
private static void	generateXML(java.lang.String namespace, DescriptionContainer module, ComponentContainer container, org.xml.sax.ContentHandler contentHandler, int indent) Write the xml for a Component
static java.util.List<ClassDescription>	read(java.io.InputStream file, java.lang.ClassLoader classLoader, IssueLog iLog, java.lang.String location)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_ATTR_TYPE

private static final java.lang.String PROPERTY_ATTR_TYPE

See Also:

Constant Field Values

ATTR_NAME

private static final java.lang.String ATTR_NAME

General attribute for the name (component, reference, property)

See Also:

Constant Field Values

ATTR_CARDINALITY

private static final java.lang.String ATTR_CARDINALITY

See Also:

Constant Field Values

ATTR_DESCRIPTION

private static final java.lang.String ATTR_DESCRIPTION

See Also:

Constant Field Values

ATTR_LABEL

private static final java.lang.String ATTR_LABEL

See Also:

Constant Field Values

INNER_NAMESPACE_URI

public static final java.lang.String INNER_NAMESPACE_URI

The inner namespace - used for all inner elements.

See Also:

Constant Field Values

PREFIX

private static final java.lang.String PREFIX

The prefix used for the namespace.

See Also:

Constant Field Values

COMPONENTS

private static final java.lang.String COMPONENTS

The root element.

See Also:

Constant Field Values

COMPONENT

private static final java.lang.String COMPONENT

The component element.

See Also:

Constant Field Values

COMPONENT_QNAME

private static final java.lang.String COMPONENT_QNAME

The qualified component element.

See Also:

Constant Field Values

COMPONENT_ATTR_ENABLED

private static final java.lang.String COMPONENT_ATTR_ENABLED

The enabled attribute.

See Also:

Constant Field Values

COMPONENT_ATTR_POLICY

private static final java.lang.String COMPONENT_ATTR_POLICY

Component: The policy attribute.

See Also:

Constant Field Values

COMPONENT_ATTR_FACTORY

private static final java.lang.String COMPONENT_ATTR_FACTORY

Component: The factory attribute.

See Also:

Constant Field Values

COMPONENT_ATTR_IMMEDIATE

private static final java.lang.String COMPONENT_ATTR_IMMEDIATE

Component: The immediate attribute.

See Also:

Constant Field Values

COMPONENT_ATTR_ACTIVATE

private static final java.lang.String COMPONENT_ATTR_ACTIVATE

Component: The activate attribute.

See Also:

Constant Field Values

COMPONENT_ATTR_DEACTIVATE

private static final java.lang.String COMPONENT_ATTR_DEACTIVATE

Component: The deactivate attribute.

See Also:

Constant Field Values

COMPONENT_ATTR_MODIFIED

private static final java.lang.String COMPONENT_ATTR_MODIFIED

Component: The modified attribute.

See Also:

Constant Field Values

COMPONENT_ATTR_CONFIGURATION_PID

private static final java.lang.String COMPONENT_ATTR_CONFIGURATION_PID

Component: The configuration pid attribute.

See Also:

Constant Field Values

IMPLEMENTATION

private static final java.lang.String IMPLEMENTATION

See Also:

Constant Field Values

IMPLEMENTATION_QNAME

private static final java.lang.String IMPLEMENTATION_QNAME

See Also:

Constant Field Values

IMPLEMENTATION_ATTR_CLASS

private static final java.lang.String IMPLEMENTATION_ATTR_CLASS

See Also:

Constant Field Values

SERVICE

private static final java.lang.String SERVICE

See Also:

Constant Field Values

SERVICE_QNAME

private static final java.lang.String SERVICE_QNAME

See Also:

Constant Field Values

SERVICE_ATTR_FACTORY

private static final java.lang.String SERVICE_ATTR_FACTORY

See Also:

Constant Field Values

PROPERTY

private static final java.lang.String PROPERTY

See Also:

Constant Field Values

PROPERTY_QNAME

private static final java.lang.String PROPERTY_QNAME

See Also:

Constant Field Values

PROPERTY_ATTR_VALUE

private static final java.lang.String PROPERTY_ATTR_VALUE

See Also:

Constant Field Values

PROPERTY_ATTR_PRIVATE

private static final java.lang.String PROPERTY_ATTR_PRIVATE

See Also:

Constant Field Values

REFERENCE

private static final java.lang.String REFERENCE

See Also:

Constant Field Values

REFERENCE_QNAME

private static final java.lang.String REFERENCE_QNAME

See Also:

Constant Field Values

REFERENCE_ATTR_POLICY

private static final java.lang.String REFERENCE_ATTR_POLICY

See Also:

Constant Field Values

REFERENCE_ATTR_POLICY_OPTION

private static final java.lang.String REFERENCE_ATTR_POLICY_OPTION

See Also:

Constant Field Values

REFERENCE_ATTR_UPDATED

private static final java.lang.String REFERENCE_ATTR_UPDATED

See Also:

Constant Field Values

REFERENCE_ATTR_UNBIND

private static final java.lang.String REFERENCE_ATTR_UNBIND

See Also:

Constant Field Values

REFERENCE_ATTR_BIND

private static final java.lang.String REFERENCE_ATTR_BIND

See Also:

Constant Field Values

REFERENCE_ATTR_TARGET

private static final java.lang.String REFERENCE_ATTR_TARGET

See Also:

Constant Field Values

REFERENCE_ATTR_STRATEGY

private static final java.lang.String REFERENCE_ATTR_STRATEGY

See Also:

Constant Field Values

INTERFACE

private static final java.lang.String INTERFACE

See Also:

Constant Field Values

INTERFACE_QNAME

private static final java.lang.String INTERFACE_QNAME

See Also:

Constant Field Values

INTERFACE_ATTR_NAME

private static final java.lang.String INTERFACE_ATTR_NAME

See Also:

Constant Field Values

PROPERTIES

private static final java.lang.String PROPERTIES

See Also:

Constant Field Values

PARENT_NAME

private static final java.lang.String PARENT_NAME

See Also:

Constant Field Values

Constructor Detail

ComponentDescriptorIO

public ComponentDescriptorIO()

Method Detail

read

public static java.util.List<ClassDescription> read(java.io.InputStream file,
                                                    java.lang.ClassLoader classLoader,
                                                    IssueLog iLog,
                                                    java.lang.String location)
                                             throws SCRDescriptorException

Throws:

SCRDescriptorException

generateXML

private static void generateXML(DescriptionContainer module,
                                java.util.List<ComponentContainer> components,
                                java.io.File descriptorFile,
                                Log logger)
                         throws org.xml.sax.SAXException,
                                java.io.IOException,
                                javax.xml.transform.TransformerException

Generate the xml top level element and start streaming the components.

Parameters:

components -

contentHandler -

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.transform.TransformerException

generateXML

private static void generateXML(java.lang.String namespace,
                                DescriptionContainer module,
                                ComponentContainer container,
                                org.xml.sax.ContentHandler contentHandler,
                                int indent)
                         throws org.xml.sax.SAXException

Write the xml for a Component

Parameters:

component -

contentHandler -

Throws:

org.xml.sax.SAXException

generateImplementationXML

private static void generateImplementationXML(ComponentContainer component,
                                              org.xml.sax.ContentHandler contentHandler,
                                              int indent)
                                       throws org.xml.sax.SAXException

Write the xml for an Implementation.

Parameters:

implementation -

contentHandler -

Throws:

org.xml.sax.SAXException

generateServiceXML

private static void generateServiceXML(ServiceDescription service,
                                       org.xml.sax.ContentHandler contentHandler,
                                       int indent)
                                throws org.xml.sax.SAXException

Write the xml for a service.

Parameters:

service -

contentHandler -

Throws:

org.xml.sax.SAXException

generateServiceXML

private static void generateServiceXML(java.lang.String interfaceName,
                                       org.xml.sax.ContentHandler contentHandler,
                                       int indent)
                                throws org.xml.sax.SAXException

Write the xml for a interface

Parameters:

interf -

contentHandler -

Throws:

org.xml.sax.SAXException

generatePropertyXML

private static void generatePropertyXML(PropertyDescription property,
                                        org.xml.sax.ContentHandler contentHandler,
                                        int indent)
                                 throws org.xml.sax.SAXException

Write the xml for a property.

Parameters:

property -

contentHandler -

Throws:

org.xml.sax.SAXException

generateReferenceXML

private static void generateReferenceXML(ComponentDescription component,
                                         DescriptionContainer module,
                                         ReferenceDescription reference,
                                         org.xml.sax.ContentHandler contentHandler,
                                         int indent)
                                  throws org.xml.sax.SAXException

Write the xml for a Reference.

Parameters:

reference -

contentHandler -

Throws:

org.xml.sax.SAXException

generateDescriptorFiles

public static java.util.List<java.lang.String> generateDescriptorFiles(DescriptionContainer module,
                                                                       Options options,
                                                                       Log logger)
                                                                throws SCRDescriptorException,
                                                                       SCRDescriptorFailureException

Generate descriptor file(s)

Throws:

SCRDescriptorException

SCRDescriptorFailureException