blob: a46e0f01aac6138b9249e1eedd6cfc15163b981a [file] [log] [blame]
Cheng Tang07b30872014-04-27 16:37:18 +08001<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.42) - 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">
5 code {background-color:rgb(224,255,255);padding:0 0.1em;}
6 code.attributeName, code.propertyName {background-color:transparent;}
7 </style><style type="text/css">
8 .wrapped-source code { display: block; background-color: transparent; }
9 .wrapped-source div { margin: 0 0 0 1.25em; }
10 .wrapped-source p { margin: 0 0 0 1.25em; text-indent: -1.25em; }
11 </style><style type="text/css">
12 p.notice {
13 border: 1px solid rgb(255, 0, 0);
14 background-color: rgb(238, 238, 238);
15 color: rgb(0, 51, 102);
16 padding: 0.5em;
17 margin: 1em 2em 1em 1em;
18 }
19 </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="
20 The Apache Tomcat Servlet/JSP Container
21 " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 7</font></h1><font face="arial,helvetica,sanserif">Version 7.0.42, Jul 2 2013</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="./images/asf-logo.gif" align="right" alt="Apache Logo" border="0"></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</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-descriptor-howto.html">16) MBean Descriptor</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="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>
22
23<p>This is the top-level entry point of the documentation bundle for the
24<strong>Apache Tomcat</strong> Servlet/JSP container. Apache Tomcat version 7.0
25implements the Servlet 3.0 and JavaServer Pages 2.2
26<a href="http://wiki.apache.org/tomcat/Specifications">specifications</a> from the
27<a href="http://www.jcp.org">Java Community Process</a>, and includes many
28additional features that make it a useful platform for developing and deploying
29web applications and web services.</p>
30
31<p>Select one of the links from the navigation menu (to the left) to drill
32down to the more detailed documentation that is available. Each available
33manual is described in more detail below.</p>
34
35</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>
36
37<p>The following documents will assist you in downloading, installing
38Apache Tomcat 7, and using many of the Apache Tomcat features.</p>
39
40<ol>
41<li><a href="introduction.html"><strong>Introduction</strong></a> - A
42 brief, high level, overview of Apache Tomcat.</li>
43<li><a href="setup.html"><strong>Setup</strong></a> - How to install and run
44 Apache Tomcat on a variety of platforms.</li>
45<li><a href="appdev/index.html"><strong>First web application</strong></a>
46 - An introduction to the concepts of a <em>web application</em> as defined
47 in the Servlet Specification. Covers basic organization of your web application
48 source tree, the structure of a web application archive, and an
49 introduction to the web application deployment descriptor
50 (<code>/WEB-INF/web.xml</code>).</li>
51<li><a href="deployer-howto.html"><strong>Deployer</strong></a> -
52 Operating the Apache Tomcat Deployer to deploy, precompile, and validate web
53 applications.</li>
54<li><a href="manager-howto.html"><strong>Manager</strong></a> -
55 Operating the <strong>Manager</strong> web app to deploy, undeploy, and
56 redeploy applications while Apache Tomcat is running.</li>
57<li><a href="realm-howto.html"><strong>Realms and Access Control</strong></a>
58 - Description of how to configure <em>Realms</em> (databases of users,
59 passwords, and their associated roles) for use in web applications that
60 utilize <em>Container Managed Security</em>.</li>
61<li><a href="security-manager-howto.html"><strong>Security Manager</strong></a>
62 - Configuring and using a Java Security Manager to
63 support fine-grained control over the behavior of your web applications.
64 </li>
65<li><a href="jndi-resources-howto.html"><strong>JNDI Resources</strong></a>
66 - Configuring standard and custom resources in the JNDI naming context
67 that is provided to each web application.</li>
68<li><a href="jndi-datasource-examples-howto.html">
69 <strong>JDBC DataSource</strong></a>
70 - Configuring a JNDI DataSoure with a DB connection pool.
71 Examples for many popular databases.</li>
72<li><a href="class-loader-howto.html"><strong>Classloading</strong></a>
73 - Information about class loading in Apache Tomcat, including where to place
74 your application classes so that they are visible.</li>
75<li><a href="jasper-howto.html"><strong>JSPs</strong></a>
76 - Information about Jasper configuration, as well as the JSP compiler
77 usage.</li>
78<li><a href="ssl-howto.html"><strong>SSL</strong></a> -
79 Installing and
80 configuring SSL support so that your Apache Tomcat will serve requests using
81 the <code>https</code> protocol.</li>
82<li><a href="ssi-howto.html"><strong>SSI</strong></a> -
83 Using Server Side Includes in Apache Tomcat.</li>
84<li><a href="cgi-howto.html"><strong>CGI</strong></a> -
85 Using CGIs with Apache Tomcat.</li>
86<li><a href="proxy-howto.html"><strong>Proxy Support</strong></a> -
87 Configuring Apache Tomcat to run behind a proxy server (or a web server
88 functioning as a proxy server).</li>
89<li><a href="mbeans-descriptor-howto.html"><strong>MBean Descriptor</strong></a> -
90 Configuring MBean descriptors files for custom components.</li>
91<li><a href="default-servlet.html"><strong>Default Servlet</strong></a> -
92 Configuring the default servlet and customizing directory listings.</li>
93<li><a href="cluster-howto.html"><strong>Apache Tomcat Clustering</strong></a> -
94 Enable session replication in a Apache Tomcat environment.</li>
95<li><a href="balancer-howto.html"><strong>Balancer</strong></a> -
96 Configuring, using, and extending the load balancer application.</li>
97<li><a href="connectors.html"><strong>Connectors</strong></a> -
98 Connectors available in Apache Tomcat, and native web server integration.</li>
99<li><a href="monitoring.html"><strong>Monitoring and Management</strong></a> -
100 Enabling JMX Remote support, and using tools to monitor and manage Apache Tomcat.</li>
101<li><a href="logging.html"><strong>Logging</strong></a> -
102 Configuring logging in Apache Tomcat.</li>
103<li><a href="apr.html"><strong>Apache Portable Runtime</strong></a> -
104 Using APR to provide superior performance, scalability and better
105 integration with native server technologies.</li>
106<li><a href="virtual-hosting-howto.html"><strong>Virtual Hosting</strong></a> -
107 Configuring virtual hosting in Apache Tomcat.</li>
108<li><a href="aio.html"><strong>Advanced IO</strong></a> -
109 Extensions available over regular, blocking IO.</li>
110<li><a href="extras.html"><strong>Additional Components</strong></a> -
111 Obtaining additional, optional components.</li>
112<li><a href="maven-jars.html"><strong>Using Tomcat libraries with Maven</strong></a> -
113 Obtaining Tomcat jars through Maven.</li>
114<li><a href="security-howto.html"><strong>Security Considerations</strong></a> -
115 Options to consider when securing an Apache Tomcat installation.</li>
116<li><a href="windows-service-howto.html"><strong>Windows Service</strong></a> -
117 Running Tomcat as a service on Microsoft Windows.</li>
118<li><a href="windows-auth-howto.html"><strong>Windows Authentication</strong></a> -
119 Configuring Tomcat to use integrated Windows authentication.</li>
120<li><a href="jdbc-pool.html"><strong>High Concurrency JDBC Pool</strong></a> -
121 Configuring Tomcat to use an alternative JDBC pool.</li>
122<li><a href="web-socket-howto.html"><strong>WebSocket support</strong></a> -
123 Developing WebSocket applications for Apache Tomcat.</li>
124
125</ol>
126
127</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>
128
129<p>The following documents are aimed at <em>System Administrators</em> who
130are responsible for installing, configuring, and operating an Apache Tomcat server.
131</p>
132<ul>
133<li><a href="RELEASE-NOTES.txt"><strong>Release notes</strong></a>
134 - Known issues in this Apache Tomcat release.
135 </li>
136<li><a href="config/index.html"><strong>Apache Tomcat Server Configuration Reference</strong></a>
137 - Reference manual that documents all available elements and attributes
138 that may be placed into the Apache Tomcat <code>conf/server.xml</code> file.
139 </li>
140<li><a href="http://tomcat.apache.org/connectors-doc/index.html"><strong>JK Documentation</strong></a>
141 - Complete documentation and HOWTOs on the JK native webserver connector,
142 used to interface Apache Tomcat with servers like Apache HTTPd, IIS
143 and others.</li>
144<li>Servlet 3.0
145 <a href="http://jcp.org/aboutJava/communityprocess/final/jsr315/index.html">
146 <strong>Specification</strong></a> and
147 <a href="http://docs.oracle.com/javaee/6/api/index.html?javax/servlet/package-summary.html">
148 <strong>Javadoc</strong></a>
149 </li>
150<li><a href="http://jcp.org/aboutJava/communityprocess/mrel/jsr245/index.html">
151 <strong>JSP 2.2 and EL 2.2 Specifications</strong></a>,
152 <a href="http://docs.oracle.com/javaee/6/api/index.html?javax/servlet/jsp/package-summary.html">
153 <strong>JSP 2.2 Javadoc (note it is labelled as JSP 2.1)</strong></a>,
154 <a href="http://docs.oracle.com/javaee/6/api/index.html?javax/el/package-summary.html">
155 <strong>EL 2.2 Javadoc</strong></a>
156 </li>
157</ul>
158
159</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>
160
161<p>The following documents are for Java developers who wish to contribute to
162the development of the <em>Apache Tomcat</em> project.</p>
163<ul>
164<li><a href="building.html"><strong>Building from Source</strong></a> -
165 Details the steps necessary to download Apache Tomcat source code (and the
166 other packages that it depends on), and build a binary distribution from
167 those sources.
168 </li>
169<li><a href="changelog.html"><strong>Changelog</strong></a> - Details the
170 changes made to Apache Tomcat.
171 </li>
172<li><a href="http://wiki.apache.org/tomcat/TomcatVersions"><strong>Status</strong></a> -
173 Apache Tomcat development status.
174 </li>
175<li><a href="developers.html"><strong>Developers</strong></a> - List of active
176 Apache Tomcat contributors.
177 </li>
178<li><a href="funcspecs/index.html"><strong>Functional Specifications</strong></a>
179 - Requirements specifications for features of the <em>Catalina</em> servlet
180 container portion of Apache Tomcat.</li>
181<li><a href="api/index.html"><strong>Javadocs</strong></a>
182 - Javadoc API documentation for Apache Tomcat's internals.</li>
183<li><a href="architecture/index.html"><strong>Apache Tomcat Architecture</strong></a>
184 - Documentation of the Apache Tomcat Server Architecture.</li>
185</ul>
186
187</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
188 on improving documentation for Apache Tomcat.<br><br>
189 If you have trouble and need help, read
190 <a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page
191 and ask your question on the tomcat-users
192 <a href="http://tomcat.apache.org/lists.html">mailing list</a>.
193 Do not ask such questions here. This is not a Q&amp;A section.<br><br>
194 The Apache Comments System is explained <a href="/tomcat-7.0-doc/comments.html">here</a>.
195 Comments may be removed by our moderators if they are either
196 implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
197 var comments_shortname = 'tomcat';
198 var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/index.html';
199 (function(w, d) {
200 if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {
201 d.write('<div id="comments_thread"><\/div>');
202 var s = d.createElement('script');
203 s.type = 'text/javascript';
204 s.async = true;
205 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
206 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
207 }
208 else {
209 d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>');
210 }
211 })(window, document);
212 //--><!]]></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>
213 Copyright &copy; 1999-2013, Apache Software Foundation
214 </em></font></div></td></tr></table></body></html>