Author: pero
Date: Sun Sep 17 11:45:54 2006
New Revision: 447108

URL: http://svn.apache.org/viewvc?view=rev&rev=447108
Log:
Correct some documentation.

Modified:
    
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusAccessor.java
    
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusResetTask.java
    
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusUpdateTask.java
    
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/package.html

Modified: 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusAccessor.java
URL: 
http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusAccessor.java?view=diff&rev=447108&r1=447107&r2=447108
==============================================================================
--- 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusAccessor.java
 (original)
+++ 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusAccessor.java
 Sun Sep 17 11:45:54 2006
@@ -28,6 +28,8 @@
 import org.apache.tomcat.util.digester.Digester;
 
 /**
+ * Create connection to mod_jk jkstatus page.
+ * Optional you can use Http basic auth user and password.
  * @author Peter Rossbach
  * @version $Revision:$ $Date:$
  * @see org.apache.jk.status.JkStatusParser
@@ -83,7 +85,7 @@
      * @param url
      * @param username
      * @param password
-     * @return
+     * @return HttpConnection
      * @throws IOException
      * @throws MalformedURLException
      * @throws ProtocolException

Modified: 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusResetTask.java
URL: 
http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusResetTask.java?view=diff&rev=447108&r1=447107&r2=447108
==============================================================================
--- 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusResetTask.java
 (original)
+++ 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusResetTask.java
 Sun Sep 17 11:45:54 2006
@@ -23,7 +23,7 @@
 import org.apache.tools.ant.BuildException;
 
 /**
- * Ant task that implements the 
<code>/jkstatus?cmd=reset&amp;l=loadbalancer</code> command, supported by the
+ * Ant task that implements the 
<code>/jkstatus?cmd=reset&amp;w=loadbalancer</code> command, supported by the
  * mod_jk status (1.2.15) application.
  * 
  * @author Peter Rossbach

Modified: 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusUpdateTask.java
URL: 
http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusUpdateTask.java?view=diff&rev=447108&r1=447107&r2=447108
==============================================================================
--- 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusUpdateTask.java
 (original)
+++ 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/JkStatusUpdateTask.java
 Sun Sep 17 11:45:54 2006
@@ -357,15 +357,27 @@
      * 
</b>http://localhost/jkstatus?cmd=update&mime=txt&w=lb&lf=false&ls=true</li>
      * <li><b>worker example:
      * 
</b>http://localhost/jkstatus?cmd=update&mime=txt&w=node1&wn=node01&l=lb&wf=1&wa=1&wx=0
-     * <br/
+     * <br/>
      * <ul>
-     * <li>wa=1 activation</li>
+     * <li>wa=1 active</li>
      * <li>wa=2 disabled</li>
      * <li>wa=3 stopped</li>
      * </ul>
      * </li>
      * </ul>
+     *
+     * <br/>Loadbalacing parameter:
+     * <br/>
+     * <ul>
+     * <li><b>w:<b/> name lb worker</li>
+     * <li><b>lr:<b/> Number of Retries</li>
+     * <li><b>lt:<b/> recover wait time</li>
+     * <li><b>lf:<b/> Force Sticky Session</li>
+     * <li><b>ls:<b/> Sticky session</li>
+     * </ul>
      * 
+     * <br/>Tcp worker parameter:
+     * <br/>
      * <ul>
      * <li><b>w:<b/> name tcp worker node</li>
      * <li><b>l:<b/> name loadbalancer</li>

Modified: 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/package.html
URL: 
http://svn.apache.org/viewvc/tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/package.html?view=diff&rev=447108&r1=447107&r2=447108
==============================================================================
--- 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/package.html 
(original)
+++ 
tomcat/connectors/trunk/jk/jkstatus/src/share/org/apache/jk/status/package.html 
Sun Sep 17 11:45:54 2006
@@ -10,7 +10,8 @@
 exactly to the request parameters that are included with an HTTP request
 sent directly to jk status page.  They are summarized as follows:
 </p>
-
+
+<b>General parameter</b><br/>
 <table>
   <tr>
     <th align="center" width="15%">Attribute</th>
@@ -29,16 +30,179 @@
     <td align="center">username</td>
     <td>
       The username of a mod_jk status user that has been configured with the
-      <code>Allow user</code> Apache Location constraint.  This attribute is 
optional.
+      <code>Allow user</code> Apache Location constraint. This attribute is 
optional.
     </td>
   </tr>
   <tr>
     <td align="center">password</td>
     <td>
       The password of a mod_jk status user that has been configured with the
-      <code>Allow user</code> Apache Location constraint.  This attribute is 
optional.
+      <code>Allow user</code> Apache Location constraint. This attribute is 
optional.
     </td>
   </tr>
+  <tr>
+    <td align="center">resultProperty</td>
+    <td>
+         Bind all show results with this prefix property name. This attribute 
is optional.
+    </td>
+  </tr>
+  <tr>
+    <td align="center">echo</td>
+    <td>
+         show result at ant console. (default false)
+    </td>
+  </tr>
+  <tr>
+    <td align="center">errorProperty</td>
+    <td>
+         set this property, as a failure detected. This attribute is optional.
+    </td>
+  </tr>
 </table>
+
+<b>Command show parameter</b><br/>
+<table>
+  <tr>
+    <th align="center" width="15%">Attribute</th>
+    <th align="center" width="85%">Description</th>
+  </tr>
+  <tr>
+    <td align="center">worker</td>
+    <td>
+      only bind properties from this balancer tcp worker (node)
+    </td>
+  </tr>
+  <tr>
+    <td align="center">loadbalancer</td>
+    <td>
+      only bind properties from this loadbalancer worker
+    </td>
+  </tr>
+</table>
+
+<b>Command reset parameter</b><br/>
+<table>
+  <tr>
+    <th align="center" width="15%">Attribute</th>
+    <th align="center" width="85%">Description</th>
+  </tr>
+  <tr>
+    <td align="center">workerLb</td>
+    <td>
+      name of loadbalancer worker.
+    </td>
+  </tr>
+</table>
+
+<b>Command update loadbalancer parameter</b><br/>
+<table>
+  <tr>
+    <th align="center" width="15%">Attribute</th>
+    <th align="center" width="85%">Description</th>
+  </tr>
+  <tr>
+    <td align="center">workerType=loadbalancer</td>
+    <td>
+      type of update
+    </td>
+  </tr>
+  <tr>
+    <td align="center">workerLb</td>
+    <td>
+      name of loadbalancer worker.
+    </td>
+  </tr>
+  <tr>
+    <td align="center">lbForceSession</td>
+    <td>
+      Force Sticky Session. (true/false)
+    </td>
+  </tr>
+  <tr>
+    <td align="center">lbStickySession</td>
+    <td>
+      Sticky Session. (true/false)
+    </td>
+  </tr>
+  <tr>
+    <td align="center">lbRetries</td>
+    <td>
+      loadbalancer retries after worker connection failure (int)
+    </td>
+  </tr>
+  <tr>
+    <td align="center">lbRecovertime</td>
+    <td>
+      Recover timeout after a worker set to "error" state (int sec's)
+    </td>
+  </tr>
+</table>
+
+<b>Command update worker parameter</b><br/>
+<table>
+  <tr>
+    <th align="center" width="15%">Attribute</th>
+    <th align="center" width="85%">Description</th>
+  </tr>
+  <tr>
+    <td align="center">workerType=worker</td>
+    <td>
+      type of update
+    </td>
+  </tr>
+  <tr>
+    <td align="center">worker</td>
+    <td>
+      name of tcp worker.
+    </td>
+  </tr>
+  <tr>
+    <td align="center">workerActivation (>=1.2.19</td>
+    <td>
+      set worker activation  (1 Active, 2 Disabled, 3 Stopped)
+    </td>
+  </tr>
+  <tr>
+    <td align="center">workerDisabled (< 1.2.19)</td>
+    <td>
+      set disable state. (true/false)
+    </td>
+  </tr>
+  <tr>
+    <td align="center">workerStoppend (< 1.2.19)</td>
+    <td>
+      set stopped state. (true/false)      
+    </td>
+  </tr>
+  <tr>
+    <td align="center">workerJvmRoute</td>
+    <td>
+      set jvm route
+    </td>
+  </tr>
+  <tr>
+    <td align="center">workerLaodFactor</td>
+    <td>
+      set load factor (int)
+    </td>
+  </tr>
+  <tr>
+    <td align="center">workerDistance</td>
+    <td>
+      set worker distance (int)
+    </td>
+  <tr>
+    <td align="center">workerRedirect</td>
+    <td>
+      other worker name to redirect after failure
+    </td>
+  </tr>
+  <tr>
+    <td align="center">workerClusterDomain</td>
+    <td>
+      cluster domain name, group of worker at a repliation cluster.
+    </td>
+  </tr>
+</table>
 
 </body>



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to