Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

To create a Module which supports a Component Type, you need to implement a series of interfaces to the Tuscany Core, plus a set of related files which declare your Module to the core:

  • xxxModuleActivator class, which implements the ModuleActivator interface
  • ModuleActivator file
  • xxxArtifactProcessor class, which processes the XML for an implementation type
  • xxxImplementation class, which represents a runtime instance of the implementation type

How does a Component Type Module declare the XML that it handles?

For a Component Type module, it is going to handle the XML <implementation.xxx.../>, which is a child of a <component.../> element in the SCDL.

How does the module indicate to the core that it handles the <implementation.xxx.../> element?

TODO: Get an answer to this question.... 

xxxModuleActivator class

Called when the Tuscany core is loading, starting and stopping the Module which implements the component type.

Implements ModuleActivator interface, with 3 methods:

  • start
  • stop
  • getExtensionPoints

Of these, start() is the most important - it seems possible to get by with the other 2 doing nothing.

Start handles: 

  • Registration of xxxArtifactProcessor, which handles the <implementation.xxx..../> XML
  • Registration of xxxComponentBuilder, which builds a component of the type handled by the module
  • Registration of xxxPropertyValueObjectFactory

The ModuleActivator file 

...

The file contains the class name for the implementation of your Module, eg:

Code Block

\# Implementation class for the ExtensionActivator for module Foo
org.apache.tuscany.implementation.foo.FooModuleActivator


The xxxArtifactProcessor class

This class is called to deal with the XML in the composite SCDL files which relates to the implementation type - ie. <implementation.xxx.../>

The class is passed an XML stream which it reads and parses out the contents of the <implementation.xxx.../> element, principally getting all of the attributes and child elements (if present).

When the information has been parsed out, the xxxArtifactProcessor class creates an xxxImplementation object which represents the runtime component corresponding to the implementation.xxx element.

One other step that is handled by the xxxArtifactProcessor class is the resolution of the componentType for the component - teasing out its services, references and properties.  This is either done by introspection of the implementation (instance) or via reading a componentType side file. 

xxxImplementation class

The xxxImplementation class represents the implementation instances themselves.

Implements the org.apache.tuscany.assembly.Implementation interface