Jump to: navigation, search

Hello XML World Example (Buckminster)

Revision as of 06:02, 20 November 2007 by Thomas.tada.se (Talk | contribs)

< To: Buckminster Project

Overview of the Example

This examples shows several Buckminster features in action. What these components actualy do when they are executed is not that interesting - there is an XML file with "worlds", there is a world producer and a class that says "hello" to worlds.

If you want to see the difference between setting up this example project manually, and how it works when running Buckminster, see the usage scenario Sharing a Project.

Here is an overview of what is going on:

HelloDemo.gif

  • The A component is called org.demo.hello.xml.world
    • It lives in a CVS repository
    • It is an Eclipse plugin - it has some meta data
    • A has a dependency on B
  • The B component is called org.demo.xml.provider
    • It lives in a CVS repository
    • It is an Eclipse plugin - it has some meta data
    • It requires two jars; the jar in component D, and a jar that is built by component C.
  • Component C is called org.demo.worlds
    • It lives in a CVS repository
    • Although it is an Eclipse project, it is not an Eclipse plugin.
  • Component D is a sax parser called se.tada.util.sax
    • It lives in binary form in the maven repository at Ibiblio

To run the example:

That will start the Buckminster materialization of the project.

The CQUERY

The CQuery looks like this:

<?xml version="1.0" encoding="UTF-8"?>
<cq:componentQuery
  xmlns:cq="http://www.eclipse.org/buckminster/CQuery-1.0"
  resourceMap="http://www.eclipse.org/buckminster/samples/rmaps/demo.rmap">
    <cq:rootRequest
      name="org.demo.hello.xml.world"
      componentType="osgi.bundle" versionType="OSGi"/>
</cq:componentQuery>

This is what the XML in the CQUERY means:

  • The first two lines are the usual XML incantations, the first two indicating that this is XML, and this is the syntax of the XML - i.e. CQuery-1.0 and the namespace is called "cq".
  • The third line declares where the resource map to use when resolving components is found (we will look at the resource map next).
  • Next line states that the wanted (root) component is called org.demo.hello.xml.world, that it is a plugin and that it follows the OSGi versioning scheme.

For more details see CQUERY

The RMAP

This is what the RMAP looks like:

<?xml version="1.0" encoding="UTF-8"?>
<rmap
  xmlns="http://www.eclipse.org/buckminster/RMap-1.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:mp="http://www.eclipse.org/buckminster/MavenProvider-1.0"
  xmlns:bc="http://www.eclipse.org/buckminster/Common-1.0">

    <searchPath name="default">
        <provider
          readerType="svn"
          componentTypes="eclipse.feature,osgi.bundle,buckminster"
          source="true">
            <uri
             format="svn://dev.eclipse.org/svnroot/technology/org.eclipse.buckminster/trunk/org.eclipse.buckminster/demo/{0}">
               <bc:propertyRef key="buckminster.component" />
            </uri>
        </provider>
    </searchPath>

    <locator searchPathRef="default" pattern="^org\.demo\..*" />
    <redirect href="http://www.eclipse.org/buckminster/samples/rmaps/dogfood2.rmap" pattern=".*"/>
</rmap>

This is what the RMAP XML means:

  • The 6 first lines declare the name spaces and syntax of the rmap and the repository providers needed.
  • Below that you see two major elements declaring search paths, the first is called default, and the second is called maven.
  • Continue down and you see two locator declarations...
    • the first states that if a component name starts with se.tada. then the maven search path should be used.
    • and the second locator states that if the name starts with org.demo. then the default path should be used.
  • Back to the paths:
    • The default path:
      • The default path declares that the repository is in SVN and that what we find is an eclipse plugin
      • We do not need to commit changes back (mutable=false), and we do not want source (source=false).
      • The URI to the SVN repository is stated next
      • This URI ends with the name of the component. This name is obtained from the preset property buckminster.component which contains the name of the component being matched.
    • The maven path:
      • The maven path declares that it uses a maven provider and a reader type of maven and that the component type is also a maven component. Further the mutable=false says that we are not interested in committing any changes back to the repository, and source=false says that we are not interested in source.
      • A URI to the maven repository at Maven.org is declared
      • A mapping that translates the component name into what the actual file on Ibiblio is called is then declared (i.e. mapping se.tada.util.sax to tada-sax).

The CSPEC in Component C

Since component C - org.demo.worlds is not a plugin and thus lack meta data that describes its dependencies, and how to produce it, we need to add this information. We decide to use Buckminster's CSPEC XML language. This is what we place in a file called buckminster.cspec inside component C:

<?xml version="1.0" encoding="UTF-8"?>
<cs:cspec xmlns:cs="http://www.eclipse.org/buckminster/CSpec-1.0" name="org.demo.worlds">
    <cs:artifacts>
    	<cs:public name="source" path="src/"/>
    </cs:artifacts>
    <cs:actions>
        <cs:public name="java.binary.archives" actor="ant">
            <cs:actorProperties>
                <cs:property key="buildFile" value="make/build.xml"/>
            </cs:actorProperties>
            <cs:prerequisites alias="input">
                <cs:attribute name="eclipse.build"/>
            </cs:prerequisites>
            <cs:products alias="output" base="bin/jars/">
                <cs:path path="worlds.jar"/>
            </cs:products>
        </cs:public>
        <cs:private name="eclipse.build">
            <cs:prerequisites>
                <cs:attribute name="source"/>
            </cs:prerequisites>
            <cs:products base="bin/classes/">
                <cs:path path="."/>
            </cs:products>
        </cs:private>
    </cs:actions>
    <cs:groups>
    	<cs:public name="java.binaries">
    		<cs:attribute name="eclipse.build"/>
    	</cs:public>
    </cs:groups>
</cs:cspec>

This meta data does the following:

  • First two lines declare that this is XML, and that it follows the CSPEC format, and it describes a component called org.demo.worlds
  • Next section lists the component attributes that are artifacts (i.e. a static declaration of paths).
    • There is only one declaration, a public attribute called source that is mapped to a directory called src. Notice that the name ends with a slash to denote that we refer to the directory.
  • Next section lists the component attributes that are implemented as actions (i.e. computed attribute values).
    • java.binary.archives is the first
      • It is implemented using an ANT action, and parameters are set
      • Then there is one pre-requisite - the local attribute eclipse.build is needed before this action can execute.


The CSPEX in the B Component

The B components component meta data is created from the information in the Eclipse plug-in. But there are things we want to add that can not be declared in the regular plug-in meta data. Buckminster makes it possible to extend the generated CSPEC by adding a file buckminster.cspex. This file follows the CSPEC format. In this example this is straight forward as we are only adding things. Here is the content of the CSPEX file for component B (org.demo.xml.provider).

<?xml version="1.0" encoding="UTF-8"?>
<cs:cspecExtension
	xmlns:com="http://www.eclipse.org/buckminster/Common-1.0"
	xmlns:cs="http://www.eclipse.org/buckminster/CSpec-1.0">
	<cs:dependencies>
		<cs:dependency name="org.demo.worlds" componentType="osgi.bundle"/>
		<cs:dependency name="se.tada.util.sax"  versionDesignator="1.0.0" versionType="OSGi"/>
	</cs:dependencies>

	<cs:actions>

		<cs:private name="buckminster.prebind" actor="ant">

			<cs:actorProperties>
				<cs:property key="buildFile" value="make/prebind.xml" />
			</cs:actorProperties>

			<cs:prerequisites>
				<cs:attribute component="se.tada.util.sax" alias="tada-sax.jar" name="java.binary.archives"/>
				<cs:attribute component="org.demo.worlds" alias="worlds.jar" name="java.binary.archives"/>
			</cs:prerequisites>

			<cs:products alias="output">
				<cs:path path="jars/" />
			</cs:products>

		</cs:private>
		
	</cs:actions>

</cs:cspecExtension>

This extension works as follows:

  • Lines 1-4 is the XML stuff and declaration of namespaces. Note the use of a cspecExtension element as the top most element.
  • Next, two component dependencies are listed, on the component org.demo.worlds (a plugin ("osgi.bundle")), and on the tada sax-parser se.tada.util.sax.
  • The following actions section declares a private "prebind" action - this action kicks in before the component content is bound to the Eclipse workspace. As you can see, the action is an ant action, and it uses a make/prebind.xml file with the instructions for the build.
    • There are two pre-requisites - on the sax parser, and on a jar file called worlds-jar that is obtained from the attribute java.binary.archives in the component org.demo.worlds
    • The products section declares that the result is called output and where the output is produced.

Demo flow

The following takes place when Buckminster resolves the query.

  1. Resolving the CSPEC for all components
    1. The name of the top component in the CQUERY is resolved to the default searchPath in the RMAP.
    2. The SVN provider of this RMAP is chosen (it's the only one)
    3. The eclipse.project componentType will obtain the ProjectDescriptor (the .project) from the eclipse project.
    4. From the natures of that descriptor, it will conclude that the component is a plugin.
    5. The component type will use a PluginBuilder to create a CSPEC from the plugin manifest files.
    6. This CSPEC will contain a dependency to the org.demo.xml.provider component.
    7. Buckminster now resolves that component in the exact same #1 to #6
    8. The CSPEC from org.demo.xml.provider is augmented with a CSPEC extension (CSPEX) that adds the jar dependencies (since those cannot be fully expressed in the plugin manifest)
    9. The first jar dependency is resolved using the same provider as before but the ProjectDescriptor has no plugin nature this time so the CSPEC that has been checked in with the component instead.
    10. The second jar is resolved using the maven search path and the maven repository.
  2. Materializing and binding the components
    1. All components are copied (by Buckminster) to the local disk using the chosen providers.
    2. The bind phase starts and components are bound in dependency order.
    3. The first component that becomes known to Eclipse is org.demo.worlds (i.e. C)
    4. The CSPEX of the second component, org.demo.xml.provider (i.e. B) contains a prebind action that:
      1. Builds component C to a jar and copies that jar into the jars directory of component B.
      2. Copies the component D from a cache location into the jars directory of component B.
    5. Once the prebind actions have completed, the B component bound to the workspace.
    6. Component A is bound last.
    7. Eclipse receives a lot of events and thus, rebuilds the workspace.

Note that the tada-sax (i.e. D) was never bound to the workspace since it is not an Eclipse project.