blob: ab6576e636ecd5bc3f8d6a6adbb9e39b8cebf089 [file] [log] [blame]
Hongqing Liufd5ee812014-05-10 16:32:51 +08001<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference (6.0.39) - Overview</title><meta name="author" content="Craig R. McClanahan"><style type="text/css" media="print">
2 .noPrint {display: none;}
3 td#mainBody {width: 100%;}
4 </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="
5 The Apache Tomcat Servlet/JSP Container
6 " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 6.0</font></h1><font face="arial,helvetica,sanserif">Version 6.0.39, Jan 27 2014</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="noshade" size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap="nowrap" class="noPrint"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li><li><a href="index.html">Config Ref. Home</a></li></ul><p><strong>Top Level Elements</strong></p><ul><li><a href="server.html">Server</a></li><li><a href="service.html">Service</a></li></ul><p><strong>Executors</strong></p><ul><li><a href="executor.html">Executor</a></li></ul><p><strong>Connectors</strong></p><ul><li><a href="http.html">HTTP</a></li><li><a href="ajp.html">AJP</a></li></ul><p><strong>Containers</strong></p><ul><li><a href="context.html">Context</a></li><li><a href="engine.html">Engine</a></li><li><a href="host.html">Host</a></li><li><a href="cluster.html">Cluster</a></li></ul><p><strong>Nested Components</strong></p><ul><li><a href="globalresources.html">Global Resources</a></li><li><a href="listeners.html">Listeners</a></li><li><a href="loader.html">Loader</a></li><li><a href="manager.html">Manager</a></li><li><a href="realm.html">Realm</a></li><li><a href="resources.html">Resources</a></li><li><a href="valve.html">Valve</a></li></ul><p><strong>Cluster Elements</strong></p><ul><li><a href="cluster.html">Cluster</a></li><li><a href="cluster-manager.html">Manager</a></li><li><a href="cluster-channel.html">Channel</a></li><li><a href="cluster-membership.html">Channel/Membership</a></li><li><a href="cluster-sender.html">Channel/Sender</a></li><li><a href="cluster-receiver.html">Channel/Receiver</a></li><li><a href="cluster-interceptor.html">Channel/Interceptor</a></li><li><a href="cluster-valve.html">Valve</a></li><li><a href="cluster-deployer.html">Deployer</a></li><li><a href="cluster-listener.html">ClusterListener</a></li></ul><p><strong>Other</strong></p><ul><li><a href="filter.html">Filter</a></li><li><a href="systemprops.html">System properties</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Apache Tomcat Configuration Reference</h1><h2>Overview</h2><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Overview"><strong>Overview</strong></a></font></td></tr><tr><td><blockquote>
7
8<p>This manual contains reference information about all of the configuration
9directives that can be included in a <code>conf/server.xml</code> file to
10configure the behavior of the Tomcat 6 Servlet/JSP container. It does not
11attempt to describe which configuration directives should be used to perform
12specific tasks - for that, see the various <em>HOW-TO</em> documents on the
13main index page.</p>
14
15<p>Tomcat configuration files are formatted as schemaless XML; elements and
16attributes are case-sensitive. Apache Ant-style variable substitution
17is supported; a system property with the name <code>propname</code> may be
18used in a configuration file using the syntax <code>${propname}</code>. All
19system properties are available including those set using the <code>-D</code>
20syntax, those automatically made available by the JVM and those configured in
21the <code>$CATALINA_BASE/conf/catalina.properties</code> file.
22</p>
23
24<p>The configuration element descriptions are organized into the following
25major categories:</p>
26<ul>
27<li><strong>Top Level Elements</strong> - <code>&lt;Server&gt;</code> is the
28 root element of the entire configuration file, while
29 <code>&lt;Service&gt;</code> represents a group of Connectors that is
30 associated with an Engine.</li>
31<li><strong>Connectors</strong> - Represent the interface between external
32 clients sending requests to (and receiving responses from) a particular
33 Service.</li>
34<li><strong>Containers</strong> - Represent components whose function is to
35 process incoming requests, and create the corresponding responses.
36 An Engine handles all requests for a Service, a Host handles all requests
37 for a particular virtual host, and a Context handles all requests for a
38 specific web application.</li>
39<li><strong>Nested Components</strong> - Represent elements that can be
40 nested inside the element for a Container. Some elements can be nested
41 inside any Container, while others can only be nested inside a
42 Context.</li>
43</ul>
44
45<p>For each element, the corresponding documentation follows this general
46outline:</p>
47<ul>
48<li><strong>Introduction</strong> - Overall description of this particular
49 component. There will be a corresponding Java <em>interface</em> (in
50 the <code>org.apache.catalina</code> package) that is implemented by one
51 or more standard implementations.</li>
52<li><strong>Attributes</strong> - The set of attributes that are legal for
53 this element. Generally, this will be subdivided into <em>Common</em>
54 attributes that are supported by all implementations of the corresponding
55 Java interface, and <em>Standard Implementation</em> attributes that are
56 specific to a particular Java class that implements this interface.
57 The names of required attributes are <strong>bolded</strong>.</li>
58<li><strong>Nested Components</strong> - Enumerates which of the <em>Nested
59 Components</em> can be legally nested within this element.</li>
60<li><strong>Special Features</strong> - Describes the configuration of a large
61 variety of special features (specific to each element type) that are
62 supported by the standard implementation of this interface.</li>
63</ul>
64
65</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
66 Copyright &copy; 1999-2014, Apache Software Foundation
67 </em></font></div></td></tr></table></body></html>