blob: ac9cf542c7bb2d2953e6366d498983778b166380 [file] [log] [blame]
刘洪青6266f992017-05-15 21:21:03 +08001<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.77) - Documentation Index</title><meta name="author" content="Craig R. McClanahan"><meta name="author" content="Remy Maucherat"><meta name="author" content="Yoav Shapira"><style type="text/css" media="print">
2 .noPrint {display: none;}
3 td#mainBody {width: 100%;}
4</style><style type="text/css">
5code {background-color:rgb(224,255,255);padding:0 0.1em;}
6code.attributeName, code.propertyName {background-color:transparent;}
7
8
9table {
10 border-collapse: collapse;
11 text-align: left;
12}
13table *:not(table) {
14 /* Prevent border-collapsing for table child elements like <div> */
15 border-collapse: separate;
16}
17
18th {
19 text-align: left;
20}
21
22
23div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code {
24 background-color: transparent;
25}
26div.codeBox {
27 overflow: auto;
28 margin: 1em 0;
29}
30div.codeBox pre {
31 margin: 0;
32 padding: 4px;
33 border: 1px solid #999;
34 border-radius: 5px;
35 background-color: #eff8ff;
36 display: table; /* To prevent <pre>s from taking the complete available width. */
37 /*
38 When it is officially supported, use the following CSS instead of display: table
39 to prevent big <pre>s from exceeding the browser window:
40 max-width: available;
41 width: min-content;
42 */
43}
44
45div.codeBox pre.wrap {
46 white-space: pre-wrap;
47}
48
49
50table.defaultTable tr, table.detail-table tr {
51 border: 1px solid #CCC;
52}
53
54table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) {
55 background-color: #FAFBFF;
56}
57
58table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) {
59 background-color: #EEEFFF;
60}
61
62table.defaultTable th, table.detail-table th {
63 background-color: #88b;
64 color: #fff;
65}
66
67table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td {
68 padding: 5px 8px;
69}
70
71
72p.notice {
73 border: 1px solid rgb(255, 0, 0);
74 background-color: rgb(238, 238, 238);
75 color: rgb(0, 51, 102);
76 padding: 0.5em;
77 margin: 1em 2em 1em 1em;
78}
79</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="
Hongqing Liufd5ee812014-05-10 16:32:51 +080080 The Apache Tomcat Servlet/JSP Container
刘洪青6266f992017-05-15 21:21:03 +080081 " 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>Documentation Index</h1><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>
Hongqing Liufd5ee812014-05-10 16:32:51 +080082
83<p>This is the top-level entry point of the documentation bundle for the
刘洪青6266f992017-05-15 21:21:03 +080084<strong>Apache Tomcat</strong> Servlet/JSP container. Apache Tomcat version 7.0
85implements the Servlet 3.0 and JavaServer Pages 2.2
86<a href="http://wiki.apache.org/tomcat/Specifications">specifications</a> from the
Hongqing Liufd5ee812014-05-10 16:32:51 +080087<a href="http://www.jcp.org">Java Community Process</a>, and includes many
88additional features that make it a useful platform for developing and deploying
89web applications and web services.</p>
90
91<p>Select one of the links from the navigation menu (to the left) to drill
92down to the more detailed documentation that is available. Each available
93manual is described in more detail below.</p>
94
95</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Apache Tomcat User Guide"><!--()--></a><a name="Apache_Tomcat_User_Guide"><strong>Apache Tomcat User Guide</strong></a></font></td></tr><tr><td><blockquote>
96
97<p>The following documents will assist you in downloading, installing
刘洪青6266f992017-05-15 21:21:03 +080098Apache Tomcat 7, and using many of the Apache Tomcat features.</p>
Hongqing Liufd5ee812014-05-10 16:32:51 +080099
100<ol>
101<li><a href="introduction.html"><strong>Introduction</strong></a> - A
102 brief, high level, overview of Apache Tomcat.</li>
103<li><a href="setup.html"><strong>Setup</strong></a> - How to install and run
104 Apache Tomcat on a variety of platforms.</li>
105<li><a href="appdev/index.html"><strong>First web application</strong></a>
106 - An introduction to the concepts of a <em>web application</em> as defined
刘洪青6266f992017-05-15 21:21:03 +0800107 in the Servlet Specification. Covers basic organization of your web application
Hongqing Liufd5ee812014-05-10 16:32:51 +0800108 source tree, the structure of a web application archive, and an
109 introduction to the web application deployment descriptor
110 (<code>/WEB-INF/web.xml</code>).</li>
111<li><a href="deployer-howto.html"><strong>Deployer</strong></a> -
112 Operating the Apache Tomcat Deployer to deploy, precompile, and validate web
113 applications.</li>
114<li><a href="manager-howto.html"><strong>Manager</strong></a> -
115 Operating the <strong>Manager</strong> web app to deploy, undeploy, and
116 redeploy applications while Apache Tomcat is running.</li>
117<li><a href="realm-howto.html"><strong>Realms and Access Control</strong></a>
118 - Description of how to configure <em>Realms</em> (databases of users,
119 passwords, and their associated roles) for use in web applications that
120 utilize <em>Container Managed Security</em>.</li>
121<li><a href="security-manager-howto.html"><strong>Security Manager</strong></a>
122 - Configuring and using a Java Security Manager to
123 support fine-grained control over the behavior of your web applications.
124 </li>
125<li><a href="jndi-resources-howto.html"><strong>JNDI Resources</strong></a>
126 - Configuring standard and custom resources in the JNDI naming context
127 that is provided to each web application.</li>
128<li><a href="jndi-datasource-examples-howto.html">
129 <strong>JDBC DataSource</strong></a>
刘洪青6266f992017-05-15 21:21:03 +0800130 - Configuring a JNDI DataSource with a DB connection pool.
Hongqing Liufd5ee812014-05-10 16:32:51 +0800131 Examples for many popular databases.</li>
132<li><a href="class-loader-howto.html"><strong>Classloading</strong></a>
刘洪青6266f992017-05-15 21:21:03 +0800133 - Information about class loading in Apache Tomcat, including where to place
Hongqing Liufd5ee812014-05-10 16:32:51 +0800134 your application classes so that they are visible.</li>
135<li><a href="jasper-howto.html"><strong>JSPs</strong></a>
136 - Information about Jasper configuration, as well as the JSP compiler
137 usage.</li>
刘洪青6266f992017-05-15 21:21:03 +0800138<li><a href="ssl-howto.html"><strong>SSL/TLS</strong></a> -
139 Installing and configuring SSL/TLS support so that your Apache Tomcat will
140 serve requests using the <code>https</code> protocol.</li>
Hongqing Liufd5ee812014-05-10 16:32:51 +0800141<li><a href="ssi-howto.html"><strong>SSI</strong></a> -
142 Using Server Side Includes in Apache Tomcat.</li>
143<li><a href="cgi-howto.html"><strong>CGI</strong></a> -
144 Using CGIs with Apache Tomcat.</li>
145<li><a href="proxy-howto.html"><strong>Proxy Support</strong></a> -
刘洪青6266f992017-05-15 21:21:03 +0800146 Configuring Apache Tomcat to run behind a proxy server (or a web server
Hongqing Liufd5ee812014-05-10 16:32:51 +0800147 functioning as a proxy server).</li>
刘洪青6266f992017-05-15 21:21:03 +0800148<li><a href="mbeans-descriptors-howto.html"><strong>MBeans Descriptors</strong></a> -
Hongqing Liufd5ee812014-05-10 16:32:51 +0800149 Configuring MBean descriptors files for custom components.</li>
150<li><a href="default-servlet.html"><strong>Default Servlet</strong></a> -
151 Configuring the default servlet and customizing directory listings.</li>
152<li><a href="cluster-howto.html"><strong>Apache Tomcat Clustering</strong></a> -
153 Enable session replication in a Apache Tomcat environment.</li>
154<li><a href="balancer-howto.html"><strong>Balancer</strong></a> -
155 Configuring, using, and extending the load balancer application.</li>
156<li><a href="connectors.html"><strong>Connectors</strong></a> -
157 Connectors available in Apache Tomcat, and native web server integration.</li>
158<li><a href="monitoring.html"><strong>Monitoring and Management</strong></a> -
159 Enabling JMX Remote support, and using tools to monitor and manage Apache Tomcat.</li>
160<li><a href="logging.html"><strong>Logging</strong></a> -
161 Configuring logging in Apache Tomcat.</li>
162<li><a href="apr.html"><strong>Apache Portable Runtime</strong></a> -
163 Using APR to provide superior performance, scalability and better
164 integration with native server technologies.</li>
165<li><a href="virtual-hosting-howto.html"><strong>Virtual Hosting</strong></a> -
166 Configuring virtual hosting in Apache Tomcat.</li>
167<li><a href="aio.html"><strong>Advanced IO</strong></a> -
168 Extensions available over regular, blocking IO.</li>
169<li><a href="extras.html"><strong>Additional Components</strong></a> -
170 Obtaining additional, optional components.</li>
刘洪青6266f992017-05-15 21:21:03 +0800171<li><a href="maven-jars.html"><strong>Using Tomcat libraries with Maven</strong></a> -
172 Obtaining Tomcat jars through Maven.</li>
173<li><a href="security-howto.html"><strong>Security Considerations</strong></a> -
174 Options to consider when securing an Apache Tomcat installation.</li>
175<li><a href="windows-service-howto.html"><strong>Windows Service</strong></a> -
176 Running Tomcat as a service on Microsoft Windows.</li>
177<li><a href="windows-auth-howto.html"><strong>Windows Authentication</strong></a> -
178 Configuring Tomcat to use integrated Windows authentication.</li>
179<li><a href="jdbc-pool.html"><strong>High Concurrency JDBC Pool</strong></a> -
180 Configuring Tomcat to use an alternative JDBC pool.</li>
181<li><a href="web-socket-howto.html"><strong>WebSocket support</strong></a> -
182 Developing WebSocket applications for Apache Tomcat.</li>
Hongqing Liufd5ee812014-05-10 16:32:51 +0800183
184</ol>
185
186</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Reference"><strong>Reference</strong></a></font></td></tr><tr><td><blockquote>
187
188<p>The following documents are aimed at <em>System Administrators</em> who
刘洪青6266f992017-05-15 21:21:03 +0800189are responsible for installing, configuring, and operating an Apache Tomcat server.
Hongqing Liufd5ee812014-05-10 16:32:51 +0800190</p>
191<ul>
192<li><a href="RELEASE-NOTES.txt"><strong>Release notes</strong></a>
193 - Known issues in this Apache Tomcat release.
194 </li>
195<li><a href="config/index.html"><strong>Apache Tomcat Server Configuration Reference</strong></a>
196 - Reference manual that documents all available elements and attributes
刘洪青6266f992017-05-15 21:21:03 +0800197 that may be placed into the Apache Tomcat <code>conf/server.xml</code> file.
Hongqing Liufd5ee812014-05-10 16:32:51 +0800198 </li>
199<li><a href="http://tomcat.apache.org/connectors-doc/index.html"><strong>JK Documentation</strong></a>
200 - Complete documentation and HOWTOs on the JK native webserver connector,
201 used to interface Apache Tomcat with servers like Apache HTTPd, IIS
202 and others.</li>
刘洪青6266f992017-05-15 21:21:03 +0800203<li>Servlet 3.0
204 <a href="http://jcp.org/aboutJava/communityprocess/final/jsr315/index.html">
205 <strong>Specification</strong></a> and
206 <a href="http://docs.oracle.com/javaee/6/api/index.html?javax/servlet/package-summary.html">
207 <strong>Javadoc</strong></a>
208 </li>
209<li>JSP 2.2 and EL 2.2
210 <a href="http://jcp.org/aboutJava/communityprocess/mrel/jsr245/index.html">
211 <strong>Specifications</strong></a>, JSP 2.2
212 <a href="http://docs.oracle.com/javaee/6/api/index.html?javax/servlet/jsp/package-summary.html">
213 <strong>Javadoc (note it is labelled as JSP 2.1)</strong></a>, EL 2.2
214 <a href="http://docs.oracle.com/javaee/6/api/index.html?javax/el/package-summary.html">
215 <strong>Javadoc</strong></a>
216 </li>
217<li>WebSocket 1.1
218 <a href="https://jcp.org/aboutJava/communityprocess/mrel/jsr356/index.html">
219 <strong>Specification</strong></a> and
220 <a href="http://docs.oracle.com/javaee/7/api/javax/websocket/package-summary.html">
221 <strong>Javadoc</strong></a>
222 </li>
Hongqing Liufd5ee812014-05-10 16:32:51 +0800223</ul>
224
225</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Apache Tomcat Developers"><!--()--></a><a name="Apache_Tomcat_Developers"><strong>Apache Tomcat Developers</strong></a></font></td></tr><tr><td><blockquote>
226
227<p>The following documents are for Java developers who wish to contribute to
228the development of the <em>Apache Tomcat</em> project.</p>
229<ul>
230<li><a href="building.html"><strong>Building from Source</strong></a> -
刘洪青6266f992017-05-15 21:21:03 +0800231 Details the steps necessary to download Apache Tomcat source code (and the
Hongqing Liufd5ee812014-05-10 16:32:51 +0800232 other packages that it depends on), and build a binary distribution from
233 those sources.
234 </li>
235<li><a href="changelog.html"><strong>Changelog</strong></a> - Details the
236 changes made to Apache Tomcat.
237 </li>
238<li><a href="http://wiki.apache.org/tomcat/TomcatVersions"><strong>Status</strong></a> -
239 Apache Tomcat development status.
240 </li>
241<li><a href="developers.html"><strong>Developers</strong></a> - List of active
242 Apache Tomcat contributors.
243 </li>
244<li><a href="funcspecs/index.html"><strong>Functional Specifications</strong></a>
245 - Requirements specifications for features of the <em>Catalina</em> servlet
刘洪青6266f992017-05-15 21:21:03 +0800246 container portion of Apache Tomcat.</li>
Hongqing Liufd5ee812014-05-10 16:32:51 +0800247<li><a href="api/index.html"><strong>Javadocs</strong></a>
248 - Javadoc API documentation for Apache Tomcat's internals.</li>
249<li><a href="architecture/index.html"><strong>Apache Tomcat Architecture</strong></a>
250 - Documentation of the Apache Tomcat Server Architecture.</li>
251</ul>
252
刘洪青6266f992017-05-15 21:21:03 +0800253</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
254 on improving documentation for Apache Tomcat.<br><br>
255 If you have trouble and need help, read
256 <a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page
257 and ask your question on the tomcat-users
258 <a href="http://tomcat.apache.org/lists.html">mailing list</a>.
259 Do not ask such questions here. This is not a Q&amp;A section.<br><br>
260 The Apache Comments System is explained <a href="./comments.html">here</a>.
261 Comments may be removed by our moderators if they are either
262 implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
263 var comments_shortname = 'tomcat';
264 var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/index.html';
265 (function(w, d) {
266 if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {
267 d.write('<div id="comments_thread"><\/div>');
268 var s = d.createElement('script');
269 s.type = 'text/javascript';
270 s.async = true;
271 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
272 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
273 }
274 else {
275 d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>');
276 }
277 })(window, document);
278 //--><!]]></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>
279 Copyright &copy; 1999-2017, Apache Software Foundation
Hongqing Liufd5ee812014-05-10 16:32:51 +0800280 </em></font></div></td></tr></table></body></html>