imoGeronimo Integration Lisa

Introduction

Geronimo is the J2EE server project of the Apache Software Foundation. ServiceMix is being tightly integrated with Geronimo so that it takes advantage of it's deployment architecture and to leverage geronimo to implement J2EE JBI bindings.

This document is under development and will be completed when the underlying code is ready. In the meantime, the ServiceMix on Geronimo deployment shown here is of the servicemix-web.war file. The war file uses lightweight components, which are those components defined in a servicemix.xml file. Ultimately, the ServiceMix deployment on Geronimo will use heavyweight components. Heavyweight components accept service unit deployments, such as PXE. If you are interested in this topic and how it progresses, please "watch" this page for future changes.

Geronimo Integration

The following guide explains how to deploy ServiceMix 2.0.x on the Geronimo application server.

Pre-Installation Requirements

Java Developer Kit (JDK) 1.4.x or greater to run ServiceMix (to build ServiceMix, JDK 1.5.x or greater is required)
The JAVA_HOME environment variable must be set to the directory where the JDK is installed, e.g. c:\Program Files\Java\jdk1.5.xx.
Maven 1.0.2 or greater (required when installing source or developer releases).
Apache Tomcat version 5.5
ServiceMix 2.0.x

The following platform was used to produce this deployment guide:

Windows XP
Tomcat 5.5
Java 5
ServiceMix 2.0.x

Deploying ServiceMix on Geronimo

Execute the following steps to deploy ServiceMix on Geronimo. NOTE: This procedure will work on Unix platforms, as well as the Windows platform, with the appropriate substitutions, such as using the backslash ( / ) instead of the forward slash ( \ ).

Geronimo must be downloaded and installed. For instructions please see the Geronimo web site. In the Geronimo release of geronimo-1.0-M5 or greater, Tomcat is integrated with Geronimo. By default, Tomcat uses port 8080. This information will be used later.
Download the ServiceMix source code. Please see the Getting Started guide for instructions.
Create the WAR file:
```
cd [servicemix_install_dir]\tooling\servicemix-web
maven war
```
where servicemix_install_dir is the directory in which ServiceMix was downloaded and installed. The war file can be found in [servicemix_install_dir]\tooling\servicemix-web\target\servicemix-web.war.

To deploy the ServiceMix WAR file on Geronimo, use the Geronimo deployer.jar tool found in the bin directory of the Geronimo base directory.
From a command shell:

cd [geronimo_install_dir]
java -jar bin/deployer.jar --user system --password manager deploy [servicemix-2.0.x_install_dir]\tooling\servicemix-web\target\servicemix-web.war

The output in the Geronimo console window should show ServiceMix starting. Output will be similar to the following:

...    
Geronimo Application Server started
13:13:17,062 WARN  [JettyModuleBuilder] Web application does not contain a WEB-INF/geronimo-web.xml deployment plan.  This may or may not
 a problem, depending on whether you have things like resource references that need to be resolved.  You can also give the deployer a sep
te deployment plan file on the command line.

NOTE: The console output is also logged in geronimo_install_dir\var\log\deployer.log.

Testing the ServiceMix Deployment on Geronimo

To ensure that ServiceMix is running on Geronimo, do any of the following:

ServiceMix's default port is 1099. From another window run netstat and search for port 1099.
From a Windows console, type:
```
       
netstat -an|find "1099"
```
OR

From a Unix command shell, type:
```
netstat -an|grep 1099
```
Run the ServiceMix JMX Console. To do this, enter the following URL in a web browser: http://localhost:8080/servicemix-web. Try using the JMX console. For example, perform the following steps. Note: this is optional.
1. Click on "geronimo".
2. Click on "Unknown".
3. Click on the "JMXServlet WebModule" to get monitoring information about the JMX Servlet itself:
An http binding example is supplied. To run the example program perform the following steps:
1. From a browser, enter the URL http://localhost:8080/servicemix-web/examples.
2. Enter a name or some text in the text box (shown above) and click the Submit button. You will see:
  
  Un-Deploying ServiceMix on Geronimo

Execute the following steps to undeploy ServiceMix on Geronimo.

To deploy the ServiceMix WAR file on Geronimo, use the Geronimo deployer.jar tool found in the bin directory of the Geronimo base directory.
From a command shell:
```
cd [geronimo_install_dir]
java -jar bin/deployer.jar --user system --password manager deploy [servicemix-2.0.x_install_dir]\tooling\servicemix-web\target\servicemix-web.war
```
The output in the Geronimo console window should show ServiceMix starting. Output will be similar to the following:
```
...
```

Status

A basic ServiceMix deployer has been integrated with Geronimo. You can now deploy JBI deployment units to a running Geronimo server using the geronimo deployment tool.

Deploying JBI Components

The JBI spec describes in detail how to create a valid JBI deployment unit. In essence, it is a jar file with a META-INF/jbi.xml with other resource jars inside it. Please see Deployment Units for more information.

Make sure that your geronimo server is running.

Run the geronimo deploy tool against your deployment unit (in this case jbcomponent.jar):

java -jar geronimo-1.0-SNAPSHOT/bin/deployer.jar --user system --password manager deploy jbcomponent.jar

That should deploy the component to geronimo. To check, just take a look at the geronimo logs for a message similar to:

11:44:24,865 INFO  [Configuration] Started configuration example-engine-1
11:44:24,869 INFO  [ServiceMixDeployment] Starting: /Users/chirino/sandbox/geronimo/modules/assembly/target/geronimo-1.0-SNAPSHOT/config-store/20/META-INF/jbi.xml
...
11:44:25,783 INFO  [DefaultListableBeanFactory] Creating shared instance of singleton bean 'jbi'

TODOs

Servicemix geronimo deployer should be enhanced to take advantage of Geronimo's classloader architecture
Build and integrate JBI binding compoents with geronimo. (At least integrate a HTTP, WS, and JMS binding components)

Child pages