Deploying Mule as a Service to Tomcat

Mule Runtime Engine versions 3.5, 3.6, and 3.7 reached End of Life on or before January 25, 2020. For more information, contact your Customer Success Manager to determine how you can migrate to the latest Mule version.

This page describes two activities that will enable you to deploy your Mule applications on a Tomcat Web server:

Install Mule as a service on an Apache Tomcat server
Set up your Mule applications for hot deployment

For more information on hot deploying Mule applications, see Application Server Based Hot Deployment.

Installing Mule on Tomcat

Download and install Apache Tomcat, following Apache’s installation instructions.
In the Tomcat home directory on your system, add the following line to the conf/server.xml file:
```
<Listener className="org.mule.module.tomcat.MuleTomcatListener" />
```
If you have not already done so, create a Tomcat home directory on your local system.
Copy the contents of the Mule lib folder with all its subdirectories – except /boot to the mule-libs/ – to your Tomcat home directory. You do not need to flatten the directories.
Copy the mule-module-tomcat-<version>.jar file to the mule-libs/mule/ directory in your Tomcat home directory.
Copy the following libraries from your Mule lib/boot/ directory to your Tomcat `mule-libs/opt/`directory:
- commons-cli-1.2.jar
- jcl-over-slf4j-1.7.7.jar
- log4j-jcl-2.1.jar
- slf4j-api-1.7.7.jar
- disruptor-3.3.0.jar
- wrapper-3.5.19.jar

In the Tomcat conf/catalina.properties file, add the following to common.loader (preceded by a comma to separate it from existing values):

${catalina.base}/lib,${catalina.base}/lib/*.jar,${catalina.home}/lib,${catalina.home}/lib/*.jar,${catalina.home}/mule-libs/user/*.jar,${catalina.home}/mule-libs/mule/*.jar,${catalina.home}/mule-libs/opt/*.jar,${catalina.home}/mule-libs/endorsed/*.jar

Ensure you have only one listener in your web.xml file:

<listener>
<listener-class>
org.mule.module.tomcat.MuleTomcatListener
</listener-class>
</listener>

Deploying Mule Applications in Tomcat

Package your Mule application’s configuration files and custom Java classes in a .war file (see Application Server Based Hot Deployment).
Copy your application’s .war file, then paste it in the Tomcat /webapps directory.
Tomcat hot deploys the application.

If you need to make a change to the configuration or Java file in the Mule application, modify the file in the expanded directory under the Tomcat /webapps directory, then touch the web.xml file (for example, simply add and delete a space in the file and then save it). These actions trigger Tomcat to redeploy the application.

Alternatively, you can modify the application’s source files, repackage them as a .war file, then drop the new .war file into the /webapps directory to trigger Tomcat to redeploy the application.

Deploying Mule as a Service to Tomcat

Installing Mule on Tomcat

Deploying Mule Applications in Tomcat

See Also