Setting Up a FUSE ESB OSGi Project

Overview

A Maven project for building an OSGi bundle can be a simple single level project. It does not require any sub-projects. It does, however, require that you do the following:

Add the bundle plug-in to your POM.
Instruct Maven to package the results as an OSGi bundle.

	Tip
	There are several Maven archetypes to set up your project with the appropriate settings.

Directory structure

A project that constructs an OSGi bundle can be a single level project. It only requires that you have a top-level POM file and a src folder. As in all Maven projects, you place all Java source code in the src/java folder. You place any non-Java resources into the src/resources folder.

Non-Java resources include Spring configuration files, JBI endpoint configuration files, WSDL contracts, etc.

	Note
	FUSE ESB OSGi projects that use FUSE Services Framework, FUSE Mediation Router, or another Spring configured bean also include a `beans.xml` file located in the `src/resources/META-INF/spring` folder.

Adding a bundle plug-in

Before you can use the bundle plug-in you must add a dependency on Apache Felix. After you add the dependency, you can add the bundle plug-in to the plug-in portion of the POM.

Example 7.1 shows the POM entries required to add the bundle plug-in to your project.

Example 7.1. Adding an OSGi Bundle Plug-in to a POM

...
<dependencies>
  <dependency> 
    <groupId>org.apache.felix</groupId>
    <artifactId>org.osgi.core</artifactId>
    <version>1.0.0</version>
  </dependency>
...
</dependencies>
...
<build>
  <plugins>
    <plugin> 
      <groupId>org.apache.felix</groupId>
      <artifactId>maven-bundle-plugin</artifactId>
      <configuration>
        <instructions>
          <Bundle-SymbolicName>${pom.artifactId}</Bundle-SymbolicName> 
          <Import-Package>*,org.apache.camel.osgi</Import-Package> 
          <Private-Package>org.apache.servicemix.examples.camel</Private-Package> 
        </instructions>
      </configuration> 
    </plugin>
  </plugins>
</build>
...

The entries in Example 7.1 do the following:

	Adds the dependency on Apache Felix.
	Adds the bundle plug-in to your project.
	Configures the plug-in to use the project's artifact ID as the bundle's symbolic name.
	Configures the plug-in to include all Java packages imported by the bundled classes and also import the org.apache.camel.osgi package.
	Configures the plug-in to bundle the listed class, but not include them in the list of exported packages.

	Note
	You should edit the configuration to meet the requirements of your project.

For more information on configuring the bundle plug-in, see Configuring a Bundle Plug-in.

Activating a bundle plug-in

To instruct Maven to use the bundle plug-in, you instruct it to package the results of the project as a bundle. You do this by setting the POM file's packaging element to bundle.

Useful Maven archetypes

There are several Maven archetypes to generate a project that is preconfigured to use the bundle plug-in:

Spring OSGi archetype

The Spring OSGi archetype creates a generic project for building an OSGi project using Spring DM:

org.springframework.osgi/spring-bundle-osgi-archetype/1.1.2

You invoke the archetype using the following command:

mvn archetype:create
-DarchetypeGroupId=org.springframework.osgi   
-DarchetypeArtifactId=spring-osgi-bundle-archetype  
-DarchetypeVersion=1.12   
-DgroupId=groupId  
-DartifactId=artifactId 
-Dversion=version

FUSE Services Framework code-first archetype

The FUSE Services Framework code-first archetype creates a project for building a service from Java:

org.apache.servicemix.tooling/servicemix-osgi-cxf-code-first-archetype/2008.01.0.3-fuse

You invoke the archetype using the following command:

mvn archetype:create   
-DarchetypeGroupId=org.apache.servicemix.tooling   
-DarchetypeArtifactId=spring-osgi-bundle-archetype  
-DarchetypeVersion=2008.01.0.3-fuse 
-DgroupId=groupId  
-DartifactId=artifactId 
-Dversion=version

FUSE Services Framework wsdl-first archetype

The FUSE Services Framework wsdl-first archetype creates a project for creating a service from WSDL:

org.apache.servicemix.tooling/servicemix-osgi-cxf-wsdl-first-archetype/2008.01.0.3-fuse

You invoke the archetype using the following command:

mvn archetype:create   
-DarchetypeGroupId=org.apache.servicemix.tooling   
-DarchetypeArtifactId=servicemix-osgi-cxf-wsdl-first-archetype 
-DarchetypeVersion=2008.01.0.3-fuse 
-DgroupId=groupId  
-DartifactId=artifactId 
-Dversion=version

FUSE Mediation Router archetype

The FUSE Mediation Router archetype creates a project for building a route that is deployed into FUSE ESB:

org.apache.servicemix.tooling/servicemix-osgi-camel-archetype/2008.01.0.3-fuse

You invoke the archetype using the following command:

mvn archetype:create
-DarchetypeGroupId=org.apache.servicemix.tooling 
-DarchetypeArtifactId=servicemix-osgi-camel-archetype  
-DarchetypeVersion=2008.01.0.3-fuse 
-DgroupId=groupId  
-DartifactId=artifactId 
-Dversion=version