Page History

...

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

Pre-Installation Requirements

The recommended software environment is:

• Java Developer Kit (JDK) 1.45.x or greater to run ServiceMix, 1.5.x or greater to build ServiceMix.
• 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 12.0.2 4 or greater (required when installing source or developers' developer releases).
• Apache Tomcat version 5.5
• ServiceMix 3.0.x

The following is the platform which was used to produce this documentdeployment guide:

• Windows XP
• Tomcat 5.5
• Java 5
• ServiceMix 3.0

Deploying ServiceMix on Tomcat

Execute the following steps to deploy ServiceMix on Apache Tomcat. NoteNOTE: this 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. Please It is important to note if your Tomcat installation has Tomcat is on another port, such as port 80; this information will be used in a later step.
3. Download and build the ServiceMix source codedistribution. Please see the Getting Started guide for instructions.
   Note: ServiceMix must be BUILT as well as downloaded.
4. Create the WAR file:

   Code Block
   cd [servicemix_install_dir]\toolingexamples\servicemix-web mavenmvn warinstall

   where servicemix_install_dir is the directory in which ServiceMix was downloaded and installed.

   Warning
   title For ServiceMix 3.0
   If you use ServiceMix 3.0, you need to modify the pom.xml file in the \examples\servicemix-web directory. Lines 79-83 should be modified as following: Code Block lang xml <dependency> <groupId>org.mortbay.jetty</groupId> <artifactId>jetty</artifactId> </dependency> For ServiceMix 3.0.1 or later, this step is not necessary.

5. To deploy the WAR file, servicemix-web-xxx.war, copy it to the Tomcat webapps directory. For example, on a Windows system:

   Code Block
   cd [servicemix_install_dir]\toolingexamples\servicemix-web\target copy servicemix-web-*.war [tomcat_install_dir]\webapps

   where tomcat_install_dir is the directory in which Tomcat was installed.
   
6. Stop and start Tomcat to deploy the ServiceMix WAR file.
7. If there are errors indicating missing classes when Tomcat starts, perform the followng steps:
   1. Stop Tomcat.
   2. Install additional jar files in the deployed ServiceMix directory. The missing jar files are: commons-collections-3.1.jar and commons-pool-1.2.jar. These can be obtained by using a search engine and searching for them. Or they can found in your Maven repository, which is usually located in your_home_dir\.maven\repository. Specifically, your_home_dir\.maven\repository\commons-collections\jars and your_home_dir\.maven\repository\commons-pool\jars.

      Code Block
      copy commons-collections-3.1.jar [tomcat_install_dir]\webapps\servicemix-web\WEB-INF\lib copy commons-pool-1.2.jar [tomcat_install_dir]\webapps\servicemix-web\WEB-INF\lib

   3. Start Tomcat.
      The Tomcat console output should show ServiceMix starting:

      Code Block

      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

1. Start Tomcat if it was not already running
   The output in the Tomcat console window should show ServiceMix starting. Output will be similar to the following:

   Code Block

   INFO: Deploying web application archive servicemix-web-3.0-incubating.war Sept. 29, 2006 19:49:40 org.apache.catalina.loader.WebappClassLoader validateJarFile INFO: validateJarFile(c:\java-bin\apache-tomcat-5.5.20\webapps\servicemix-web-3.0-incubating\WEB-INF\lib\servlet-api-2.5-6.0.0rc4.jar) - jar not loaded. See Servlet Spec 2.3, section 9.7.2. Offending class: javax/servlet/Servlet.class INFO - jetty - Logging to org.apache.servicemix.http.jetty.JCLLogger@628704 via org.apache.servicemix.http.jetty.JCLLogger INFO - JBIContainer - ServiceMix 3.0-incubating JBI Container (ServiceMix) is starting INFO - JBIContainer - For help or more informations please see: http://incubator.apache.org/servicemix/ INFO - ConnectorServerFactoryBean - JMX connector available at: service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi INFO - ComponentMBeanImpl - Initializing component: #SubscriptionManager# INFO - DeploymentService - Restoring service assemblies INFO - ComponentMBeanImpl - Initializing component: servicemix-http INFO - ComponentMBeanImpl - Initializing component: echo INFO - ComponentMBeanImpl - Initializing component: timer INFO - SimpleThreadPool - Job execution threads will use class loader of thread: ContainerBackgroundProcessor[StandardEngine[Catalina]] INFO - QuartzScheduler - Quartz Scheduler v.1.5.2 created. INFO - RAMJobStore - RAMJobStore initialized. INFO - StdSchedulerFactory - Quartz scheduler 'DefaultQuartzScheduler' initialized from default resource file in Quartz package: 'quartz.properties' INFO - StdSchedulerFactory - Quartz scheduler version: 1.5.2 INFO - ComponentMBeanImpl - Initializing component: inputSender INFO - ComponentMBeanImpl - Initializing component: inputReceiver INFO - ComponentMBeanImpl - Initializing component: outputSender INFO - ComponentMBeanImpl - Initializing component: jmsTrace INFO - ComponentMBeanImpl - Initializing component: trace ERROR - ClientFactory - Cound not start ClientFactory: javax.naming.NamingException: Context is read only. INFO - QuartzScheduler - Scheduler DefaultQuartzScheduler_$_NON_CLUSTERED started. INFO - JBIContainer - ServiceMix JBI Container (ServiceMix) started

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 to confirm that the servicemix-web is starting without errors.
2. Run the ServiceMix JMX Console. To do this, enter the following URL in a web browser: http://localhost:8080/servicemix-web-3.0-incubating/. 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:
      
      Image Added
      
      
3. An http binding example is supplied. To run the example program perform the following steps: ^{Image Removed}
   1. From a browser, enter the URL http://localhost:8080/servicemix-web-3.0-incubating/examples. NOTE: If Tomcat is using a different port, such as port 80, substitute the correct port number for 8080 in the URL.
      
      Image Added
      
      
   2. Enter a name or some text in the text box (shown above) and click the Submit button. You will see:
      
      Image Added
   1.