Using XML Schemas
Version 0.9.0-SNAPSHOT
iPOJO provides XML schemas to check iPOJO descriptors (i.e. metdata.xml). Several schemas are provided in order to describe the core syntax, compositions and external handlers.
Schema |
URL |
---|---|
iPOJO Core |
|
iPOJO Composite |
|
Temporal Dependency Handler |
|
Whiteboard pattern handler |
http://felix.apache.org/ipojo/schemas/1.0.0/whiteboard-pattern.xsd |
Extender pattern handler |
http://felix.apache.org/ipojo/schemas/1.0.0/extender-pattern.xsd |
Event Admin handlers |
|
JMX handler |
Note: the schemas are also provided inside implicated bundles.
To use those schemas you have to declares those schemas in your metadata.xml file such as in the next snippet using the iPOJO core XML-schema:
<ipojo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="org.apache.felix.ipojo http://felix.apache.org/ipojo/schemas/1.0.0/core.xsd" xmlns="org.apache.felix.ipojo"> <component ....> </component> </ipojo>
First, declares the 'XMLSChema-instance' namespace. Then, declares used namespaces and schemas in the 'xsi:schemaLocation' attribute. This attribute contains pairs 'namespace url' separated by spaces. Finally, declares the default namespace to "org.apache.felix.ipojo".
You can also use several schemas in the same descriptor by using a header like:
<ipojo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="org.apache.felix.ipojo http://felix.apache.org/ipojo/schemas/1.0.0/core.xsd org.apache.felix.ipojo.extender http://felix.apache.org/ipojo/schemas/1.0.0/extender-pattern.xsd" xmlns="org.apache.felix.ipojo" xmlns:extender="org.apache.felix.ipojo.extender"> <component classname="org.apache.felix.ipojo.junit4osgi.impl.JunitExtender"> <extender:extender extension="Test-Suite" onArrival="onBundleArrival" onDeparture="onBundleDeparture" /> <callback transition="invalidate" method="stopping" /> <callback transition="validate" method="starting" /> <provides /> </component> <instance component="org.apache.felix.ipojo.junit4osgi.impl.JunitExtender" /> </ipojo>
The only difference is contained in the 'schemaLocation' attribute, which contains several pairs. You also need to declare the namespace of the used external handler.
If you declare schemas, the iPOJO manipulator automatically checks the validity of the descriptor against the declared schemas. Moreover, if you use 'advanced' XML Editor supporting schemas, editing iPOJO descriptors should be eased with auto-completion features.