I have created two maven archetypes for creating maven based projects for developing JBI Components (Service Engines and Binding Components). The maven projects created using these archetypes are complete projects which are ready to build and test ( unit and integration test ) a working JBI Component. The maven project created for the JBI Component will have a maven project metadata (pom.xml), ant build scripts,  sample code that implements either BC or SE,  sample junit test and integration test code. The project can be buildable using maven build lifecycle or ant build lifecycle to completely build and test the component. The sample source code and the source structure for component implementation is same as that explained in the article JBI Examples - Developing JBI Components.

How to create maven project for SE or BC

To create  SE or BC maven projects, "create" goal of the maven archetype plugin should be executed with SE or BC archetypes configuration parameters.  Maven version 2.0.4 or 2.0.5 is required to correctly download the archetype plugin. If you have setup the build environment for open-esb or open-jbi-components projects, you already have the required maven setup. If not, download and install Maven2 version : 2.0.5 from http://maven.apache.org/

 The following configuration parameters effect the code generated in the maven project for SE or BC

• groupId :  Group id of the new jbi component maven project that you are creating.
• artifactId: Artifact id of the new project. Its value will be used to create the project directory. This value will be also used as a JBI component name in generated sample code and the jbi installation descriptor for the component.
  
• packageName:  A dot separated name for the java package name that will be created under source root and where the component specific classes will be added. It also will be used as  package name for the Component and Bootstrap classes in the installation descriptor. If you omit the packageName, the groupId value will be used as a package name. So, make sure that the group id is a qualified package name if you omit the packageName.
• version:  Version for your component project. for example, 1.0-SNAPSHOT

Service Engine(SE) archetype command

To create a service engine maven project, use maven-archetype-jbi-se  archetype. The command that creates the service engine project using this archetype is as follows.

Note that all the options to the archetype:create must be specified in a single line.

Service Engine project create command
mvn archetype:create -DremoteRepositories=http://download.java.net/maven/2/ -DarchetypeGroupId=open.jbi.components.maven.archetype -DarchetypeArtifactId=maven-archetype-jbi-se -DarchetypeVersion=0.1 -DgroupId=<your.component.group.id> -DartifactId=<yourEngineName> -DpackageName=<your.component.package> -Dversion=<your project version>

The following is an example of the SE project create command that creates service engine maven project with  jbi component name "my-first-se"  in a directory "my-first-se" and creates a sample code specific to the SE in "com.example.engine" along with other build and test artifacts.

Note that all the options to the archetype:create must be specified in a single line.

Example Service Engine project create command
mvn archetype:create -DremoteRepositories=http://download.java.net/maven/2/ -DarchetypeGroupId=open.jbi.components.maven.archetype -DarchetypeArtifactId=maven-archetype-jbi-se -DarchetypeVersion=0.1 -DgroupId=my.group.id -DartifactId=my-first-se -DpackageName=com.example.engine -Dversion=1.0-test

Binding Component(BC) archetype command

To create a binding component maven project, use maven-archetype-jbi-bc  archetype. The command that creates the binding component project using this archetype is as follows.

Note that all the options to the archetype:create must be specified in a single line.

Binding Component (BC)  project create command
mvn archetype:create -DremoteRepositories=http://download.java.net/maven/2/ -DarchetypeGroupId=open.jbi.components.maven.archetype -DarchetypeArtifactId=maven-archetype-jbi-bc -DarchetypeVersion=0.1 -DgroupId=<your.component.group.id> -DartifactId=<yourBindingName> -DpackageName=<your.component.package> -Dversion=<your project version>

The following is an example of the BC project create command that creates binding component maven project with  jbi component name "my-first-bc"  in a directory "my-first-bc" and creates a sample code specific to the BC in "com.example.binding" along with other build and test artifacts.

Note that all the options to the archetype:create must be specified in a single line.

Example Binding Component project create command
mvn archetype:create -DremoteRepositories=http://download.java.net/maven/2/ -DarchetypeGroupId=open.jbi.components.maven.archetype -DarchetypeArtifactId=maven-archetype-jbi-bc -DarchetypeVersion=0.1 -DgroupId=my.group.id -DartifactId=my-first-bc -DpackageName=com.example.binding -Dversion=1.0-test

How to Build  SE or BC maven project

In the maven project for JBI Component ( BC or SE ), the code generated and the filesystem structure are similar to what is describes in the JBI Examples - Developing JBI Components.  The difference is that the component name and component specific classes are generated according to the project creation settings and a maven project metadata ( pom.xml ) is generated to build the project from maven build environment.

The build lifecycle for  both SE and BC projects are same.  During the build, when a maven build phase is executed, the maven build lifecycle phases call the corresponding ant build script targets ( ant build lifecycle ) where the actual action for compile, package and test the components takes place.

The following maven build lifecycle phases can be executed to perform compile, package, unit testing and integration testing of the component.

build phase	Description
mvn compile	Compiles the  component sources
mvn test-compile	Compiles test sources and component sources
mvn test	Runs junit tests after compiling component sources and test sources.
mvn package	Packages compiled component sources into JBI component installation zip archive file. It runs junit tests by executing test phase before packaging.
mvn integration-test	Runs integration test after calling package and test phase. The integration test  installs and starts the component, build, deploy and starts test service assembly if needed,  and runs the test client code, then undeploys test service assembly if needed and then uninstalls the component. The results of the test will be in Output.xml in the test results directory.
mvn install	Executes all the above phases and then installs the component installer zip archive file to the maven local repository.
mvn clean	Cleans the output directories ( build, dist ) and then try to uninstall the component from the server. If uninstall fails, the results are shown, but the build will not fail.

Before building and testing the component from maven do the following

1. Install glassfish  ( download and install from https://glassfish.dev.java.net/ )
2. Set the JV_GFBASE environment variable to the glassfish V2 installation root ( e.g. set JV_GFBASE=C:/Sun/glassfish ) .
3. Edit pom.xml (optional) - only required if the glassfish is not installed with default settings or JV_GFBASE environment variable is not set.
1. Set the glassfish home :  under <properties> element set glassfish.home property value to the glassfish v2 installation root.
2. Set the jbi admin settings (optional) :  under <properties> element set jbi.host, jbi.port, jbi.username, jbi.password properties to glassfish admin settings.
4. Run the glassfish (optional)  only required for the integration-test and install phases of the project builds.
5. Execute build lifecycle phases using "mvn" command.

Note:  To do the integration-test of the  generated BC project,  a service engine from the generated SE project should be installed and started.  So, before executing the "integration-test" of the generated BC project,  execute the "integration-test" phase of the SE project with "-Dtest.uninstall.skip=true" to not uninstall the SE.

Sample integration testing steps for the SE and BC projects created from the example commands shown above.

asadmin start-domain domain1 - to start the glassfish cd my-first-se mvn -Dtest.uninstall.skip=true integration-test cd my-first-bc mvn integration-test mvn clean cd my-first-se mvn clean asadmin stop-domain domain1 - to stop the glassfish

Building project with Apache Ant (Optional)

If you would like to build and test the project using ant outside the maven, do the following setup before using the ant targets directly from ant.

1. Install glassfish  ( download and install from https://glassfish.dev.java.net/ )
2. Set the JV_GFBASE environment variable to the glassfish v2 installation root ( e.g. set JV_GFBASE=C:/Sun/glassfish ) .
3. Edit build.properties file
   
1. Set the glassfish home : set glassfish.home property value to the glassfish v2 installation root.
2. Set the jbi admin settings (optional) :  set jbi.host, jbi.port, jbi.username, jbi.password properties to glassfish admin settings if the glassfish is not installed with default settings.
3. Set the libs.junit.classpath property to point to the correct location of the junit jar files for junit runtime and junit ant task
4. Run the glassfish (optional)  only required for the integration-test and install phases of the project builds.
5. Execute ant targets using  "ant -lib "path/to/junit/jars" <target>" to build and test the component.  -lib option is required as the junit ant task can not load the junit runtime jars from the taskdef classpath if the junit taskdef jar is in the lib directory of the ant home.

the following are the ant targets available for execution

Ant build targets to build project using Apache Ant

cd my-first-se ant -p Buildfile: build.xml This project compile, package and manage JBI Components using Ant and JBI Ant tasks in OpenESB2.0 Main targets: clean clean up compile compiles jbi component source compile-test compile the test source install compile, package, install and starts the jbi component integration-test run integration tests on the jbi component package compile and packages jbi component sources into installer zip archive file run compile, package and installs the jbi component show displays runtime state of jbi component info test run unit tests on the jbi component uninstall Stop, shuts down and uninstalls the jbi component Default target: run