Author: kkolinko
Date: Sun Apr 27 19:56:53 2014
New Revision: 1590479
URL: http://svn.apache.org/r1590479
Log:
Improving valves documentation.
Move valves implementing an Authenticator into new section "Authentication".
Modified:
tomcat/trunk/webapps/docs/config/valve.xml
Modified: tomcat/trunk/webapps/docs/config/valve.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/valve.xml?rev=1590479&r1=1590478&r2=1590479&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/valve.xml (original)
+++ tomcat/trunk/webapps/docs/config/valve.xml Sun Apr 27 19:56:53 2014
@@ -799,54 +799,6 @@
</section>
-<section name="Error Report Valve">
-
- <subsection name="Introduction">
-
- <p>The <strong>Error Report Valve</strong> is a simple error handler
- for HTTP status codes that will generate and return HTML error pages.</p>
-
- <p><strong>NOTE:</strong> Disabling both showServerInfo and showReport will
- only return the HTTP status code and remove all CSS.</p>
-
- </subsection>
-
- <subsection name="Attributes">
-
- <p>The <strong>Error Report Valve</strong> supports the following
- configuration attributes:</p>
-
- <attributes>
-
- <attribute name="className" required="true">
- <p>Java class name of the implementation to use. This MUST be set to
- <strong>org.apache.catalina.valves.ErrorReportValve</strong> to use the
- default error report valve.</p>
- </attribute>
-
- <attribute name="showReport" required="false">
- <p>Flag to determine if the error report is presented when an error
- occurs. If set to <code>false</code>, then the error report is not
in
- the HTML response.
- Default value: <code>true</code>
- </p>
- </attribute>
-
- <attribute name="showServerInfo" required="false">
- <p>Flag to determine if server information is presented when an error
- occurs. If set to <code>false</code>, then the server version is not
- returned in the HTML response.
- Default value: <code>true</code>
- </p>
- </attribute>
-
- </attributes>
-
- </subsection>
-
-</section>
-
-
<section name="Single Sign On Valve">
<subsection name="Introduction">
@@ -896,7 +848,12 @@
</section>
-<section name="Basic Authenticator Valve">
+<section name="Authentication">
+
+<p>The valves in this section implement
+<strong>org.apache.catalina.Authenticator</strong> interface.</p>
+
+<subsection name="Basic Authenticator Valve">
<subsection name="Introduction">
@@ -996,10 +953,10 @@
</subsection>
-</section>
+</subsection>
-<section name="Digest Authenticator Valve">
+<subsection name="Digest Authenticator Valve">
<subsection name="Introduction">
@@ -1142,10 +1099,10 @@
</subsection>
-</section>
+</subsection>
-<section name="Form Authenticator Valve">
+<subsection name="Form Authenticator Valve">
<subsection name="Introduction">
@@ -1247,10 +1204,10 @@
</subsection>
-</section>
+</subsection>
-<section name="SSL Authenticator Valve">
+<subsection name="SSL Authenticator Valve">
<subsection name="Introduction">
@@ -1339,10 +1296,10 @@
</subsection>
-</section>
+</subsection>
-<section name="SPNEGO Valve">
+<subsection name="SPNEGO Valve">
<subsection name="Introduction">
@@ -1478,6 +1435,57 @@
</subsection>
+</subsection>
+
+
+</section>
+
+
+<section name="Error Report Valve">
+
+ <subsection name="Introduction">
+
+ <p>The <strong>Error Report Valve</strong> is a simple error handler
+ for HTTP status codes that will generate and return HTML error pages.</p>
+
+ <p><strong>NOTE:</strong> Disabling both showServerInfo and showReport will
+ only return the HTTP status code and remove all CSS.</p>
+
+ </subsection>
+
+ <subsection name="Attributes">
+
+ <p>The <strong>Error Report Valve</strong> supports the following
+ configuration attributes:</p>
+
+ <attributes>
+
+ <attribute name="className" required="true">
+ <p>Java class name of the implementation to use. This MUST be set to
+ <strong>org.apache.catalina.valves.ErrorReportValve</strong> to use the
+ default error report valve.</p>
+ </attribute>
+
+ <attribute name="showReport" required="false">
+ <p>Flag to determine if the error report is presented when an error
+ occurs. If set to <code>false</code>, then the error report is not
in
+ the HTML response.
+ Default value: <code>true</code>
+ </p>
+ </attribute>
+
+ <attribute name="showServerInfo" required="false">
+ <p>Flag to determine if server information is presented when an error
+ occurs. If set to <code>false</code>, then the server version is not
+ returned in the HTML response.
+ Default value: <code>true</code>
+ </p>
+ </attribute>
+
+ </attributes>
+
+ </subsection>
+
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
