Guice Extension Factory

using the GuiceExtensionFactory with Eclipse plug-ins

This work was influenced by Martin Lippert's SpringExtensionFactory.

What is the !GuiceExtensionFactory?

The GuiceExtensionFactory is an IExecutableExtensionFactory that creates an injected extension based on the class named in the adapter data section. If the data section is empty the class is assumed to be in the id attribute. The factory searches the org.ops4j.peaberry.eclipse.modules extension for Modules belonging to the same plug-in and uses them to create a new Injector. This injector creates the injected extension and is then cached so it can be re-used for other extensions in the same plug-in.

To use the factory put it in front of your class name in the extension XML. Or replace your class with the factory and put your class in the id attribute instead. Because the implementation will be injected based on the bindings you could even replace your class name with one of its interfaces, and that interface will then be used to lookup the correct implementation.

Here's a more detailed walkthrough, based on the example RCP Mail Template: becomes:

<extension point="org.ops4j.peaberry.eclipse.modules">
  <module class="example.ViewModule" />
</extension>

Here's the same example with the class in the id attribute:

<extension point="org.ops4j.peaberry.eclipse.modules">
  <module class="example.ViewModule" />
</extension>

and again, this time using an interface instead of the implementation:

<extension point="org.ops4j.peaberry.eclipse.modules">
  <module class="example.ViewModule" />
</extension>

How do I use peaberry with the GuiceExtensionFactory?

Basic peaberry bindings to support lookup of services from the OSGi service registry and Eclipse extension registry are automatically installed by the factory, which effectively does this: binder.install(Peaberry.osgiModule(contributorContext, EclipseRegistry.eclipseRegistry())); So you only need to add your own custom bindings to the org.ops4j.peaberry.eclipse.modules extension.