Return-Path: 
 <tomcat-dev-return-28500-apmail-jakarta-tomcat-dev-archive=jakarta.apache.org@jakarta.apache.org>
Delivered-To: apmail-jakarta-tomcat-dev-archive@jakarta.apache.org
Received: (qmail 46510 invoked by uid 500); 26 Sep 2001 02:29:45 -0000
Mailing-List: contact tomcat-dev-help@jakarta.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:tomcat-dev-help@jakarta.apache.org>
list-unsubscribe: <mailto:tomcat-dev-unsubscribe@jakarta.apache.org>
list-post: <mailto:tomcat-dev@jakarta.apache.org>
Reply-To: tomcat-dev@jakarta.apache.org
Delivered-To: mailing list tomcat-dev@jakarta.apache.org
Received: (qmail 46501 invoked by uid 500); 26 Sep 2001 02:29:45 -0000
Delivered-To: apmail-jakarta-tomcat-4.0-cvs@apache.org
Date: 26 Sep 2001 02:29:21 -0000
Message-ID: <20010926022921.19163.qmail@icarus.apache.org>
From: craigmcc@apache.org
To: jakarta-tomcat-4.0-cvs@apache.org
Subject: cvs commit: jakarta-tomcat-4.0/webapps/tomcat-docs/config engine.xml
 host.xml logger.xml server.xml service.xml valve.xml
X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N

craigmcc    01/09/25 19:29:21

  Modified:    webapps/tomcat-docs/config engine.xml host.xml logger.xml
                        server.xml service.xml valve.xml
  Log:
  Port documentation updates.
  
  Revision  Changes    Path
  1.2       +4 -0      jakarta-tomcat-4.0/webapps/tomcat-docs/config/engine.xml
  
  Index: engine.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/engine.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- engine.xml	2001/08/25 01:14:13	1.1
  +++ engine.xml	2001/09/26 02:29:21	1.2
  @@ -96,6 +96,10 @@
     have a name that matches the name specified for the
     <code>defaultHost</code> attribute, listed above.</p>
   
  +  <p>You can optional nest a <a href="defaultcontext.html">DefaultContext</a>
  +  element inside this <strong>Engine</strong> element, to define the default
  +  characteristics of web applications that are automatically deployed.</p>
  +
     <p>You can nest at most one instance of the following utility components
     by nesting a corresponding element inside your <strong>Engine</strong>
     element:</p>
  
  
  
  1.3       +4 -0      jakarta-tomcat-4.0/webapps/tomcat-docs/config/host.xml
  
  Index: host.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/host.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- host.xml	2001/08/27 20:22:37	1.2
  +++ host.xml	2001/09/26 02:29:21	1.3
  @@ -130,6 +130,10 @@
     single <a href="defaultcontext.html">DefaultContext</a> element that defines
     default values for subsequently deployed web applications.</p>
   
  +  <p>You can optional nest a <a href="defaultcontext.html">DefaultContext</a>
  +  element inside this <strong>Host</strong> element, to define the default
  +  characteristics of web applications that are automatically deployed.</p>
  +
     <p>You can nest at most one instance of the following utility components
     by nesting a corresponding element inside your <strong>Host</strong>
     element:</p>
  
  
  
  1.3       +8 -1      jakarta-tomcat-4.0/webapps/tomcat-docs/config/logger.xml
  
  Index: logger.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/logger.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- logger.xml	2001/08/27 20:22:37	1.2
  +++ logger.xml	2001/09/26 02:29:21	1.3
  @@ -23,6 +23,13 @@
     In addition, Loggers associated with an Engine or a Host are automatically
     inherited by lower-level containers, unless explicitly overridden.</p>
   
  +  <p>If you are interested in producing access logs like a web server does
  +  (for example, to run hit count analysis software), you will want to configure
  +  an <a href="valve.html#Access Log Valve">Access Log Valve</a> component on
  +  your <a href="engine.html#Access Logs">Engine</a>,
  +  <a href="host.html#Access Logs">Host</a>, or
  +  <a href="context.html#Access Logs">Context</a>.</p>
  +
     <p>For a more in-depth description of the class loader hierarchy
     that is implemented by Catalina, see <strong>FIXME - Reference</strong>.</p>
   
  @@ -53,7 +60,7 @@
           implement the <code>org.apache.catalina.Logger</code> interface.</p>
         </attribute>
   
  -      <attribute>
  +      <attribute name="verbosity" required="false">
           <p>The verbosity level for this logger.  Messages with a higher
           verbosity level than the specified value will be silently ignored.
           Available levels are 0 (fatal messages only), 1 (errors), 2
  
  
  
  1.3       +2 -3      jakarta-tomcat-4.0/webapps/tomcat-docs/config/server.xml
  
  Index: server.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/server.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- server.xml	2001/08/25 01:14:13	1.2
  +++ server.xml	2001/09/26 02:29:21	1.3
  @@ -67,9 +67,8 @@
   
   <section name="Nested Components">
   
  -  <p>No nested components may be embedded inside a <strong>Server</strong>,
  -  element, except for one or more <a href="service.html">Service</a> elements.
  -  </p>
  +  <p>The only components that may be nested inside a <strong>Server</strong>
  +  element are one or more <a href="service.html">Service</a> elements.</p>
   
   </section>
   
  
  
  
  1.3       +3 -4      jakarta-tomcat-4.0/webapps/tomcat-docs/config/service.xml
  
  Index: service.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/service.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- service.xml	2001/08/25 01:14:13	1.2
  +++ service.xml	2001/09/26 02:29:21	1.3
  @@ -66,10 +66,9 @@
   
   <section name="Nested Components">
   
  -  <p>No nested components may be embedded inside a <strong>Server</strong>,
  -  element, except for one or more <strong>Connector</strong> elements
  -  followed by a single <a href="engine.html">Engine</a> element.
  -  </p>
  +  <p>The only components that may be nested inside a <strong>Service</strong>
  +  element are one or more <strong>Connector</strong> elements,
  +  followed by exactly one <a href="engine.html">Engine</a> element.</p>
   
   </section>
   
  
  
  
  1.3       +78 -3     jakarta-tomcat-4.0/webapps/tomcat-docs/config/valve.xml
  
  Index: valve.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/config/valve.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- valve.xml	2001/08/27 20:22:37	1.2
  +++ valve.xml	2001/09/26 02:29:21	1.3
  @@ -61,7 +61,7 @@
   
         <attribute name="className" required="true">
           <p>Java class name of the implementation to use.  This MUST be set to
  -        <strong>org.apache.catalina.valve.AccessLogValve</strong>.</p>
  +        <strong>org.apache.catalina.valves.AccessLogValve</strong>.</p>
         </attribute>
   
         <attribute name="directory" required="false">
  @@ -164,7 +164,7 @@
   
         <attribute name="className" required="true">
           <p>Java class name of the implementation to use.  This MUST be set to
  -        <strong>org.apache.catalina.valve.RemoteAddrValve</strong>.</p>
  +        <strong>org.apache.catalina.valves.RemoteAddrValve</strong>.</p>
         </attribute>
   
         <attribute name="accept" required="false">
  @@ -215,7 +215,7 @@
   
         <attribute name="className" required="true">
           <p>Java class name of the implementation to use.  This MUST be set to
  -        <strong>org.apache.catalina.valve.RemoteHostValve</strong>.</p>
  +        <strong>org.apache.catalina.valves.RemoteHostValve</strong>.</p>
         </attribute>
   
         <attribute name="accept" required="false">
  @@ -238,6 +238,81 @@
       </attributes>
   
     </subsection>
  +
  +</section>
  +
  +
  +<section name="Request Dumper Valve">
  +
  +
  +  <subsection name="Introduction">
  +
  +    <p>The <em>Request Dumper Valve</em> is a useful tool in debugging
  +    interactions with a client application (or browser) that is sending
  +    HTTP requests to your Tomcat-based server.  When configured, it causes
  +    details about each request processed by its associated Engine, Host,
  +    or Context to be logged to the <a href="logger.html">Logger</a> that
  +    corresponds to that container.</p>
  +
  +  </subsection>
  +
  +
  +  <subsection name="Attributes">
  +
  +    <p>The <strong>Request Dumper 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.RequestDumperValve</strong>.</p>
  +      </attribute>
  +
  +    </attributes>
  +
  +  </subsection>
  +
  +
  +</section>
  +
  +
  +<section name="Single Sign On Valve">
  +
  +  <subsection name="Introduction">
  +
  +    <p>The <em>Single Sign On Vale</em> is utilized when you wish to give users
  +    the ability to sign on to any one of the web applications associated with
  +    your virtual host, and then have their identity recognized by all other
  +    web applications on the same virtual host.</p>
  +
  +    <p>See the <a href="host.html#Single Sign On">Single Sign On</a> special
  +    feature on the <strong>Host</strong> element for more information.</p>
  +
  +  </subsection>
  +
  +
  +  <subsection name="Attributes">
  +
  +    <p>The <strong>Single Sign On</strong> Valve 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.authenticator.SingleSignOn</strong>.</p>
  +      </attribute>
  +
  +      <attribute name="debug" required="false">
  +        <p>Detail level of debugging messages created by this component.  By
  +        default, this is set to zero (0), which means no debug output.</p>
  +      </attribute>
  +
  +    </attributes>
  +
  +  </subsection>
  +
   
   </section>