From 1c73781263dfa6387757ebd1ae8b90da3be9f4f2 Mon Sep 17 00:00:00 2001
From: kkolinko <kkolinko@13f79535-47bb-0310-9956-ffa450edef68>
Date: Wed, 2 Feb 2011 05:37:52 +0000
Subject: [PATCH] Correct documentation for the PersistentManager class: there
 is no "randomClass" attribute, but several others were added. Move attributes
 defined in the Manager interface into the Common Attributes section.

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@1066329 13f79535-47bb-0310-9956-ffa450edef68
---
 webapps/docs/config/manager.xml | 101 +++++++++++++++++++---------------------
 1 file changed, 47 insertions(+), 54 deletions(-)

diff --git a/webapps/docs/config/manager.xml b/webapps/docs/config/manager.xml
index 22e37c482..01a0edcc0 100644
--- a/webapps/docs/config/manager.xml
+++ b/webapps/docs/config/manager.xml
@@ -77,6 +77,30 @@
         deployment descriptor (<code>/WEB-INF/web.xml</code>).</p>
       </attribute>
 
+      <attribute name="maxActiveSessions" required="false">
+        <p>The maximum number of active sessions that will be created by
+        this Manager, or -1 (the default) for no limit.</p>
+      </attribute>
+
+      <attribute name="maxInactiveInterval" required="false">
+        <p>The initial maximum time interval, in seconds, 
+        between client requests before a session is invalidated. A negative value
+        will result in sessions never timing out. If the attribute is not provided,
+        a default of 60 seconds is used.</p>
+        
+        <p>This attribute provides the initial value whenever a 
+        new session is created, but the interval may be dynamically 
+        varied by a servlet via the 
+        <code>setMaxInactiveInterval</code> method of the <code>HttpSession</code> object.</p>
+      </attribute>
+
+      <attribute name="sessionIdLength" required="false">
+       <p>The length of session ids created by this Manager, measured in bytes,
+        excluding subsequent conversion to a hexadecimal string and
+        excluding any JVM route information used for load balancing.
+        The default is 16.</p>
+      </attribute>
+
     </attributes>
 
   </subsection>
@@ -99,23 +123,6 @@
 
     <attributes>
 
-      <attribute name="maxActiveSessions" required="false">
-        <p>The maximum number of active sessions that will be created by
-        this Manager, or -1 (the default) for no limit.</p>
-      </attribute>
-
-      <attribute name="maxInactiveInterval" required="false">
-        <p>The initial maximum time interval, in seconds, 
-        between client requests before a session is invalidated. A negative value
-        will result in sessions never timing out. If the attribute is not provided,
-        a default of 60 seconds is used.</p>
-        
-        <p>This attribute provides the initial value whenever a 
-        new session is created, but the interval may be dynamically 
-        varied by a servlet via the 
-        <code>setMaxInactiveInterval</code> method of the <code>HttpSession</code> object.</p>
-      </attribute>
-
       <attribute name="pathname" required="false">
         <p>Absolute or relative (to the work directory for this Context)
         pathname of the file in which session state will be preserved
@@ -160,13 +167,6 @@
         string.</p>
       </attribute>
 
-      <attribute name="sessionIdLength" required="false">
-       <p>The length of session ids created by this Manager, measured in bytes,
-        excluding subsequent conversion to a hexadecimal string and
-        excluding any JVM route information used for load balancing.
-        The default is 16.</p>
-      </attribute>
-
     </attributes>
 
     <h3>Persistent Manager Implementation</h3>
@@ -193,19 +193,14 @@
 
     <attributes>
 
-      <attribute name="className" required="false">
-        <p>Java class name of the implementation to use.  This class must
-        implement the <code>org.apache.catalina.Manager</code> interface.
+      <attribute name="className" required="true">
+        <p>It has the same meaning as described in the
+        <a href="#Common Attributes">Common Attributes</a> above.
         You <strong>must</strong> specify
         <code>org.apache.catalina.session.PersistentManager</code> to use
         this manager implementation.</p>
       </attribute>
 
-      <attribute name="maxActiveSessions" required="false">
-        <p>The maximum number of active sessions that will be created by
-        this Manager, or -1 (the default) for no limit.</p>
-      </attribute>
-
       <attribute name="maxIdleBackup" required="false">
         <p>The time interval (in seconds) since the last access to a session
         before it is eligible for being persisted to the session store, or
@@ -231,23 +226,10 @@
         this value is set to <code>-1</code>.</p>
       </attribute>
 
-      <attribute name="maxInactiveInterval" required="false">
-        <p>The initial maximum time interval, in seconds, 
-        between client requests before a session is invalidated. A negative value
-        will result in sessions never timing out. If the attribute is not provided,
-        a default of 60 seconds is used.</p>
-        
-        <p>This attribute provides the initial value whenever a 
-        new session is created, but the interval may be dynamically 
-        varied by a servlet via the 
-        <code>setMaxInactiveInterval</code>method of the <code>HttpSession</code> object.</p>
-      </attribute>
-
-      <attribute name="randomClass" required="false">
-        <p>Name of the Java class that extends
-        <code>java.security.SecureRandom</code> to use to generate session IDs.
-        If not specified, the default value is
-        <code>java.security.SecureRandom</code>.</p>
+      <attribute name="processExpiresFrequency" required="false">
+        <p>It is the same as described above for the
+        <code>org.apache.catalina.session.StandardManager</code> class.
+        </p>
       </attribute>
 
       <attribute name="saveOnRestart" required="false">
@@ -256,13 +238,24 @@
         this attribute is set to <code>true</code>.</p>
       </attribute>
 
-      <attribute name="sessionIdLength" required="false">
-       <p>The length of session ids created by this Manager, measured in bytes,
-        excluding subsequent conversion to a hexadecimal string and
-        excluding any JVM route information used for load balancing.
-        The default is 16.</p>
+
+      <attribute name="secureRandomClass" required="false">
+        <p>It is the same as described above for the
+        <code>org.apache.catalina.session.StandardManager</code> class.
+        </p>
       </attribute>
 
+      <attribute name="secureRandomProvider" required="false">
+        <p>It is the same as described above for the
+        <code>org.apache.catalina.session.StandardManager</code> class.
+        </p>
+      </attribute>
+
+      <attribute name="secureRandomAlgorithm" required="false">
+        <p>It is the same as described above for the
+        <code>org.apache.catalina.session.StandardManager</code> class.
+        </p>
+      </attribute>
     </attributes>
 
     <p>In order to successfully use a PersistentManager, you must nest inside
-- 
2.11.0