The Jakarta Project
      The Apache Tomcat Servlet/JSP Container


User Guide


Apache Tomcat Development

The Apache Tomcat 5.5 Servlet/JSP Container

Building Tomcat

Printer Friendly Version

Building Tomcat from CVS is very easy, and is the first step to contributing to Tomcat. The following is a step by step TODO list.

Download and install a Java Development Kit 1.4.x or later

Earlier releases would also work, but are harder to work with due to the need to download additional dependencies. Tomcat also runs much faster on the latest 1.4 JDK.

The Sun JDK can be downloaded here.

IMPORTANT: Set an environment variable JAVA_HOME to the pathname of the directory into which you installed the JDK release.

Install Apache Ant 1.6.x

Download a binary distribution of Ant 1.6.x from here.

Unpack the binary distribution into a convenient location so that the Ant release resides in its own directory (conventionally named "jakarta-ant-1.6.2"). For the purposes of the remainder of this document, the symbolic name "${ant.home}" is used to refer to the full pathname of the release directory.

Create an ANT_HOME environment variable to point the directory ${ant.home}, and modify the PATH environment variable to include directory "${ant.home}/bin" in its list. This makes the "ant" command line script available, which will be used to actually perform the build.

Building Tomcat

Download the main build.xml script from here.

Create a new directory, and copy the newly download build.xml to it. This directory will be referred to as the ${tomcat.source} directory in the rest of this document.

Go to that directory, and do:
cd ${tomcat.source}

NOTE: Users accessing the Internet through a proxy must use a properties file to indicate to Ant the proxy configuration. Read below.

WARNING: Running this command will checkout the Tomcat 5 sources from CVS, as well as download binaries to the /usr/share/java directory. Make sure this is appropriate to do so on your computer. On Windows, this usually corresponds to the C:\usr\share\java directory, unless Cygwin is used. Read below to customize the directory used to download the binaries.

The build can be controlled by creating a ${tomcat.source}/ file, and adding the following content to it:
# ----- Proxy setup -----
# Uncomment if using a proxy server.

# ----- Default Base Path for Dependent Packages -----
# Replace this path with the directory path where
# dependencies binaries should be downloaded.

Updating and rebuilding Tomcat sources

It is recommended to regularly update the downloaded Tomcat 5 sources. To do this, execute the following commands:
cd ${tomcat.source}
ant checkout

For a quick rebuild of only modified code you can use:
cd ${tomcat.source}
ant build

Building with Eclipse

Important: This is not a supported means of building Tomcat; this information is provided without warranty :-). The only supported means of building Tomcat is with the "ant build" described above. However, some developers like to work on Java code with a Java IDE, and the following steps have been used by some developers.

Note that you must complete all the above steps to fetch the repositories and build some JAR files the first time. After you have completed the above steps, you can set up a series of Eclipse 3 projects. Note that this will not let you build everything under Eclipse; the build process requires use of Ant for the many stages that aren't simple Java compilations. However, it will allow you to view and edit the Java code, get warnings, reformat code, perform refactorings, run Tomcat under the IDE, and so on.

Use File->New Project to create a new Java project for each of the binaries repository (e.g., /usr/share/java), tomcat-connectors, tomcat-catalina, jasper, servletapi. Unless you thought ahead to make the ${tomcat.source} directory be under your Workspace folder, tell Eclipse the external location. The obvious dependencies will be needed; the "repository" project needs to export all its jars, and be referred to by the other projects. Eclipse will find all source trees and jars, and hopefully compile without problems You will need to add ${ant-home}/lib/ant.jar as an "External Jar" under Project Properties for some of these projects (notably those that fail to compile for want of BuildException).

To run Tomcat without a special IDE plug-in, you can simply use Run->Run... enter "org.apache.catalina.startup.Catalina" as the main class, "start" as program arguments, and "-Dcatalina.home=..." (with the name of your build directory) as VM arguments.

Note also that due to the way the Tomcat source is assembled from several CVS projects, you may not be able to use the Eclipse CVS client to update (nor to commit, if you are a committer). Use the external CVS client of your choice, then use the Eclipse PackageExplorer or Navigator "Refresh" context menu item to tell Eclipse that you've updated the files.

Building with other IDEs

The same caveats apply as for Eclipse, above.

The same general idea should work in most IDEs; it has been reported to work in Idea, for example.

Copyright © 1999-2005, Apache Software Foundation