Tomcat Integration for ServiceMix 2.0.1

Tomcat Integration

The following guide explains how to deploy ServiceMix 2.0.x on the Apache Tomcat application server. This guide provides instructions specifically for ServiceMix 2.0.x release. For ServiceMix 1.1 and ServiceMix 2.0 instructions, refer to Tomcat Integration for ServiceMix 1.1 and 2.0.

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 Tomcat

Execute the following steps to deploy ServiceMix on Apache Tomcat. 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 ( \ ).

1. Apache Tomcat must be downloaded and installed. For instructions please see the Tomcat web site.
2. By default, Tomcat uses port 8080. It is important to note if your Tomcat installation is on another port, such as port 80; this information will be used in a later step.
3. Download the ServiceMix source code. Please see the Getting Started guide for instructions.
4. 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.
5. 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.
   
6. To deploy the ServiceMix WAR file, stop and start Tomcat.
   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:

1. Check the Tomcat console output or the Tomcat log files (see above) to confirm that the servicemix-web is starting without errors.
2. 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
   

   
   
3. 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:
      
      
      
      
4. 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: