You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by kk...@apache.org on 2011/11/10 05:10:10 UTC
svn commit: r1200128 - in /tomcat/tc7.0.x/trunk/webapps/docs/config: ajp.xml
context.xml engine.xml executor.xml filter.xml globalresources.xml host.xml
http.xml
Author: kkolinko
Date: Thu Nov 10 04:10:09 2011
New Revision: 1200128
URL: http://svn.apache.org/viewvc?rev=1200128&view=rev
Log:
Merging r1187809 - Trailing whitespace removal from /webapps
/webapps/docs, 4
Modified:
tomcat/tc7.0.x/trunk/webapps/docs/config/ajp.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/context.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/engine.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/executor.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/filter.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/globalresources.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/host.xml
tomcat/tc7.0.x/trunk/webapps/docs/config/http.xml
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/ajp.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/ajp.xml?rev=1200128&r1=1200127&r2=1200128&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/ajp.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/ajp.xml Thu Nov 10 04:10:09 2011
@@ -46,7 +46,7 @@
processing.</p>
<p>This connector supports load balancing when used in conjunction with
- the <code>jvmRoute</code> attribute of the
+ the <code>jvmRoute</code> attribute of the
<a href="engine.html">Engine</a>.</p>
<p>The native connectors supported with this Tomcat release are:
@@ -206,7 +206,7 @@
<p>Set this attribute to <code>true</code> if you wish to have
calls to <code>request.isSecure()</code> to return <code>true</code>
for requests received by this Connector. You would want this on an
- SSL Connector or a non SSL connector that is receiving data from a
+ SSL Connector or a non SSL connector that is receiving data from a
SSL accelerator, like a crypto card, a SSL appliance or even a webserver.
The default value is <code>false</code>.</p>
</attribute>
@@ -250,10 +250,10 @@
<p>The standard AJP connectors (BIO, NIO and APR/native) all support the
following attributes in addition to the common Connector attributes listed
above.</p>
-
+
<p><strong><font color="red">WARNING</font></strong>: The NIO connector for
AJP is experimental.</p>
-
+
<attributes>
<attribute name="acceptCount" required="false">
@@ -309,7 +309,7 @@
after accepting a connection, for the request URI line to be
presented. The default value is 60000 (i.e. 60 seconds).</p>
</attribute>
-
+
<attribute name="executor" required="false">
<p>A reference to the name in an <a href="executor.html">Executor</a>
element. If this attribute is set, and the named executor exists, the
@@ -356,7 +356,7 @@
by this <strong>Connector</strong>, which therefore determines the
maximum number of simultaneous requests that can be handled. If
not specified, this attribute is set to 200. If an executor is associated
- with this connector, this attribute is ignored as the connector will
+ with this connector, this attribute is ignored as the connector will
execute tasks using the executor rather than an internal thread pool.</p>
</attribute>
@@ -384,7 +384,7 @@
good default is to use the larger of maxThreads and the maximum number of
expected concurrent requests (synchronous and asynchronous).</p>
</attribute>
-
+
<attribute name="requiredSecret" required="false">
<p>Only requests from workers with this secret keyword will be accepted.
</p>
@@ -405,9 +405,9 @@
</attribute>
<attribute name="tomcatAuthentication" required="false">
- <p>If set to <code>true</code>, the authentication will be done in Tomcat.
+ <p>If set to <code>true</code>, the authentication will be done in Tomcat.
Otherwise, the authenticated principal will be propagated from the native
- webserver and used for authorization in Tomcat.
+ webserver and used for authorization in Tomcat.
The default value is <code>true</code>.</p>
</attribute>
@@ -416,11 +416,11 @@
</subsection>
<subsection name="Java TCP socket attributes">
-
+
<p>The BIO and NIO implementation support the following Java TCP socket
attributes in addition to the common Connector and HTTP attributes listed
above.</p>
-
+
<attributes>
<attribute name="socket.rxBufSize" required="false">
<p>(int)The socket receive buffer (SO_RCVBUF) size in bytes. JVM default
@@ -513,7 +513,7 @@
that would be something like <code>-XX:MaxDirectMemorySize=256m</code>.
</p>
</attribute>
-
+
<attribute name="socket.appReadBufSize" required="false">
<p>(int)Each connection that is opened up in Tomcat get associated with
a read ByteBuffer. This attribute controls the size of this buffer. By
@@ -597,7 +597,7 @@
<code>-Dorg.apache.tomcat.util.net.NioSelectorShared=true|false</code>
- default is <code>true</code>. Set this value to <code>false</code> if you wish to
use a selector for each thread. When you set it to <code>false</code>, you can
- control the size of the pool of selectors by using the
+ control the size of the pool of selectors by using the
<strong>selectorPool.maxSelectors</strong> attribute.</p>
</attribute>
@@ -605,10 +605,10 @@
</subsection>
<subsection name="APR/native specific configuration">
-
+
<p>The APR/native implementation supports the following attributes in
addition to the common Connector and AJP attributes listed above.</p>
-
+
<attributes>
<attribute name="pollTime" required="false">
<p>Duration of a poll call in microseconds. Lowering this value will
@@ -624,7 +624,7 @@
right away. The default value is 8192, corresponding to 8192 keep-alive
connections.</p>
</attribute>
-
+
</attributes>
</subsection>
@@ -676,7 +676,7 @@
</source>
</subsection>
-
+
</section>
</body>
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/context.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/context.xml?rev=1200128&r1=1200127&r2=1200128&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/context.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/context.xml Thu Nov 10 04:10:09 2011
@@ -83,7 +83,7 @@
</ul>
</p>
</subsection>
-
+
<subsection name="Naming">
<p>When autoDeploy or deployOnStartup is used then there is a close
relationship between the <em>context name</em>, <em>context path</em>,
@@ -101,7 +101,7 @@
When a version is specified, <code>##version</code> is added to the contextName and base
name. To help clarify these rules, some examples are given in the following
table.</p>
-
+
<table class="detail-table">
<tr><th>Context Path</th><th>Context Version</th><th>Context Name</th><th>Base filename</th></tr>
<tr><td>/foo</td><td><i>None</i></td><td>/foo</td><td>foo</td></tr>
@@ -111,7 +111,7 @@
<tr><td>/foo/bar</td><td>42</td><td>/foo/bar##42</td><td>foo#bar##42</td></tr>
<tr><td><i>Empty String</i></td><td>42</td><td>##42</td><td>ROOT##42</td></tr>
</table>
-
+
<p>The version component is treated as a <code>String</code> both for
performance reasons and to allow flexibility in versioning schemes. String
comparisons are used to determine version order. If version is not specified,
@@ -124,7 +124,7 @@
recommended that zero padding is used so that <code>foo##002.war</code> is
treated as an earlier version than <code>foo##011.war</code>.
</p>
-
+
<p>If you want to deploy a WAR file or a directory using a context path that
is not related to the base file name then one of the following options must
be used to prevent double-deployment:
@@ -169,9 +169,9 @@
<strong>Context</strong> to which the default applies. They will <b>not</b> be
shared between <strong>Context</strong> elements.
<ul>
- <li>In the <code>$CATALINA_BASE/conf/context.xml</code> file:
+ <li>In the <code>$CATALINA_BASE/conf/context.xml</code> file:
the Context element information will be loaded by all webapps.</li>
- <li>In the
+ <li>In the
<code>$CATALINA_BASE/conf/[enginename]/[hostname]/context.xml.default</code>
file: the Context element information will be loaded by all webapps of that
host.</li>
@@ -188,7 +188,7 @@
Automatic Application Deployment</a> and
<a href="host.html#User Web Applications">User Web Applications</a>
for more information.</p>
-
+
<p>To define multiple <Strong>Context</Strong>s that use a single WAR file or
directory, use one of the options described above for creating a
<Strong>Context</Strong> that has a path that is not related to the base file
@@ -219,18 +219,18 @@
</attribute>
<attribute name="backgroundProcessorDelay" required="false">
- <p>This value represents the delay in seconds between the
- invocation of the backgroundProcess method on this context and
- its child containers, including all wrappers.
- Child containers will not be invoked if their delay value is not
- negative (which would mean they are using their own processing
- thread). Setting this to a positive value will cause
- a thread to be spawn. After waiting the specified amount of time,
- the thread will invoke the backgroundProcess method on this host
- and all its child containers. A context will use background
+ <p>This value represents the delay in seconds between the
+ invocation of the backgroundProcess method on this context and
+ its child containers, including all wrappers.
+ Child containers will not be invoked if their delay value is not
+ negative (which would mean they are using their own processing
+ thread). Setting this to a positive value will cause
+ a thread to be spawn. After waiting the specified amount of time,
+ the thread will invoke the backgroundProcess method on this host
+ and all its child containers. A context will use background
processing to perform session expiration and class monitoring for
- reloading. If not specified, the default value for this attribute is
- -1, which means the context will rely on the background processing
+ reloading. If not specified, the default value for this attribute is
+ -1, which means the context will rely on the background processing
thread of its parent host.</p>
</attribute>
@@ -372,14 +372,14 @@
may cause problems for some application component such as compression
filters.</p>
</attribute>
-
+
<attribute name="sessionCookieDomain" required="false">
<p>The domain to be used for all session cookies created for this
context. If set, this overrides any domain set by the web application.
If not set, the value specified by the web application, if any, will be
used.</p>
</attribute>
-
+
<attribute name="sessionCookieName" required="false">
<p>The name to be used for all session cookies created for this
context. If set, this overrides any name set by the web application.
@@ -387,7 +387,7 @@
used, or the name <code>JSESSIONID</code> if the web application does
not explicitly set one.</p>
</attribute>
-
+
<attribute name="sessionCookiePath" required="false">
<p>The path to be used for all session cookies created for this
context. If set, this overrides any path set by the web application.
@@ -398,7 +398,7 @@
<code>/</code> in the global <code>CATALINA_BASE/conf/context.xml</code>
file.</p>
</attribute>
-
+
<attribute name="sessionCookiePathUsesTrailingSlash" required="false">
<p>Some browsers, such as IE, will send a session cookie for a context
with a path of /foo with a request to /foobar. To prevent this, Tomcat
@@ -468,13 +468,13 @@
side script from accessing the session ID? Defaults to
<code>true</code>.</p>
</attribute>
-
+
<attribute name="wrapperClass" required="false">
<p>Java class name of the <code>org.apache.catalina.Wrapper</code>
implementation class that will be used for servlets managed by this
Context. If not specified, a standard default value will be used.</p>
</attribute>
-
+
<attribute name="xmlNamespaceAware" required="false">
<p>If the value of this flag is <code>true</code>, the validation of
XML files will be namespace-aware. If you turn this flag on,
@@ -567,11 +567,11 @@
<attribute name="antiResourceLocking" required="false">
<p>If true, Tomcat will prevent any file locking.
- This will significantly impact startup time of applications,
- but allows full webapp hot deploy and undeploy on platforms
+ This will significantly impact startup time of applications,
+ but allows full webapp hot deploy and undeploy on platforms
or configurations where file locking can occur.
If not specified, the default value is <code>false</code>.</p>
-
+
<p><code>antiJARLocking</code> is a subset of
<code>antiResourceLocking</code> and therefore, to prevent duplicate
work and possible issues, only one of these attributes should be set
@@ -591,7 +591,7 @@
</attribute>
<attribute name="cacheMaxSize" required="false">
- <p>Maximum size of the static resource cache in kilobytes.
+ <p>Maximum size of the static resource cache in kilobytes.
If not specified, the default value is <code>10240</code>
(10 megabytes).</p>
</attribute>
@@ -606,7 +606,7 @@
<attribute name="cacheTTL" required="false">
<p>Amount of time in milliseconds between cache entries revalidation.
- If not specified, the default value is <code>5000</code>
+ If not specified, the default value is <code>5000</code>
(5 seconds).</p>
</attribute>
@@ -679,10 +679,10 @@
<attribute name="renewThreadsWhenStoppingContext" required="false">
<p>If <code>true</code>, when this context is stopped, Tomcat renews all
the threads from the thread pool that was used to serve this context.
- This also requires that the
- <code>ThreadLocalLeakPreventionListener</code> be configured in
+ This also requires that the
+ <code>ThreadLocalLeakPreventionListener</code> be configured in
<code>server.xml</code> and that the <code>threadRenewalDelay</code>
- property of the <code>Executor</code> be >=0. If not specified, the
+ property of the <code>Executor</code> be >=0. If not specified, the
default value of <code>true</code> will be used.</p>
</attribute>
@@ -752,7 +752,7 @@
Configure the resource manager that will be used to access the static
resources associated with this web application. Normally, the
default configuration of the resource manager will be sufficient.</li>
- <li><strong>WatchedResource</strong> - The auto deployer will monitor the
+ <li><strong>WatchedResource</strong> - The auto deployer will monitor the
specified static resource of the web application for updates, and will
reload the web application if it is updated. The content of this element
must be a string.</li>
@@ -766,7 +766,7 @@
<subsection name="Logging">
- <p>A context is associated with the
+ <p>A context is associated with the
<code>org.apache.catalina.core.ContainerBase.[enginename].[hostname].[path]</code>
log category. Note that the brackets are actually part of the name, don't omit them.</p>
@@ -810,7 +810,7 @@
the following configuration steps occur automatically when Catalina
is started, or whenever this web application is reloaded. No special
configuration is required to enable this feature.</p>
-
+
<ul>
<li>If you have not declared your own <a href="loader.html">Loader</a>
element, a standard web application class loader will be configured.
@@ -972,8 +972,8 @@
nesting a <strong>Listener</strong> element inside this element. The
class name you specify must implement the
<code>org.apache.catalina.LifecycleListener</code> interface, and
- the class must be packaged in a jar and placed in the
- <code>$CATALINA_HOME/lib</code> directory.
+ the class must be packaged in a jar and placed in the
+ <code>$CATALINA_HOME/lib</code> directory.
It will be notified about the occurrence of the corresponding
lifecycle events. Configuration of such a listener looks like this:</p>
@@ -1029,8 +1029,8 @@
to be returned for JNDI lookups of <code><resource-ref></code> and
<code><resource-env-ref></code> elements in the web application
deployment descriptor. You <strong>MUST</strong> also define
- the needed resource parameters as attributes of the <code>Resource</code>
- element, to configure the object factory to be used (if not known to Tomcat
+ the needed resource parameters as attributes of the <code>Resource</code>
+ element, to configure the object factory to be used (if not known to Tomcat
already), and the properties used to configure that object factory.</p>
<p>For example, you can create a resource definition like this:</p>
@@ -1127,7 +1127,7 @@
<subsection name="Resource Links">
<p>This element is used to create a link to a global JNDI resource. Doing
- a JNDI lookup on the link name will then return the linked global
+ a JNDI lookup on the link name will then return the linked global
resource.</p>
<p>For example, you can create a resource link like this:</p>
@@ -1147,7 +1147,7 @@
<attributes>
<attribute name="global" required="true">
- <p>The name of the linked global resource in the
+ <p>The name of the linked global resource in the
global JNDI context.</p>
</attribute>
@@ -1166,7 +1166,7 @@
This class should implement the <code>javax.naming.spi.ObjectFactory</code> interface.</p>
</attribute>
</attributes>
-
+
<p>When the attribute <code>factory="org.apache.naming.factory.DataSourceLinkFactory"</code> the resource link can be used with
two additional attributes to allow a shared data source to be used with different credentials.
When these two additional attributes are used in combination with the <code>javax.sql.DataSource</code>
@@ -1174,7 +1174,7 @@
Under the hood, what happens is that a call to <a href="http://download.oracle.com/javase/6/docs/api/javax/sql/DataSource.html#getConnection()"><code>getConnection()</code></a>
is simply translated to a call <a href="http://download.oracle.com/javase/6/docs/api/javax/sql/DataSource.html#getConnection(java.lang.String,%20java.lang.String)">
<code>getConnection(username, password)</code></a> on the global data source. This is an easy way to get code to be transparent to what schemas are being used,
- yet be able to control connections (or pools) in the global configuration.
+ yet be able to control connections (or pools) in the global configuration.
</p>
<attributes>
@@ -1200,14 +1200,14 @@
type="javax.sql.DataSource"
username="bar"
password="barpass"
-
+
...
...
</GlobalNamingResources>
<Context path="/foo"...>
...
- <ResourceLink
+ <ResourceLink
name="appDataSource"
global="sharedDataSource"
type="javax.sql.DataSource"
@@ -1218,13 +1218,13 @@
</Context>
<Context path="/bar"...>
...
- <ResourceLink
+ <ResourceLink
name="appDataSource"
global="sharedDataSource"
type="javax.sql.DataSource"
...
</Context>
-</source>
+</source>
<p>When a request for <code>getConnection()</code> is made in the <code>/foo</code> context, the request is translated into
<code>getConnection("foo","foopass")</code>, while a request in the <code>/bar</code> gets passed straight through.</p>
</subsection>
@@ -1232,10 +1232,10 @@
<subsection name="Transaction">
<p>You can declare the characteristics of the UserTransaction
- to be returned for JNDI lookup for <code>java:comp/UserTransaction</code>.
+ to be returned for JNDI lookup for <code>java:comp/UserTransaction</code>.
You <strong>MUST</strong> define an object factory class to instantiate
- this object as well as the needed resource parameters as attributes of the
- <code>Transaction</code>
+ this object as well as the needed resource parameters as attributes of the
+ <code>Transaction</code>
element, and the properties used to configure that object factory.</p>
<p>The valid attributes for the <code><Transaction></code> element
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/engine.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/engine.xml?rev=1200128&r1=1200127&r2=1200128&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/engine.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/engine.xml Thu Nov 10 04:10:09 2011
@@ -59,14 +59,14 @@
<attributes>
<attribute name="backgroundProcessorDelay" required="false">
- <p>This value represents the delay in seconds between the
- invocation of the backgroundProcess method on this engine and
- its child containers, including all hosts and contexts.
- Child containers will not be invoked if their delay value is not
- negative (which would mean they are using their own processing
- thread). Setting this to a positive value will cause
- a thread to be spawn. After waiting the specified amount of time,
- the thread will invoke the backgroundProcess method on this engine
+ <p>This value represents the delay in seconds between the
+ invocation of the backgroundProcess method on this engine and
+ its child containers, including all hosts and contexts.
+ Child containers will not be invoked if their delay value is not
+ negative (which would mean they are using their own processing
+ thread). Setting this to a positive value will cause
+ a thread to be spawn. After waiting the specified amount of time,
+ the thread will invoke the backgroundProcess method on this engine
and all its child containers. If not specified, the default value for
this attribute is 10, which represent a 10 seconds delay.</p>
</attribute>
@@ -164,7 +164,7 @@
<subsection name="Logging">
- <p>An engine is associated with the
+ <p>An engine is associated with the
<code>org.apache.catalina.core.ContainerBase.[enginename]</code>
log category. Note that the brackets are actually part of the name,
don't omit them.</p>
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/executor.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/executor.xml?rev=1200128&r1=1200127&r2=1200128&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/executor.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/executor.xml Thu Nov 10 04:10:09 2011
@@ -35,14 +35,14 @@
<section name="Introduction">
- <p>The <strong>Executor</strong> represents a thread pool that can be shared
+ <p>The <strong>Executor</strong> represents a thread pool that can be shared
between components in Tomcat. Historically there has been a thread pool per
connector created but this allows you to share a thread pool, between (primarly) connector
but also other components when those get configured to support executors</p>
<p>The executor has to implement the <code>org.apache.catalina.Executor</code> interface.</p>
-
+
<p>The executor is a nested element to the <a href="service.html">Service</a> element.
And in order for it to be picked up by the connectors, the Executor element has to appear
prior to the Connector element in server.xml</p>
@@ -57,9 +57,9 @@
support the following attributes:</p>
<attributes>
-
+
<attribute name="className" required="false">
- <p>The class of the implementation. The implementation has to implement the
+ <p>The class of the implementation. The implementation has to implement the
<code>org.apache.catalina.Executor</code> interface.
This interface ensures that the object can be referenced through its <code>name</code> attribute
and that implements Lifecycle, so that it can be started and stopped with the container.
@@ -107,7 +107,7 @@
the default is <code>false</code></p>
</attribute>
<attribute name="threadRenewalDelay" required="false">
- <p>After a context is stopped, threads in the pool are renewed. To avoid renewing all threads at the same time,
+ <p>After a context is stopped, threads in the pool are renewed. To avoid renewing all threads at the same time,
this delay is observed between 2 threads being renewed. Value is in ms, default value is 1000ms.
If negative, threads are not renewed.</p>
</attribute>
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/filter.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/filter.xml?rev=1200128&r1=1200127&r2=1200128&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/filter.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/filter.xml Thu Nov 10 04:10:09 2011
@@ -61,12 +61,12 @@
This may be exploited by an attacker to perform an XSS attack. Internet
Explorer has this behaviour by default. Other browsers have an option to
enable it.</p>
-
+
<p>This filter prevents the attack by explicitly setting a character set.
Unless the provided character set is explicitly overridden by the user the
browser will adhere to the explicitly set character set, thus preventing the
XSS attack.</p>
-
+
</subsection>
<subsection name="Filter Class Name">
@@ -85,8 +85,8 @@
<attributes>
<attribute name="encoding" required="false">
- <p>Name of the character set which should be set, if no other character set
- was set explicitly by a Servlet. This parameter has two special values
+ <p>Name of the character set which should be set, if no other character set
+ was set explicitly by a Servlet. This parameter has two special values
<code>default</code> and <code>system</code>. A value of <code>system</code>
uses the JVM wide default character set, which is usually set by locale.
A value of <code>default</code> will use <strong>ISO-8859-1</strong>.</p>
@@ -108,12 +108,12 @@
returned to the client are encoded via a call to
<code>HttpServletResponse#encodeRedirectURL(String)</code> or
<code>HttpServletResponse#encodeURL(String)</code>.</p>
-
+
<p>This filter prevents CSRF by generating a nonce and storing it in the
session. URLs are also encoded with the same nonce. When the next request is
received the nonce in the request is compared to the nonce in the session
and only if they are the same is the request allowed to continue.</p>
-
+
</subsection>
<subsection name="Filter Class Name">
@@ -138,7 +138,7 @@
Entry points will be limited to HTTP GET requests and should not trigger
any security sensitive actions.</p>
</attribute>
-
+
<attribute name="nonceCacheSize" required="false">
<p>The number of previously issued nonces that will be cached on a LRU
basis to support parallel requests, limited use of the refresh and back
@@ -146,15 +146,15 @@
of a previous nonce rather than the current one. If not set, the default
value of 5 will be used.</p>
</attribute>
-
+
<attribute name="randomClass" required="false">
<p>The name of the class to use to generate nonces. The class must be an
instance of <code>java.util.Random</code>. If not set, the default value
of <code>java.security.SecureRandom</code> will be used.</p>
</attribute>
-
+
</attributes>
-
+
</subsection>
</section>
@@ -172,7 +172,7 @@
server responses. The expiration date can set to be relative to either the
time the source file was last modified, or to the time of the client access.
</p>
-
+
<p>
These HTTP headers are an instruction to the client about the document's
validity and persistence. If cached, the document may be fetched from the
@@ -187,12 +187,12 @@
href="http://httpd.apache.org/docs/2.2/mod/mod_headers.html" >Apache Httpd
mod_headers</a> module.
</p>
-
+
</subsection>
<subsection name="Basic configuration sample">
<p>
- Basic configuration to add '<code>Expires</code>' and '<code>Cache-Control: max-age=</code>'
+ Basic configuration to add '<code>Expires</code>' and '<code>Cache-Control: max-age=</code>'
headers to images, css and javascript.
</p>
@@ -221,15 +221,15 @@
</filter-mapping>
</source>
-
+
</subsection>
-
+
<subsection name="Alternate Syntax">
<p>
The <code>ExpiresDefault</code> and <code>ExpiresByType</code> directives can also be
defined in a more readable syntax of the form:
</p>
-
+
<source>
<init-param>
<param-name>ExpiresDefault</param-name>
@@ -270,7 +270,7 @@
For example, any of the following directives can be used to make documents
expire 1 month after being accessed, by default:
</p>
-
+
<source>
<init-param>
<param-name>ExpiresDefault</param-name>
@@ -308,9 +308,9 @@ The expiry time can be fine-tuned by add
header will <strong>not</strong> be added to content that does not come from
a file on disk. This is due to the fact that there is no modification time
for such content.
- </p>
+ </p>
</subsection>
-
+
<subsection name="Expiration headers generation eligibility">
<p>
A response is eligible to be enriched by <code>ExpiresFilter</code> if :
@@ -331,7 +331,7 @@ The expiry time can be fine-tuned by add
</p>
</subsection>
-
+
<subsection name="Expiration configuration selection">
<p>
The expiration configuration if elected according to the following algorithm:
@@ -358,7 +358,7 @@ The expiry time can be fine-tuned by add
</strong>.</p>
</subsection>
-
+
<subsection name="Initialisation parameters">
<p>The <strong>Expires Filter</strong> supports the following
@@ -383,7 +383,7 @@ The expiry time can be fine-tuned by add
<p>
<i>Sample : exclude response status codes 302, 500 and 503</i>
</p>
-
+
<source>
<init-param>
<param-name>ExpiresExcludedResponseStatusCodes</param-name>
@@ -423,22 +423,22 @@ The expiry time can be fine-tuned by add
accessed repeatedly within a relatively short timespan).
</p>
<p>
- <strong>Note:</strong> When the content type includes a charset (e.g.
- <code>'ExpiresByType text/xml;charset=utf-8'</code>), Tomcat removes blank chars
- between the '<code>;</code>' and the '<code>charset</code>' keyword. Due to this,
- configuration of an expiration with a charset must <strong>not</strong> include
- such a space character.
+ <strong>Note:</strong> When the content type includes a charset (e.g.
+ <code>'ExpiresByType text/xml;charset=utf-8'</code>), Tomcat removes blank chars
+ between the '<code>;</code>' and the '<code>charset</code>' keyword. Due to this,
+ configuration of an expiration with a charset must <strong>not</strong> include
+ such a space character.
</p>
<p>
<i>Sample:</i>
</p>
-
+
<source>
<init-param>
<param-name>ExpiresByType text/html</param-name>
<param-value>access plus 1 month 15 days 2 hours</param-value>
</init-param>
-
+
<init-param>
<!-- 2592000 seconds = 30 days -->
<param-name>ExpiresByType image/gif</param-name>
@@ -468,7 +468,7 @@ The expiry time can be fine-tuned by add
</attributes>
</subsection>
-
+
<subsection name="Troubleshooting">
<p>
To troubleshoot, enable logging on the
@@ -477,29 +477,29 @@ The expiry time can be fine-tuned by add
<p>
Extract of logging.properties
</p>
-
+
<source>
org.apache.catalina.filters.ExpiresFilter.level = FINE
</source>
<p>
Sample of initialization log message:
</p>
-
+
<source>
Mar 26, 2010 2:01:41 PM org.apache.catalina.filters.ExpiresFilter init
FINE: Filter initialized with configuration ExpiresFilter[
- excludedResponseStatusCode=[304],
- default=null,
+ excludedResponseStatusCode=[304],
+ default=null,
byType={
- image=ExpiresConfiguration[startingPoint=ACCESS_TIME, duration=[10 MINUTE]],
- text/css=ExpiresConfiguration[startingPoint=ACCESS_TIME, duration=[10 MINUTE]],
+ image=ExpiresConfiguration[startingPoint=ACCESS_TIME, duration=[10 MINUTE]],
+ text/css=ExpiresConfiguration[startingPoint=ACCESS_TIME, duration=[10 MINUTE]],
text/javascript=ExpiresConfiguration[startingPoint=ACCESS_TIME, duration=[10 MINUTE]]}]
</source>
<p>
Sample of per-request log message where <code>ExpiresFilter</code> adds an
expiration date:
</p>
-
+
<source>
Mar 26, 2010 2:09:47 PM org.apache.catalina.filters.ExpiresFilter onBeforeWriteResponseBody
FINE: Request "/tomcat.gif" with response status "200" content-type "image/gif", set expiration date 3/26/10 2:19 PM
@@ -508,7 +508,7 @@ FINE: Request "/tomcat.gif" with respons
Sample of per-request log message where <code>ExpiresFilter</code> does not add
an expiration date:
</p>
-
+
<source>
Mar 26, 2010 2:10:27 PM org.apache.catalina.filters.ExpiresFilter onBeforeWriteResponseBody
FINE: Request "/docs/config/manager.html" with response status "200" content-type "text/html", no expiration configured
@@ -666,14 +666,14 @@ FINE: Request "/docs/config/manager.html
via a request headers (e.g. "X-Forwarded-For").</p>
<p>Another feature of this filter is to replace the apparent scheme
- (http/https), server port and <code>request.secure</code> with the scheme presented
- by a proxy or a load balancer via a request header
+ (http/https), server port and <code>request.secure</code> with the scheme presented
+ by a proxy or a load balancer via a request header
(e.g. "X-Forwarded-Proto").</p>
-
+
<p>If used in conjunction with Remote Address/Host filters then this filter
should be defined first to ensure that the correct client IP address is
presented to the Remote Address/Host filters.</p>
-
+
</subsection>
<subsection name="Filter Class Name">
@@ -693,7 +693,7 @@ FINE: Request "/docs/config/manager.html
<filter-name>RemoteIpFilter</filter-name>
<filter-class>org.apache.catalina.filters.RemoteIpFilter</filter-class>
</filter>
-
+
<filter-mapping>
<filter-name>RemoteIpFilter</filter-name>
<url-pattern>/*</url-pattern>
@@ -701,13 +701,13 @@ FINE: Request "/docs/config/manager.html
</filter-mapping>
</source>
</subsection>
-
+
<subsection name="Basic configuration to handle 'x-forwarded-for' and 'x-forwarded-proto'">
-
+
<p>
- The filter will process <code>x-forwarded-for</code> and
+ The filter will process <code>x-forwarded-for</code> and
<code>x-forwarded-proto</code> http headers. Expected value for the
- <code>x-forwarded-proto</code> header in case of SSL connections is
+ <code>x-forwarded-proto</code> header in case of SSL connections is
<code>https</code> (case insensitive). </p>
<source>
<filter>
@@ -718,7 +718,7 @@ FINE: Request "/docs/config/manager.html
<param-value>x-forwarded-proto</param-value>
</init-param>
</filter>
-
+
<filter-mapping>
<filter-name>RemoteIpFilter</filter-name>
<url-pattern>/*</url-pattern>
@@ -726,7 +726,7 @@ FINE: Request "/docs/config/manager.html
</filter-mapping>
</source>
</subsection>
-
+
<subsection name="Advanced configuration with internal proxies">
<p>RemoteIpFilter configuration: </p>
<source>
@@ -751,59 +751,59 @@ FINE: Request "/docs/config/manager.html
</init-param>
</filter>
</source>
- <p>Request values:
+ <p>Request values:
<table border="1" cellpadding="5">
<tr>
<th bgcolor="#023264"><font color="#ffffff">Property</font></th>
<th bgcolor="#023264"><font color="#ffffff">Value Before RemoteIpFilter</font></th>
<th bgcolor="#023264"><font color="#ffffff">Value After RemoteIpFilter</font></th>
- </tr>
+ </tr>
<tr>
<td> request.remoteAddr </td>
<td> 192.168.0.10 </td>
<td> 140.211.11.130 </td>
- </tr>
+ </tr>
<tr>
<td> request.header<code>[</code>'x-forwarded-for'<code>]</code> </td>
<td> 140.211.11.130, 192.168.0.10 </td>
<td> null </td>
- </tr>
+ </tr>
<tr>
<td> request.header<code>[</code>'x-forwarded-by'<code>]</code> </td>
<td> null </td>
<td> null </td>
- </tr>
+ </tr>
<tr>
<td> request.header<code>[</code>'x-forwarded-proto'<code>]</code> </td>
<td> https </td>
<td> https </td>
- </tr>
+ </tr>
<tr>
<td> request.scheme </td>
<td> http </td>
<td> https </td>
- </tr>
+ </tr>
<tr>
<td> request.secure </td>
<td> false </td>
<td> true </td>
- </tr>
+ </tr>
<tr>
<td> request.serverPort </td>
<td> 80 </td>
<td> 443 </td>
- </tr>
+ </tr>
</table>
</p>
<p>
- Note : <code>x-forwarded-by</code> header is <code>null</code> because only
- internal proxies has been traversed by the request.
- <code>x-forwarded-for</code> is <code>null</code> because all the proxies are
- trusted or internal.
+ Note : <code>x-forwarded-by</code> header is <code>null</code> because only
+ internal proxies has been traversed by the request.
+ <code>x-forwarded-for</code> is <code>null</code> because all the proxies are
+ trusted or internal.
</p>
</subsection>
-
-
+
+
<subsection name="Advanced configuration with trusted proxies">
<p>RemoteIpFilter configuration: </p>
<source>
@@ -833,32 +833,32 @@ FINE: Request "/docs/config/manager.html
<th bgcolor="#023264"><font color="#ffffff">Property</font></th>
<th bgcolor="#023264"><font color="#ffffff">Value Before RemoteIpFilter</font></th>
<th bgcolor="#023264"><font color="#ffffff">Value After RemoteIpFilter</font></th>
- </tr>
+ </tr>
<tr>
<td> request.remoteAddr </td>
<td> 192.168.0.10 </td>
<td> 140.211.11.130 </td>
- </tr>
+ </tr>
<tr>
<td> request.header<code>[</code>'x-forwarded-for'<code>]</code> </td>
<td> 140.211.11.130, proxy1, proxy2 </td>
<td> null </td>
- </tr>
+ </tr>
<tr>
<td> request.header<code>[</code>'x-forwarded-by'<code>]</code> </td>
<td> null </td>
<td> proxy1, proxy2 </td>
- </tr>
+ </tr>
</table>
</p>
<p>
- Note : <code>proxy1</code> and <code>proxy2</code> are both trusted proxies that
- come in <code>x-forwarded-for</code> header, they both are migrated in
- <code>x-forwarded-by</code> header. <code>x-forwarded-for</code> is <code>null</code>
+ Note : <code>proxy1</code> and <code>proxy2</code> are both trusted proxies that
+ come in <code>x-forwarded-for</code> header, they both are migrated in
+ <code>x-forwarded-by</code> header. <code>x-forwarded-for</code> is <code>null</code>
because all the proxies are trusted or internal.
</p>
</subsection>
-
+
<subsection name="Advanced configuration with internal and trusted proxies">
<p>RemoteIpFilter configuration: </p>
<source>
@@ -888,36 +888,36 @@ FINE: Request "/docs/config/manager.html
<th bgcolor="#023264"><font color="#ffffff">Property</font></th>
<th bgcolor="#023264"><font color="#ffffff">Value Before RemoteIpFilter</font></th>
<th bgcolor="#023264"><font color="#ffffff">Value After RemoteIpFilter</font></th>
- </tr>
+ </tr>
<tr>
<td> request.remoteAddr </td>
<td> 192.168.0.10 </td>
<td> 140.211.11.130 </td>
- </tr>
+ </tr>
<tr>
<td> request.header<code>[</code>'x-forwarded-for'<code>]</code> </td>
<td> 140.211.11.130, proxy1, proxy2, 192.168.0.10 </td>
<td> null </td>
- </tr>
+ </tr>
<tr>
<td> request.header<code>[</code>'x-forwarded-by'<code>]</code> </td>
<td> null </td>
<td> proxy1, proxy2 </td>
- </tr>
+ </tr>
</table>
</p>
<p>
- Note : <code>proxy1</code> and <code>proxy2</code> are both trusted proxies that
- come in <code>x-forwarded-for</code> header, they both are migrated in
- <code>x-forwarded-by</code> header. As <code>192.168.0.10</code> is an internal
- proxy, it does not appear in <code>x-forwarded-by</code>.
- <code>x-forwarded-for</code> is <code>null</code> because all the proxies are
+ Note : <code>proxy1</code> and <code>proxy2</code> are both trusted proxies that
+ come in <code>x-forwarded-for</code> header, they both are migrated in
+ <code>x-forwarded-by</code> header. As <code>192.168.0.10</code> is an internal
+ proxy, it does not appear in <code>x-forwarded-by</code>.
+ <code>x-forwarded-for</code> is <code>null</code> because all the proxies are
trusted or internal.
</p>
</subsection>
-
+
<subsection name="Advanced configuration with an untrusted proxy">
-
+
<p>RemoteIpFilter configuration: </p>
<source>
<filter>
@@ -946,36 +946,36 @@ FINE: Request "/docs/config/manager.html
<th bgcolor="#023264"><font color="#ffffff">Property</font></th>
<th bgcolor="#023264"><font color="#ffffff">Value Before RemoteIpFilter</font></th>
<th bgcolor="#023264"><font color="#ffffff">Value After RemoteIpFilter</font></th>
- </tr>
+ </tr>
<tr>
<td> request.remoteAddr </td>
<td> 192.168.0.10 </td>
<td> untrusted-proxy </td>
- </tr>
+ </tr>
<tr>
<td> request.header<code>[</code>'x-forwarded-for'<code>]</code> </td>
<td> 140.211.11.130, untrusted-proxy, proxy1 </td>
<td> 140.211.11.130 </td>
- </tr>
+ </tr>
<tr>
<td> request.header<code>[</code>'x-forwarded-by'<code>]</code> </td>
<td> null </td>
<td> proxy1 </td>
- </tr>
+ </tr>
</table>
</p>
<p>
- Note : <code>x-forwarded-by</code> holds the trusted proxy <code>proxy1</code>.
- <code>x-forwarded-by</code> holds <code>140.211.11.130</code> because
- <code>untrusted-proxy</code> is not trusted and thus, we can not trust that
- <code>untrusted-proxy</code> is the actual remote ip.
- <code>request.remoteAddr</code> is <code>untrusted-proxy</code> that is an IP
- verified by <code>proxy1</code>.
+ Note : <code>x-forwarded-by</code> holds the trusted proxy <code>proxy1</code>.
+ <code>x-forwarded-by</code> holds <code>140.211.11.130</code> because
+ <code>untrusted-proxy</code> is not trusted and thus, we can not trust that
+ <code>untrusted-proxy</code> is the actual remote ip.
+ <code>request.remoteAddr</code> is <code>untrusted-proxy</code> that is an IP
+ verified by <code>proxy1</code>.
</p>
</subsection>
<subsection name="Initialisation parameters">
-
+
<p>The <strong>Remote IP Filter</strong> supports the
following initialisation parameters:</p>
@@ -1031,15 +1031,15 @@ FINE: Request "/docs/config/manager.html
</attribute>
<attribute name="httpServerPort" required="false">
- <p>Value returned by <code>ServletRequest.getServerPort()</code>
- when the <strong>protocolHeader</strong> indicates <code>http</code>
+ <p>Value returned by <code>ServletRequest.getServerPort()</code>
+ when the <strong>protocolHeader</strong> indicates <code>http</code>
protocol and no <strong>portHeader</strong> is present. If not
specified, the default of <code>80</code> is used.</p>
</attribute>
<attribute name="httpsServerPort" required="false">
- <p>Value returned by <code>ServletRequest.getServerPort()</code>
- when the <strong>protocolHeader</strong> indicates <code>https</code>
+ <p>Value returned by <code>ServletRequest.getServerPort()</code>
+ when the <strong>protocolHeader</strong> indicates <code>https</code>
protocol and no <strong>portHeader</strong> is present. If not
specified, the default of <code>443</code> is used.</p>
</attribute>
@@ -1075,7 +1075,7 @@ FINE: Request "/docs/config/manager.html
The parameters will be decoded using the default platform encoding. Any
subsequent calls to <code>request.setCharacterEncoding()</code> within
the web application will have no effect.</p>
-
+
</subsection>
<subsection name="Filter Class Name">
@@ -1094,7 +1094,7 @@ FINE: Request "/docs/config/manager.html
</subsection>
<subsection name="Sample Configuration">
-
+
<p>The following entries in a web application's web.xml would enable the
Request Dumper filter for all requests for that web application. If the
entries were added to <code>CATALINA_BASE/conf/web.xml</code>, the Request
@@ -1111,7 +1111,7 @@ FINE: Request "/docs/config/manager.html
<url-pattern>*</url-pattern>
</filter-mapping>
</source>
-
+
<p>The following entries in CATALINA_BASE/conf/logging.properties would
create a separate log file for the Request Dumper Filter output.</p>
<source>
@@ -1137,7 +1137,7 @@ org.apache.catalina.filters.RequestDumpe
ISO-8859-1 or the platform default encoding may be used. This is not always
desirable. This filter provides options for setting that encoding or forcing
it to a particular value.</p>
-
+
</subsection>
<subsection name="Filter Class Name">
@@ -1183,7 +1183,7 @@ org.apache.catalina.filters.RequestDumpe
communicate with the Tomcat WebDAV Servlet. This Filter provides a fix for
this by forcing the use of the WebDAV implementation that works, even when
connecting via port 80.</p>
-
+
</subsection>
<subsection name="Filter Class Name">
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/globalresources.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/globalresources.xml?rev=1200128&r1=1200127&r2=1200128&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/globalresources.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/globalresources.xml Thu Nov 10 04:10:09 2011
@@ -40,7 +40,7 @@
JNDI resources for the <a href="server.html">Server</a>.</p>
<p>These resources are listed in the server's global JNDI resource context.
- This context is distinct from the per-web-application JNDI contexts
+ This context is distinct from the per-web-application JNDI contexts
described in
the <a href="../jndi-resources-howto.html">JNDI Resources HOW-TO</a>.
The resources defined in this element are <strong>not</strong> visible in
@@ -140,10 +140,10 @@
<p>You can declare the characteristics of resources
to be returned for JNDI lookups of <code><resource-ref></code> and
<code><resource-env-ref></code> elements in the web application
- deployment descriptor by defining them in this element and then linking
- them with <a href="context.html#Resource Links"><ResourceLink></a>
+ deployment descriptor by defining them in this element and then linking
+ them with <a href="context.html#Resource Links"><ResourceLink></a>
elements
- in the <code><strong><Context></strong></code> element.
+ in the <code><strong><Context></strong></code> element.
You <strong>MUST</strong> also define any other needed parameters using
attributes on the Resource element, to configure
@@ -219,10 +219,10 @@
</subsection>
<subsection name="Resource Links">
- <p>Use <a href="context.html#Resource Links"><ResourceLink></a>
- elements to link resources from the global context into
- per-web-application contexts. Here is an example of making a custom
- factory available to an application, based on the example definition in the
+ <p>Use <a href="context.html#Resource Links"><ResourceLink></a>
+ elements to link resources from the global context into
+ per-web-application contexts. Here is an example of making a custom
+ factory available to an application, based on the example definition in the
<a href="../jndi-resources-howto.html#Generic JavaBean Resources">
JNDI Resource HOW-TO</a>:
</p>
@@ -230,7 +230,7 @@
<source>
<![CDATA[
<Context>
- <ResourceLink
+ <ResourceLink
name="bean/MyBeanFactory"
global="bean/MyBeanFactory"
type="com.mycompany.MyBean"
@@ -244,10 +244,10 @@
<subsection name="Transaction">
<p>You can declare the characteristics of the UserTransaction
- to be returned for JNDI lookup for <code>java:comp/UserTransaction</code>.
+ to be returned for JNDI lookup for <code>java:comp/UserTransaction</code>.
You <strong>MUST</strong> define an object factory class to instantiate
- this object as well as the needed resource parameters as attributes of the
- <code>Transaction</code>
+ this object as well as the needed resource parameters as attributes of the
+ <code>Transaction</code>
element, and the properties used to configure that object factory.</p>
<p>The valid attributes for the <code><Transaction></code> element
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/host.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/host.xml?rev=1200128&r1=1200127&r2=1200128&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/host.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/host.xml Thu Nov 10 04:10:09 2011
@@ -98,7 +98,7 @@
deployment of web applications. If not specified, the default of
<code>webapps</code> will be used.</p>
</attribute>
-
+
<attribute name="xmlBase" required="false">
<p>The <em>XML Base</em> directory for this virtual host.
This is the pathname of a directory that may contain context XML
@@ -110,7 +110,7 @@
deployment of web applications. If not specified the default of
<code>[engine_name]/[host_name]</code> will be used.</p>
</attribute>
-
+
<attribute name="createDirs" required="false">
<p>If set to true, Tomcat will attempt to create the directories defined
by the attributes <code>appBase</code> and <code>xmlBase</code> during
@@ -132,18 +132,18 @@
</attribute>
<attribute name="backgroundProcessorDelay" required="false">
- <p>This value represents the delay in seconds between the
- invocation of the backgroundProcess method on this host and
- its child containers, including all contexts.
- Child containers will not be invoked if their delay value is not
- negative (which would mean they are using their own processing
- thread). Setting this to a positive value will cause
- a thread to be spawn. After waiting the specified amount of time,
- the thread will invoke the backgroundProcess method on this host
+ <p>This value represents the delay in seconds between the
+ invocation of the backgroundProcess method on this host and
+ its child containers, including all contexts.
+ Child containers will not be invoked if their delay value is not
+ negative (which would mean they are using their own processing
+ thread). Setting this to a positive value will cause
+ a thread to be spawn. After waiting the specified amount of time,
+ the thread will invoke the backgroundProcess method on this host
and all its child containers. A host will use background processing to
- perform live web application deployment related tasks. If not
- specified, the default value for this attribute is -1, which means
- the host will rely on the background processing thread of its parent
+ perform live web application deployment related tasks. If not
+ specified, the default value for this attribute is -1, which means
+ the host will rely on the background processing thread of its parent
engine.</p>
</attribute>
@@ -307,7 +307,7 @@
<subsection name="Logging">
- <p>A host is associated with the
+ <p>A host is associated with the
<code>org.apache.catalina.core.ContainerBase.[engine_name].[host_name]</code>
log category. Note that the brackets are part of the name,
don't omit them.</p>
@@ -388,7 +388,7 @@
application archive file will be expanded to a directory of the same
name (without the ".war" extension".<br/>
Note: If you re-deploy an updated WAR file while Tomcat is stopped, be
- sure to delete the associated expanded directory before restarting
+ sure to delete the associated expanded directory before restarting
Tomcat, so that the updated WAR file will be re-expanded when Tomcat
restarts.<br/>
If <code>copyXml</code> is <code>true</code> (it is <code>false</code>
@@ -420,7 +420,7 @@
<p>In addition to the automatic deployment that occurs at startup time,
you can also request that new XML configuration files, WAR files, or
- sub-directories that are dropped in to the <code>appBase</code> (or
+ sub-directories that are dropped in to the <code>appBase</code> (or
<code>xmlBase</code> in the case of an XML configuration file) directory
while Tomcat is running will be automatically deployed, according to the
rules described above. The auto deployer will also track web applications
Modified: tomcat/tc7.0.x/trunk/webapps/docs/config/http.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/config/http.xml?rev=1200128&r1=1200127&r2=1200128&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/config/http.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/config/http.xml Thu Nov 10 04:10:09 2011
@@ -73,7 +73,7 @@
support the following attributes:</p>
<attributes>
-
+
<attribute name="allowTrace" required="false">
<p>A boolean value which can be used to enable or disable the TRACE
HTTP method. If not specified, this attribute is set to false.</p>
@@ -205,7 +205,7 @@
<p>Set this attribute to <code>true</code> if you wish to have
calls to <code>request.isSecure()</code> to return <code>true</code>
for requests received by this Connector. You would want this on an
- SSL Connector or a non SSL connector that is receiving data from a
+ SSL Connector or a non SSL connector that is receiving data from a
SSL accelerator, like a crypto card, a SSL appliance or even a webserver.
The default value is <code>false</code>.</p>
</attribute>
@@ -329,7 +329,7 @@
server.xml that ships with Tomcat sets this to 20000 (i.e. 20 seconds).
</p>
</attribute>
-
+
<attribute name="connectionUploadTimeout" required="false">
<p>Specifies the timeout, in milliseconds, to use while a data upload is
in progress. This only takes effect if
@@ -405,7 +405,7 @@
by this <strong>Connector</strong>, which therefore determines the
maximum number of simultaneous requests that can be handled. If
not specified, this attribute is set to 200. If an executor is associated
- with this connector, this attribute is ignored as the connector will
+ with this connector, this attribute is ignored as the connector will
execute tasks using the executor rather than an internal thread pool.</p>
</attribute>
@@ -439,7 +439,7 @@
good default is to use the larger of maxThreads and the maximum number of
expected concurrent requests (synchronous and asynchronous).</p>
</attribute>
-
+
<attribute name="restrictedUserAgents" required="false">
<p>The value is a regular expression (using <code>java.util.regex</code>) matching
matching the <code>user-agent</code> header of HTTP clients for which
@@ -469,9 +469,9 @@
To turn on SSL handshake/encryption/decryption on a connector
set this value to <code>true</code>.
The default value is <code>false</code>.
- When turning this value <code>true</code> you will want to set the
+ When turning this value <code>true</code> you will want to set the
<code>scheme</code> and the <code>secure</code> attributes as well
- to pass the correct <code>request.getScheme()</code> and
+ to pass the correct <code>request.getScheme()</code> and
<code>request.isSecure()</code> values to the servlets
See <a href="#SSL Support">SSL Support</a> for more information.
</p>
@@ -492,15 +492,15 @@
</attribute>
</attributes>
-
+
</subsection>
-
+
<subsection name="Java TCP socket attributes">
-
+
<p>The BIO and NIO implementation support the following Java TCP socket
attributes in addition to the common Connector and HTTP attributes listed
above.</p>
-
+
<attributes>
<attribute name="socket.rxBufSize" required="false">
<p>(int)The socket receive buffer (SO_RCVBUF) size in bytes. JVM default
@@ -545,7 +545,7 @@
<attribute name="socket.soTimeout" required="false">
<p>This is equivalent to standard attribute
<strong>connectionTimeout</strong>.</p>
- </attribute>
+ </attribute>
<attribute name="socket.soTrafficClass" required="false">
<p>(byte)Value between <code>0</code> and <code>255</code> for the
traffic class on the socket. JVM default used if not set.</p>
@@ -553,36 +553,36 @@
<strong>soTrafficClass</strong> causes a problem. A work around for this
is to add the <code>-Djava.net.preferIPv4Stack=true</code> value to your
JVM options.</p>
- </attribute>
+ </attribute>
<attribute name="socket.performanceConnectionTime" required="false">
<p>(int)The first value for the performance settings. See
<a href="http://download.oracle.com/javase/6/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>
All three performance attributes must be set else the JVM defaults will
be used for all three.</p>
- </attribute>
+ </attribute>
<attribute name="socket.performanceLatency" required="false">
<p>(int)The second value for the performance settings. See
<a href="http://download.oracle.com/javase/6/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>
All three performance attributes must be set else the JVM defaults will
be used for all three.</p>
- </attribute>
+ </attribute>
<attribute name="socket.performanceBandwidth" required="false">
<p>(int)The third value for the performance settings. See
<a href="http://download.oracle.com/javase/6/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>
All three performance attributes must be set else the JVM defaults will
be used for all three.</p>
- </attribute>
+ </attribute>
<attribute name="socket.unlockTimeout" required="false">
<p>(int) The timeout for a socket unlock. When a connector is stopped, it will try to release the acceptor thread by opening a connector to itself.
The default value is <code>250</code> and the value is in milliseconds</p>
- </attribute>
+ </attribute>
</attributes>
</subsection>
-
+
<subsection name="BIO specific configuration">
-
+
<p>The following attributes are specific to the BIO connector.</p>
-
+
<attributes>
<attribute name="disableKeepAlivePercentage" required="false">
@@ -596,7 +596,7 @@
</attributes>
</subsection>
-
+
<subsection name="NIO specific configuration">
<p>The following attributes are specific to the NIO connector.</p>
@@ -615,7 +615,7 @@
Default value is <code>1</code> per processor. Can't see a reason to go
above that. But experiment and find your own results.</p>
</attribute>
-
+
<attribute name="pollerThreadPriority" required="false">
<p>(int)The priority of the poller threads. The default value is
<code>java.lang.Thread#NORM_PRIORITY</code>. See the JavaDoc for the
@@ -647,7 +647,7 @@
that would be something like <code>-XX:MaxDirectMemorySize=256m</code>.
</p>
</attribute>
-
+
<attribute name="socket.appReadBufSize" required="false">
<p>(int)Each connection that is opened up in Tomcat get associated with
a read ByteBuffer. This attribute controls the size of this buffer. By
@@ -731,7 +731,7 @@
<code>-Dorg.apache.tomcat.util.net.NioSelectorShared=true|false</code>
- default is <code>true</code>. Set this value to <code>false</code> if you wish to
use a selector for each thread. When you set it to <code>false</code>, you can
- control the size of the pool of selectors by using the
+ control the size of the pool of selectors by using the
<strong>selectorPool.maxSelectors</strong> attribute.</p>
</attribute>
@@ -751,7 +751,7 @@
</subsection>
<subsection name="APR/native specific configuration">
-
+
<p>The following attributes are specific to the APR/native connector.</p>
<attributes>
@@ -762,7 +762,7 @@
<code>TCP_DEFER_ACCEPT</code> is supported by the operating system,
otherwise it is <code>false</code>.</p>
</attribute>
-
+
<attribute name="pollerSize" required="false">
<p>Amount of sockets that the poller responsible for polling kept alive
connections can hold at a given time. Extra connections will be closed
@@ -801,7 +801,7 @@
less than 1024. For Linux the default is 1. Changing the default on
Windows is likely to have a negative performance impact.</p>
</attribute>
-
+
<attribute name="threadPriority" required="false">
<p>(int)The priority of the acceptor and poller threads. The default
value is <code>java.lang.Thread#NORM_PRIORITY</code>. See the JavaDoc
@@ -820,7 +820,7 @@
</attribute>
</attributes>
-
+
</subsection>
</section>
@@ -916,7 +916,7 @@
</attribute>
<attribute name="ciphers" required="false">
- <p>The comma separated list of encryption ciphers that this socket is
+ <p>The comma separated list of encryption ciphers that this socket is
allowed to use. By default, the default ciphers for the JVM will be used.
Note that this usually means that the weak export grade ciphers will be
included in the list of available ciphers. The ciphers are specified using
@@ -996,7 +996,7 @@
specify an unlimited cache size. If not specified, a default of 0 is
used.</p>
</attribute>
-
+
<attribute name="sessionTimeout" required="false">
<p>The time, in seconds, after the creation of an SSL session that it will
timeout. Use 0 to specify an unlimited timeout. If not specified, a
@@ -1027,7 +1027,7 @@
attribute is set, the trust store attributes may be ignored.
</p>
</attribute>
-
+
<attribute name="trustMaxCertLength" required="false">
<p>The maximum number of intermediate certificates that will be allowed
when validating client certificates. If not specified, the default value
@@ -1093,12 +1093,12 @@
</p>
<attributes>
-
+
<attribute name="SSLCACertificateFile" required="false">
<p>See <a href="http://httpd.apache.org/docs/2.2/mod/mod_ssl.html#sslcacertificatefile">
the mod_ssl documentation</a>.</p>
</attribute>
-
+
<attribute name="SSLCACertificatePath" required="false">
<p>See <a href="http://httpd.apache.org/docs/2.2/mod/mod_ssl.html#sslcacertificatepath">
the mod_ssl documentation</a>.</p>
@@ -1189,9 +1189,9 @@
<p>Maximum verification depth for client certificates. The default is
"10".</p>
</attribute>
-
+
</attributes>
-
+
<p>For more information, see the
<a href="../ssl-howto.html">SSL Configuration HOW-TO</a>.</p>
@@ -1213,8 +1213,8 @@
SSL Support Java SSL Java SSL OpenSSL
SSL Handshake Blocking Non blocking Blocking
Max Connections maxConnections maxConnections maxConnections
-
-
+
+
</source>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org