| <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.77) - Building Tomcat</title><style type="text/css" media="print"> | |
| .noPrint {display: none;} | |
| td#mainBody {width: 100%;} | |
| </style><style type="text/css"> | |
| code {background-color:rgb(224,255,255);padding:0 0.1em;} | |
| code.attributeName, code.propertyName {background-color:transparent;} | |
| table { | |
| border-collapse: collapse; | |
| text-align: left; | |
| } | |
| table *:not(table) { | |
| /* Prevent border-collapsing for table child elements like <div> */ | |
| border-collapse: separate; | |
| } | |
| th { | |
| text-align: left; | |
| } | |
| div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code { | |
| background-color: transparent; | |
| } | |
| div.codeBox { | |
| overflow: auto; | |
| margin: 1em 0; | |
| } | |
| div.codeBox pre { | |
| margin: 0; | |
| padding: 4px; | |
| border: 1px solid #999; | |
| border-radius: 5px; | |
| background-color: #eff8ff; | |
| display: table; /* To prevent <pre>s from taking the complete available width. */ | |
| /* | |
| When it is officially supported, use the following CSS instead of display: table | |
| to prevent big <pre>s from exceeding the browser window: | |
| max-width: available; | |
| width: min-content; | |
| */ | |
| } | |
| div.codeBox pre.wrap { | |
| white-space: pre-wrap; | |
| } | |
| table.defaultTable tr, table.detail-table tr { | |
| border: 1px solid #CCC; | |
| } | |
| table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) { | |
| background-color: #FAFBFF; | |
| } | |
| table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) { | |
| background-color: #EEEFFF; | |
| } | |
| table.defaultTable th, table.detail-table th { | |
| background-color: #88b; | |
| color: #fff; | |
| } | |
| table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td { | |
| padding: 5px 8px; | |
| } | |
| p.notice { | |
| border: 1px solid rgb(255, 0, 0); | |
| background-color: rgb(238, 238, 238); | |
| color: rgb(0, 51, 102); | |
| padding: 0.5em; | |
| margin: 1em 2em 1em 1em; | |
| } | |
| </style></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img src="./images/tomcat.gif" align="right" alt=" | |
| The Apache Tomcat Servlet/JSP Container | |
| " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 7</font></h1><font face="arial,helvetica,sanserif">Version 7.0.77, Mar 28 2017</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="./images/asf-logo.svg" align="right" alt="Apache Logo" border="0" style="width: 266px;height: 83px;"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap class="noPrint"><p><strong>Links</strong></p><ul><li><a href="index.html">Docs Home</a></li><li><a href="http://wiki.apache.org/tomcat/FAQ">FAQ</a></li><li><a href="#comments_section">User Comments</a></li></ul><p><strong>User Guide</strong></p><ul><li><a href="introduction.html">1) Introduction</a></li><li><a href="setup.html">2) Setup</a></li><li><a href="appdev/index.html">3) First webapp</a></li><li><a href="deployer-howto.html">4) Deployer</a></li><li><a href="manager-howto.html">5) Manager</a></li><li><a href="realm-howto.html">6) Realms and AAA</a></li><li><a href="security-manager-howto.html">7) Security Manager</a></li><li><a href="jndi-resources-howto.html">8) JNDI Resources</a></li><li><a href="jndi-datasource-examples-howto.html">9) JDBC DataSources</a></li><li><a href="class-loader-howto.html">10) Classloading</a></li><li><a href="jasper-howto.html">11) JSPs</a></li><li><a href="ssl-howto.html">12) SSL/TLS</a></li><li><a href="ssi-howto.html">13) SSI</a></li><li><a href="cgi-howto.html">14) CGI</a></li><li><a href="proxy-howto.html">15) Proxy Support</a></li><li><a href="mbeans-descriptors-howto.html">16) MBeans Descriptors</a></li><li><a href="default-servlet.html">17) Default Servlet</a></li><li><a href="cluster-howto.html">18) Clustering</a></li><li><a href="balancer-howto.html">19) Load Balancer</a></li><li><a href="connectors.html">20) Connectors</a></li><li><a href="monitoring.html">21) Monitoring and Management</a></li><li><a href="logging.html">22) Logging</a></li><li><a href="apr.html">23) APR/Native</a></li><li><a href="virtual-hosting-howto.html">24) Virtual Hosting</a></li><li><a href="aio.html">25) Advanced IO</a></li><li><a href="extras.html">26) Additional Components</a></li><li><a href="maven-jars.html">27) Mavenized</a></li><li><a href="security-howto.html">28) Security Considerations</a></li><li><a href="windows-service-howto.html">29) Windows Service</a></li><li><a href="windows-auth-howto.html">30) Windows Authentication</a></li><li><a href="jdbc-pool.html">31) Tomcat's JDBC Pool</a></li><li><a href="web-socket-howto.html">32) WebSocket</a></li></ul><p><strong>Reference</strong></p><ul><li><a href="RELEASE-NOTES.txt">Release Notes</a></li><li><a href="config/index.html">Configuration</a></li><li><a href="api/index.html">Tomcat Javadocs</a></li><li><a href="servletapi/index.html">Servlet Javadocs</a></li><li><a href="jspapi/index.html">JSP 2.2 Javadocs</a></li><li><a href="elapi/index.html">EL 2.2 Javadocs</a></li><li><a href="websocketapi/index.html">WebSocket 1.1 Javadocs</a></li><li><a href="http://tomcat.apache.org/connectors-doc/">JK 1.2 Documentation</a></li></ul><p><strong>Apache Tomcat Development</strong></p><ul><li><a href="building.html">Building</a></li><li><a href="changelog.html">Changelog</a></li><li><a href="http://wiki.apache.org/tomcat/TomcatVersions">Status</a></li><li><a href="developers.html">Developers</a></li><li><a href="architecture/index.html">Architecture</a></li><li><a href="funcspecs/index.html">Functional Specs.</a></li><li><a href="tribes/introduction.html">Tribes</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Building Tomcat</h1><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote> | |
| <ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Download_Java_Development_Kit_(JDK)_versions_6_and_7">Download Java Development Kit (JDK) versions 6 and 7</a></li><li><a href="#Install_Apache_Ant_1.8.2_or_later">Install Apache Ant 1.8.2 or later</a></li><li><a href="#Checkout_or_obtain_the_source_code_for_Tomcat_7.0">Checkout or obtain the source code for Tomcat 7.0</a></li><li><a href="#Configure_download_area">Configure download area</a></li><li><a href="#Building_Tomcat">Building Tomcat</a></li><li><a href="#Building_with_Eclipse">Building with Eclipse</a></li><li><a href="#Building_with_other_IDEs">Building with other IDEs</a></li></ul> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| Building Apache Tomcat from source is very easy, and is the first step to | |
| contributing to Tomcat. The complete and comprehensive instructions are | |
| provided in the file <a href="BUILDING.txt">BUILDING.txt</a>. | |
| The following is a quick step by step guide. | |
| </p> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Download Java Development Kit (JDK) versions 6 and 7"><!--()--></a><a name="Download_Java_Development_Kit_(JDK)_versions_6_and_7"><strong>Download Java Development Kit (JDK) versions 6 and 7</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| Building Apache Tomcat requires a Java 6 JDK to be installed and optionally | |
| a Java 7 JDK installed in parallel with Java 6 one. The Java 7 JDK is only | |
| required if you wish to build Tomcat with JSR-356 (Java WebSocket 1.1) | |
| support. | |
| </p> | |
| <p> | |
| You can download JDKs from Oracle<br> | |
| <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">http://www.oracle.com/technetwork/java/javase/downloads/index.html</a><br> | |
| or from another JDK vendor. | |
| </p> | |
| <p> | |
| <b>IMPORTANT</b>: Set an environment variable JAVA_HOME to the pathname of | |
| the directory into which you installed the Java 6 JDK. The path to Java 7 | |
| JDK is configured in <code>build.properties</code> file (see below). | |
| </p> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Install Apache Ant 1.8.2 or later"><!--()--></a><a name="Install_Apache_Ant_1.8.2_or_later"><strong>Install Apache Ant 1.8.2 or later</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| Download a binary distribution of Ant 1.8.2 or later from | |
| <a href="http://ant.apache.org/bindownload.cgi">here</a>. | |
| </p> | |
| <p> | |
| Unpack the binary distribution into a convenient location so that the | |
| Ant release resides in its own directory (conventionally named | |
| <code>apache-ant-1.8.x</code>). For the remainder of this guide, | |
| the symbolic name <code>${ant.home}</code> is used to refer to the full pathname of | |
| the Ant installation directory. | |
| </p> | |
| <p> | |
| <b>IMPORTANT</b>: Create an ANT_HOME environment variable to point the directory <code>${ant.home}</code>, | |
| and modify the PATH environment variable to include directory | |
| <code>${ant.home}/bin</code> in its list. This makes the <code>ant</code> command line script | |
| available, which will be used to actually perform the build. | |
| </p> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Checkout or obtain the source code for Tomcat 7.0"><!--()--></a><a name="Checkout_or_obtain_the_source_code_for_Tomcat_7.0"><strong>Checkout or obtain the source code for Tomcat 7.0</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| Tomcat 7.0 SVN repository URL: | |
| <a href="http://svn.apache.org/repos/asf/tomcat/tc7.0.x/trunk/">http://svn.apache.org/repos/asf/tomcat/tc7.0.x/trunk/</a> | |
| </p> | |
| <p> | |
| Tomcat source packages: | |
| <a href="http://tomcat.apache.org/download-70.cgi">http://tomcat.apache.org/download-70.cgi</a>. | |
| </p> | |
| <p> | |
| Checkout the source using SVN, selecting a tag for released version or | |
| trunk for the current development code, or download and unpack a | |
| source package. For the remainder of this guide, the symbolic name | |
| <code>${tomcat.source}</code> is used to refer to the | |
| location where the source has been placed. | |
| </p> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Configure download area"><!--()--></a><a name="Configure_download_area"><strong>Configure download area</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| Building Tomcat involves downloading a number of libraries that it depends on. | |
| It is strongly recommended to configure download area for those libraries. | |
| </p> | |
| <p> | |
| By default the build is configured to download the dependencies into the | |
| <code>${user.home}/tomcat-build-libs</code> directory. You can change this | |
| (see below) but it must be an absolute path. | |
| </p> | |
| <p> | |
| The build is controlled by creating a | |
| <code>${tomcat.source}/build.properties</code> file. It can be used to | |
| redefine any property that is present in <code>build.properties.default</code> | |
| and <code>build.xml</code> files. The <code>build.properties</code> file | |
| does not exist by default. You have to create it. | |
| </p> | |
| <p> | |
| The download area is defined by property <code>base.path</code>. For example: | |
| </p> | |
| <div class="codeBox"><pre><code># ----- Default Base Path for Dependent Packages ----- | |
| # Replace this path with the directory path where | |
| # dependencies binaries should be downloaded. | |
| base.path=/home/me/some-place-to-download-to</code></pre></div> | |
| <p> | |
| Different versions of Tomcat are allowed to share the same download area. | |
| </p> | |
| <p> | |
| Another example: | |
| </p> | |
| <div class="codeBox"><pre><code>base.path=${user.dir}/../libraries-tomcat7.0</code></pre></div> | |
| <p> | |
| Users who access the Internet through a proxy must use the properties | |
| file to indicate to Ant the proxy configuration: | |
| </p> | |
| <div class="codeBox"><pre><code># ----- Proxy setup ----- | |
| proxy.host=proxy.domain | |
| proxy.port=8080 | |
| proxy.use=on</code></pre></div> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Building Tomcat"><!--()--></a><a name="Building_Tomcat"><strong>Building Tomcat</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| If you have installed a Java 7 JDK and wish to build Tomcat with JSR-356 | |
| (Java WebSocket 1.1) support, set <code>java.7.home</code> property in | |
| file <code>${tomcat.source}/build.properties</code> to the location of | |
| the Java 7 JDK installation. | |
| </p> | |
| <p> | |
| An example, using 32-bit JDK on a 64-bit Windows system: | |
| </p> | |
| <div class="codeBox"><pre><code># Location of Java 7 JDK | |
| java.7.home=C:/Program Files (x86)/Java/jdk1.7.0_72</code></pre></div> | |
| <p> | |
| Use the following commands to build Tomcat: | |
| </p> | |
| <p> | |
| <code>cd ${tomcat.source}</code><br> | |
| <code>ant</code> | |
| </p> | |
| <p> | |
| Once the build has completed successfully, a usable Tomcat installation will have been | |
| produced in the <code>${tomcat.source}/output/build</code> directory, and can be started | |
| and stopped with the usual scripts. | |
| </p> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Building with Eclipse"><!--()--></a><a name="Building_with_Eclipse"><strong>Building with Eclipse</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| <b>IMPORTANT:</b> 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. | |
| </p> | |
| <p> | |
| <b>NOTE:</b> 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. | |
| </p> | |
| <p> | |
| <b>WARNING:</b> Do not forget to create and configure | |
| <code>${tomcat.source}/build.properties</code> file as described above | |
| before running any Ant targets. | |
| </p> | |
| <p> | |
| Sample Eclipse project files and launch targets are provided in the | |
| <code>res/ide-support/eclipse</code> directory of the source tree. | |
| The instructions below will automatically copy these into the required locations. | |
| </p> | |
| <p> | |
| Two Ant targets are provided as a convenience. The first one, named | |
| <em>ide-eclipse</em>, downloads all binary dependencies and configures | |
| Eclipse project in the root of the source tree. The created Eclipse project | |
| targets a Java 6 JDK and skips WebSocket classes that cannot be compiled with | |
| Java 6. | |
| </p> | |
| <p> | |
| The second target, named <em>ide-eclipse-websocket</em>, creates directory | |
| <code>../tomcat-7.0.x-java7</code> and configures the second Eclipse project | |
| there. This project targets a Java 7 JDK. This project does not have its own | |
| source tree, but accesses a subset of the source tree of the first project, | |
| compiling all WebSocket classes that were skipped. | |
| </p> | |
| <p> | |
| <code>cd ${tomcat.source}</code><br> | |
| <code>ant ide-eclipse</code><br> | |
| <code>ant ide-eclipse-websocket</code> | |
| </p> | |
| <p> | |
| Start Eclipse and create a new Workspace. | |
| </p> | |
| <p> | |
| Open the <em>Preferences</em> dialog and then select <em>Java->Build Path->Classpath | |
| Variables</em> to add two new <em>Classpath Variables</em>: | |
| </p> | |
| <table class="defaultTable"> | |
| <tr><td>TOMCAT_LIBS_BASE</td><td>The same location as the <code>base.path</code> | |
| setting in <code>build.properties</code>, where the binary dependencies have been downloaded</td></tr> | |
| <tr><td>ANT_HOME</td><td>the base path of Ant 1.8.2 or later</td></tr> | |
| </table> | |
| <p> | |
| In the <em>Preferences</em> dialog go to <em>Java->Installed JREs</em> | |
| and add JDK 6 and JDK 7 there. Close the dialog. | |
| </p> | |
| <p> | |
| Use <em>File->Import</em> command from menu and choose <em>Existing Projects into Workspace</em>. | |
| From there choose the root directory of the Tomcat source tree (<code>${tomcat.source}</code>) | |
| and import the project located there. Import the second project as well, | |
| if you have created it (<code>../tomcat-7.0.x-java7</code>). | |
| </p> | |
| <p> | |
| <code>start-tomcat</code> and <code>stop-tomcat</code> launch configurations are provided in | |
| <code>res/ide-support/eclipse</code> and will be available in the <em>Run->Run Configurations</em> | |
| dialog. Use these to start and stop Tomcat from Eclipse. | |
| If you want to configure these yourself (or are using a different IDE) | |
| then use <code>org.apache.catalina.startup.Bootstrap</code> as the main class, | |
| <code>start</code>/<code>stop</code> etc. as program arguments, and specify <code>-Dcatalina.home=...</code> | |
| (with the name of your build directory) as VM arguments. | |
| </p> | |
| <p> | |
| Tweaking a few formatting preferences will make it much easier to keep consistent with Tomcat | |
| coding conventions (and have your contributions accepted): | |
| </p> | |
| <table class="defaultTable"> | |
| <tr><td>Java -> Code Style -> Formatter -> Edit...</td> | |
| <td>Tab policy: Spaces only<br>Tab and Indentation size: 4</td></tr> | |
| <tr><td>General -> Editors -> Text Editors</td> | |
| <td>Displayed tab width: 2<br>Insert spaces for tabs<br>Show whitespace characters (optional)</td></tr> | |
| <tr><td>XML -> XML Files -> Editor</td><td>Indent using spaces<br>Indentation size: 2</td></tr> | |
| <tr><td>Ant -> Editor -> Formatter</td><td>Tab size: 2<br>Use tab character instead of spaces: unchecked</td></tr> | |
| </table> | |
| <p> | |
| The recommended configuration of Compiler Warnings is documented in | |
| <code>res/ide-support/eclipse/java-compiler-errors-warnings.txt</code> file. | |
| </p> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Building with other IDEs"><!--()--></a><a name="Building_with_other_IDEs"><strong>Building with other IDEs</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| The same general approach should work for most IDEs; it has been reported | |
| to work in IntelliJ IDEA, for example. | |
| </p> | |
| </blockquote></td></tr></table></td></tr><tr class="noPrint"><td width="20%" valign="top" nowrap class="noPrint"></td><td width="80%" valign="top" align="left"><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="comments_section" id="comments_section"><strong>Comments</strong></a></font></td></tr><tr><td><blockquote><p class="notice"><strong>Notice: </strong>This comments section collects your suggestions | |
| on improving documentation for Apache Tomcat.<br><br> | |
| If you have trouble and need help, read | |
| <a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page | |
| and ask your question on the tomcat-users | |
| <a href="http://tomcat.apache.org/lists.html">mailing list</a>. | |
| Do not ask such questions here. This is not a Q&A section.<br><br> | |
| The Apache Comments System is explained <a href="./comments.html">here</a>. | |
| Comments may be removed by our moderators if they are either | |
| implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!-- | |
| var comments_shortname = 'tomcat'; | |
| var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/building.html'; | |
| (function(w, d) { | |
| if (w.location.hostname.toLowerCase() == "tomcat.apache.org") { | |
| d.write('<div id="comments_thread"><\/div>'); | |
| var s = d.createElement('script'); | |
| s.type = 'text/javascript'; | |
| s.async = true; | |
| s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; | |
| (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); | |
| } | |
| else { | |
| d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>'); | |
| } | |
| })(window, document); | |
| //--><!]]></script></blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em> | |
| Copyright © 1999-2017, Apache Software Foundation | |
| </em></font></div></td></tr></table></body></html> |