Geronimo 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. This guide provides instructions for the ServiceMix 2.0.x release.

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.
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.
To deploy the WAR file, servicemix-web.war, copy it to the Tomcat webapps directory. For example, on a Windows system:
```
cd [servicemix_install_dir]\tooling\servicemix-web\target
copy servicemix-web.war [tomcat_install_dir]\webapps
```
where tomcat_install_dir is the directory in which Tomcat was installed.

To deploy the ServiceMix WAR file on Geronimo, use the Geronimo deployer.jar tool found in the bin directory of the Geronimo base directory.
The output in the Tomcat console window should show ServiceMix starting. Output will be similar to the following:

INFO: Deploying web application archive servicemix-web.war
Nov 1, 2005 11:03:54 AM org.springframework.web.context.ContextLoader initWebApplicationContext
INFO: Root WebApplicationContext: initialization started
Nov 1, 2005 11:03:54 AM org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
INFO: Loading XML bean definitions from ServletContext resource [/WEB-INF/applicationContext.xml]
Nov 1, 2005 11:03:55 AM org.springframework.core.CollectionFactory <clinit>
INFO: JDK 1.4+ collections available
Nov 1, 2005 11:03:55 AM org.springframework.core.CollectionFactory <clinit>
INFO: Commons Collections 3.x available
Nov 1, 2005 11:03:55 AM org.springframework.context.support.AbstractRefreshableApplicationContext refreshBeanFactory
INFO: Bean factory for application context [Root WebApplicationContext]: org.springframework.beans.factory.support.DefaultListableBeanFactory defining beans [jencks,broker,transactionManager,jmsFactory,jbi]; root of BeanFactory hierarchy
Nov 1, 2005 11:03:55 AM org.springframework.context.support.AbstractApplicationContext refresh
INFO: 5 beans defined in application context [Root WebApplicationContext]
Nov 1, 2005 11:03:55 AM org.springframework.context.support.AbstractApplicationContext initMessageSource
INFO: Unable to locate MessageSource with name 'messageSource': using default [org.springframework.context.support.DelegatingMessageSource@1049d3]
Nov 1, 2005 11:03:55 AM org.springframework.context.support.AbstractApplicationContext initApplicationEventMulticaster
INFO: Unable to locate ApplicationEventMulticaster with name 'applicationEventMulticaster': using default [org.springframework.context.event.SimpleApplicationEventMulticaster@14a7a12]
Nov 1, 2005 11:03:55 AM org.springframework.ui.context.support.UiApplicationContextUtils initThemeSource
INFO: No ThemeSource found for [Root WebApplicationContext]: using ResourceBundleThemeSource
Nov 1, 2005 11:03:55 AM org.springframework.beans.factory.support.DefaultListableBeanFactory preInstantiateSingletons
INFO: Pre-instantiating singletons in factory [org.springframework.beans.factory.support.DefaultListableBeanFactory defining beans [jencks,broker,transactionManager,jmsFactory,jbi]; root of BeanFactory hierarchy]
Nov 1, 2005 11:03:55 AM org.springframework.beans.factory.support.AbstractBeanFactory getBean
INFO: Creating shared instance of singleton bean 'jencks'
Nov 1, 2005 11:03:56 AM org.springframework.beans.factory.support.AbstractBeanFactory getBean
INFO: Creating shared instance of singleton bean 'broker'
...

NOTE: The console output is also logged in tomcat_home_dir\logs\catalina.xxxx-xx-xx.log.

Testing the ServiceMix Deployment on Tomcat

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

Check the Tomcat console output or the Tomcat log files (see above) to confirm that the servicemix-web is starting without errors.
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. Note: your installation of Tomcat may not be running on port 8080. If that is the case, replace 8080 with the correct port number in the previous URL.
Try using the JMX console. For example, perform the following steps. Note: this is optional.
1. Click on "Catalina".
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. NOTE: If Tomcat is using a different port, such as port 80, substitute the correct port number for 8080 in the URL.
2. Enter a name or some text in the text box (shown above) and click the Submit button. You will see:

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

Geronimo Integration Lisa

Introduction