Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 771 | blopes | 1 | <!DOCTYPE html SYSTEM "about:legacy-compat"> |
| 2 | <html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><link href="./images/docs-stylesheet.css" rel="stylesheet" type="text/css"><title>Apache Tomcat 9 (9.0.112) - Documentation Index</title></head><body><div id="wrapper"><header><div id="header"><div><div><div class="logo noPrint"><a href="https://tomcat.apache.org/"><img alt="Tomcat Home" src="./images/tomcat.png"></a></div><div style="height: 1px;"></div><div class="asfLogo noPrint"><a href="https://www.apache.org/" target="_blank"><img src="./images/asf-logo.svg" alt="The Apache Software Foundation" style="width: 266px; height: 83px;"></a></div><h1>Apache Tomcat 9</h1><div class="versionInfo"> |
||
| 3 | Version 9.0.112, |
||
| 4 | <time datetime="2025-11-06">Nov 6 2025</time></div><div style="height: 1px;"></div><div style="clear: left;"></div></div></div></div></header><div id="middle"><div><div id="mainLeft" class="noprint"><div><nav><div><h2>Links</h2><ul><li><a href="index.html">Docs Home</a></li><li><a href="https://cwiki.apache.org/confluence/display/TOMCAT/FAQ">FAQ</a></li></ul></div><div><h2>User Guide</h2><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="host-manager-howto.html">6) Host Manager</a></li><li><a href="realm-howto.html">7) Realms and AAA</a></li><li><a href="security-manager-howto.html">8) Security Manager</a></li><li><a href="jndi-resources-howto.html">9) JNDI Resources</a></li><li><a href="jndi-datasource-examples-howto.html">10) JDBC DataSources</a></li><li><a href="class-loader-howto.html">11) Classloading</a></li><li><a href="jasper-howto.html">12) JSPs</a></li><li><a href="ssl-howto.html">13) SSL/TLS</a></li><li><a href="ssi-howto.html">14) SSI</a></li><li><a href="cgi-howto.html">15) CGI</a></li><li><a href="proxy-howto.html">16) Proxy Support</a></li><li><a href="mbeans-descriptors-howto.html">17) MBeans Descriptors</a></li><li><a href="default-servlet.html">18) Default Servlet</a></li><li><a href="cluster-howto.html">19) Clustering</a></li><li><a href="balancer-howto.html">20) Load Balancer</a></li><li><a href="connectors.html">21) Connectors</a></li><li><a href="monitoring.html">22) Monitoring and Management</a></li><li><a href="logging.html">23) Logging</a></li><li><a href="apr.html">24) APR/Native</a></li><li><a href="virtual-hosting-howto.html">25) Virtual Hosting</a></li><li><a href="aio.html">26) Advanced IO</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><li><a href="rewrite.html">33) Rewrite</a></li><li><a href="cdi.html">34) CDI 2 and JAX-RS</a></li><li><a href="graal.html">35) AOT/GraalVM Support</a></li></ul></div><div><h2>Reference</h2><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 4.0 Javadocs</a></li><li><a href="jspapi/index.html">JSP 2.3 Javadocs</a></li><li><a href="elapi/index.html">EL 3.0 Javadocs</a></li><li><a href="websocketapi/index.html">WebSocket 1.1 Javadocs</a></li><li><a href="jaspicapi/index.html">JASPIC 1.1 Javadocs</a></li><li><a href="annotationapi/index.html">Common Annotations 1.3 Javadocs</a></li><li><a href="https://tomcat.apache.org/connectors-doc/">JK 1.2 Documentation</a></li></ul></div><div><h2>Apache Tomcat Development</h2><ul><li><a href="building.html">Building</a></li><li><a href="changelog.html">Changelog</a></li><li><a href="https://cwiki.apache.org/confluence/display/TOMCAT/Tomcat+Versions">Status</a></li><li><a href="developers.html">Developers</a></li><li><a href="architecture/index.html">Architecture</a></li><li><a href="tribes/introduction.html">Tribes</a></li></ul></div></nav></div></div><div id="mainRight"><div id="content"><h2>Documentation Index</h2><h3 id="Introduction">Introduction</h3><div class="text"> |
||
| 5 | |||
| 6 | <p>This is the top-level entry point of the documentation bundle for the |
||
| 7 | <strong>Apache Tomcat</strong> Servlet/JSP container. Apache Tomcat version |
||
| 8 | 9.0 implements the Servlet 4.0 and JavaServer Pages 2.3 |
||
| 9 | <a href="https://cwiki.apache.org/confluence/display/TOMCAT/Specifications">specifications</a> from the |
||
| 10 | <a href="https://www.jcp.org">Java Community Process</a>, and includes many |
||
| 11 | additional features that make it a useful platform for developing and deploying |
||
| 12 | web applications and web services.</p> |
||
| 13 | |||
| 14 | <p>Select one of the links from the navigation menu (to the left) to drill |
||
| 15 | down to the more detailed documentation that is available. Each available |
||
| 16 | manual is described in more detail below.</p> |
||
| 17 | |||
| 18 | </div><h3 id="Apache_Tomcat_User_Guide">Apache Tomcat User Guide</h3><div class="text"> |
||
| 19 | |||
| 20 | <p>The following documents will assist you in downloading and installing |
||
| 21 | Apache Tomcat, and using many of the Apache Tomcat features.</p> |
||
| 22 | |||
| 23 | <ol> |
||
| 24 | <li><a href="introduction.html"><strong>Introduction</strong></a> - A |
||
| 25 | brief, high level, overview of Apache Tomcat.</li> |
||
| 26 | <li><a href="setup.html"><strong>Setup</strong></a> - How to install and run |
||
| 27 | Apache Tomcat on a variety of platforms.</li> |
||
| 28 | <li><a href="appdev/index.html"><strong>First web application</strong></a> |
||
| 29 | - An introduction to the concepts of a <em>web application</em> as defined |
||
| 30 | in the Servlet Specification. Covers basic organization of your web application |
||
| 31 | source tree, the structure of a web application archive, and an |
||
| 32 | introduction to the web application deployment descriptor |
||
| 33 | (<code>/WEB-INF/web.xml</code>).</li> |
||
| 34 | <li><a href="deployer-howto.html"><strong>Deployer</strong></a> - |
||
| 35 | Operating the Apache Tomcat Deployer to deploy, precompile, and validate web |
||
| 36 | applications.</li> |
||
| 37 | <li><a href="manager-howto.html"><strong>Manager</strong></a> - |
||
| 38 | Operating the <strong>Manager</strong> web app to deploy, undeploy, and |
||
| 39 | redeploy applications while Apache Tomcat is running.</li> |
||
| 40 | <li><a href="host-manager-howto.html"><strong>Host Manager</strong></a> - |
||
| 41 | Operating the <strong>Host Manager</strong> web app to add and remove |
||
| 42 | virtual hosts while Apache Tomcat is running.</li> |
||
| 43 | <li><a href="realm-howto.html"><strong>Realms and Access Control</strong></a> |
||
| 44 | - Description of how to configure <em>Realms</em> (databases of users, |
||
| 45 | passwords, and their associated roles) for use in web applications that |
||
| 46 | utilize <em>Container Managed Security</em>.</li> |
||
| 47 | <li><a href="security-manager-howto.html"><strong>Security Manager</strong></a> |
||
| 48 | - Configuring and using a Java Security Manager to |
||
| 49 | support fine-grained control over the behavior of your web applications. |
||
| 50 | </li> |
||
| 51 | <li><a href="jndi-resources-howto.html"><strong>JNDI Resources</strong></a> |
||
| 52 | - Configuring standard and custom resources in the JNDI naming context |
||
| 53 | that is provided to each web application.</li> |
||
| 54 | <li><a href="jndi-datasource-examples-howto.html"> |
||
| 55 | <strong>JDBC DataSource</strong></a> |
||
| 56 | - Configuring a JNDI DataSource with a DB connection pool. |
||
| 57 | Examples for many popular databases.</li> |
||
| 58 | <li><a href="class-loader-howto.html"><strong>Classloading</strong></a> |
||
| 59 | - Information about class loading in Apache Tomcat, including where to place |
||
| 60 | your application classes so that they are visible.</li> |
||
| 61 | <li><a href="jasper-howto.html"><strong>JSPs</strong></a> |
||
| 62 | - Information about Jasper configuration, as well as the JSP compiler |
||
| 63 | usage.</li> |
||
| 64 | <li><a href="ssl-howto.html"><strong>SSL/TLS</strong></a> - |
||
| 65 | Installing and configuring SSL/TLS support so that your Apache Tomcat will |
||
| 66 | serve requests using the <code>https</code> protocol.</li> |
||
| 67 | <li><a href="ssi-howto.html"><strong>SSI</strong></a> - |
||
| 68 | Using Server Side Includes in Apache Tomcat.</li> |
||
| 69 | <li><a href="cgi-howto.html"><strong>CGI</strong></a> - |
||
| 70 | Using CGIs with Apache Tomcat.</li> |
||
| 71 | <li><a href="proxy-howto.html"><strong>Proxy Support</strong></a> - |
||
| 72 | Configuring Apache Tomcat to run behind a proxy server (or a web server |
||
| 73 | functioning as a proxy server).</li> |
||
| 74 | <li><a href="mbeans-descriptors-howto.html"><strong>MBeans Descriptors</strong></a> - |
||
| 75 | Configuring MBean descriptors files for custom components.</li> |
||
| 76 | <li><a href="default-servlet.html"><strong>Default Servlet</strong></a> - |
||
| 77 | Configuring the default servlet and customizing directory listings.</li> |
||
| 78 | <li><a href="cluster-howto.html"><strong>Apache Tomcat Clustering</strong></a> - |
||
| 79 | Enable session replication in a Apache Tomcat environment.</li> |
||
| 80 | <li><a href="balancer-howto.html"><strong>Balancer</strong></a> - |
||
| 81 | Configuring, using, and extending the load balancer application.</li> |
||
| 82 | <li><a href="connectors.html"><strong>Connectors</strong></a> - |
||
| 83 | Connectors available in Apache Tomcat, and native web server integration.</li> |
||
| 84 | <li><a href="monitoring.html"><strong>Monitoring and Management</strong></a> - |
||
| 85 | Enabling JMX Remote support, and using tools to monitor and manage Apache Tomcat.</li> |
||
| 86 | <li><a href="logging.html"><strong>Logging</strong></a> - |
||
| 87 | Configuring logging in Apache Tomcat.</li> |
||
| 88 | <li><a href="apr.html"><strong>Apache Portable Runtime</strong></a> - |
||
| 89 | Using APR to provide superior performance, scalability and better |
||
| 90 | integration with native server technologies.</li> |
||
| 91 | <li><a href="virtual-hosting-howto.html"><strong>Virtual Hosting</strong></a> - |
||
| 92 | Configuring virtual hosting in Apache Tomcat.</li> |
||
| 93 | <li><a href="aio.html"><strong>Advanced IO</strong></a> - |
||
| 94 | Extensions available over regular, blocking IO.</li> |
||
| 95 | <li><a href="maven-jars.html"><strong>Using Tomcat libraries with Maven</strong></a> - |
||
| 96 | Obtaining Tomcat jars through Maven.</li> |
||
| 97 | <li><a href="security-howto.html"><strong>Security Considerations</strong></a> - |
||
| 98 | Options to consider when securing an Apache Tomcat installation.</li> |
||
| 99 | <li><a href="windows-service-howto.html"><strong>Windows Service</strong></a> - |
||
| 100 | Running Tomcat as a service on Microsoft Windows.</li> |
||
| 101 | <li><a href="windows-auth-howto.html"><strong>Windows Authentication</strong></a> - |
||
| 102 | Configuring Tomcat to use integrated Windows authentication.</li> |
||
| 103 | <li><a href="jdbc-pool.html"><strong>High Concurrency JDBC Pool</strong></a> - |
||
| 104 | Configuring Tomcat to use an alternative JDBC pool.</li> |
||
| 105 | <li><a href="web-socket-howto.html"><strong>WebSocket support</strong></a> - |
||
| 106 | Developing WebSocket applications for Apache Tomcat.</li> |
||
| 107 | <li><a href="rewrite.html"><strong>URL rewrite</strong></a> - |
||
| 108 | Using the regexp based rewrite valve for conditional URL and host rewrite.</li> |
||
| 109 | <li><a href="cdi.html"><strong>CDI and JAX-RS support</strong></a> - |
||
| 110 | Configuring CDI,JAX-RS and Eclipse Microprofile support.</li> |
||
| 111 | <li><a href="graal.html"><strong>AOT compilation support</strong></a> - |
||
| 112 | Ahead of Time compilation support with GraalVM/Native Image.</li> |
||
| 113 | </ol> |
||
| 114 | |||
| 115 | </div><h3 id="Reference">Reference</h3><div class="text"> |
||
| 116 | |||
| 117 | <p>The following documents are aimed at <em>System Administrators</em> who |
||
| 118 | are responsible for installing, configuring, and operating an Apache Tomcat server. |
||
| 119 | </p> |
||
| 120 | <ul> |
||
| 121 | <li><a href="RELEASE-NOTES.txt"><strong>Release notes</strong></a> |
||
| 122 | - Known issues in this Apache Tomcat release. |
||
| 123 | </li> |
||
| 124 | <li><a href="config/index.html"><strong>Apache Tomcat Server Configuration Reference</strong></a> |
||
| 125 | - Reference manual that documents all available elements and attributes |
||
| 126 | that may be placed into the Apache Tomcat <code>conf/server.xml</code> file. |
||
| 127 | </li> |
||
| 128 | <li><a href="https://tomcat.apache.org/connectors-doc/index.html"><strong>JK Documentation</strong></a> |
||
| 129 | - Complete documentation and HOWTOs on the JK native webserver connector, |
||
| 130 | used to interface Apache Tomcat with servers like Apache HTTPd, IIS |
||
| 131 | and others.</li> |
||
| 132 | <li>Servlet 4.0 |
||
| 133 | <a href="https://jcp.org/aboutJava/communityprocess/final/jsr369/index.html"> |
||
| 134 | <strong>Specification</strong></a> and |
||
| 135 | <a href="https://javaee.github.io/javaee-spec/javadocs/javax/servlet/package-summary.html"> |
||
| 136 | <strong>Javadoc</strong></a> |
||
| 137 | </li> |
||
| 138 | <li>JSP 2.3 |
||
| 139 | <a href="https://jcp.org/aboutJava/communityprocess/mrel/jsr245/index2.html"> |
||
| 140 | <strong>Specification</strong></a> and |
||
| 141 | <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/jsp/package-summary.html"> |
||
| 142 | <strong>Javadoc</strong></a> |
||
| 143 | </li> |
||
| 144 | <li>EL 3.0 |
||
| 145 | <a href="https://jcp.org/aboutJava/communityprocess/final/jsr341/index.html"> |
||
| 146 | <strong>Specification</strong></a> and |
||
| 147 | <a href="http://docs.oracle.com/javaee/7/api/javax/el/package-summary.html"> |
||
| 148 | <strong>Javadoc</strong></a> |
||
| 149 | </li> |
||
| 150 | <li>WebSocket 1.1 |
||
| 151 | <a href="https://jcp.org/aboutJava/communityprocess/mrel/jsr356/index.html"> |
||
| 152 | <strong>Specification</strong></a> and |
||
| 153 | <a href="http://docs.oracle.com/javaee/7/api/javax/websocket/package-summary.html"> |
||
| 154 | <strong>Javadoc</strong></a> |
||
| 155 | </li> |
||
| 156 | <li>JASPIC 1.1 |
||
| 157 | <a href="https://jcp.org/aboutJava/communityprocess/mrel/jsr196/index.html"> |
||
| 158 | <strong>Specification</strong></a> and |
||
| 159 | <a href="http://docs.oracle.com/javaee/7/api/javax/security/auth/message/package-summary.html"> |
||
| 160 | <strong>Javadoc</strong></a> |
||
| 161 | </li> |
||
| 162 | </ul> |
||
| 163 | |||
| 164 | </div><h3 id="Apache_Tomcat_Developers">Apache Tomcat Developers</h3><div class="text"> |
||
| 165 | |||
| 166 | <p>The following documents are for Java developers who wish to contribute to |
||
| 167 | the development of the <em>Apache Tomcat</em> project.</p> |
||
| 168 | <ul> |
||
| 169 | <li><a href="building.html"><strong>Building from Source</strong></a> - |
||
| 170 | Details the steps necessary to download Apache Tomcat source code (and the |
||
| 171 | other packages that it depends on), and build a binary distribution from |
||
| 172 | those sources. |
||
| 173 | </li> |
||
| 174 | <li><a href="changelog.html"><strong>Changelog</strong></a> - Details the |
||
| 175 | changes made to Apache Tomcat. |
||
| 176 | </li> |
||
| 177 | <li><a href="https://wiki.apache.org/tomcat/TomcatVersions"><strong>Status</strong></a> - |
||
| 178 | Apache Tomcat development status. |
||
| 179 | </li> |
||
| 180 | <li><a href="developers.html"><strong>Developers</strong></a> - List of active |
||
| 181 | Apache Tomcat contributors. |
||
| 182 | </li> |
||
| 183 | <li><a href="api/index.html"><strong>Javadocs</strong></a> |
||
| 184 | - Javadoc API documentation for Apache Tomcat's internals.</li> |
||
| 185 | <li><a href="architecture/index.html"><strong>Apache Tomcat Architecture</strong></a> |
||
| 186 | - Documentation of the Apache Tomcat Server Architecture.</li> |
||
| 187 | </ul> |
||
| 188 | |||
| 189 | </div></div></div></div></div><footer><div id="footer"> |
||
| 190 | Copyright © 1999-2025, The Apache Software Foundation |
||
| 191 | <br> |
||
| 192 | Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo |
||
| 193 | are either registered trademarks or trademarks of the Apache Software |
||
| 194 | Foundation. |
||
| 195 | </div></footer></div></body></html> |