rubbos/app/tomcat-connectors-1.2.32-src/jkstatus/src/share/org/apache/jk/status/package.html

   1 <!--
   2   Licensed to the Apache Software Foundation (ASF) under one or more
   3   contributor license agreements.  See the NOTICE file distributed with
   4   this work for additional information regarding copyright ownership.
   5   The ASF licenses this file to You under the Apache License, Version 2.0
   6   (the "License"); you may not use this file except in compliance with
   7   the License.  You may obtain a copy of the License at
   8
   9       http://www.apache.org/licenses/LICENSE-2.0
  10
  11   Unless required by applicable law or agreed to in writing, software
  12   distributed under the License is distributed on an "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14   See the License for the specific language governing permissions and
  15   limitations under the License.
  16 -->
  17 <body>
  18
  19 <p>This package contains a set of <code>Task</code> implementations for
  20 <em>Ant (version 1.6.x or later)</em> that can be used to interact with the
  21 Apaache mod_jk status page to show, update, disable and stop mod_jk worker.
  22 For more information, see
  23 <a href="http://tomcat.apache.org/connectors-doc/index.html"><strong>JK Documenation</strong></a>.</p>
  24
  25 <p>The attributes of each task element correspond
  26 exactly to the request parameters that are included with an HTTP request
  27 sent directly to jk status page.  They are summarized as follows:
  28 </p>
  29
  30 <b>General parameter</b><br/>
  31 <table>
  32   <tr>
  33     <th align="center" width="15%">Attribute</th>
  34     <th align="center" width="85%">Description</th>
  35   </tr>
  36   <tr>
  37     <td align="center">url</td>
  38     <td>
  39       The URL of the jk status page you will use to
  40       perform the requested operations.  If not specified, defaults to
  41       <code>http://localhost:80/jkstatus</code> (which corresponds
  42       to a standard installation of Apache mod_jk).
  43     </td>
  44   </tr>
  45   <tr>
  46     <td align="center">username</td>
  47     <td>
  48       The username of a mod_jk status user that has been configured with the
  49       <code>Allow user</code> Apache Location constraint. This attribute is optional.
  50     </td>
  51   </tr>
  52   <tr>
  53     <td align="center">password</td>
  54     <td>
  55       The password of a mod_jk status user that has been configured with the
  56       <code>Allow user</code> Apache Location constraint. This attribute is optional.
  57     </td>
  58   </tr>
  59   <tr>
  60     <td align="center">resultProperty</td>
  61     <td>
  62           Bind all show results with this prefix property name. This attribute is optional.
  63     </td>
  64   </tr>
  65   <tr>
  66     <td align="center">echo</td>
  67     <td>
  68           show result at ant console. (default false)
  69     </td>
  70   </tr>
  71   <tr>
  72     <td align="center">errorProperty</td>
  73     <td>
  74           set this property, as a failure detected. This attribute is optional.
  75     </td>
  76   </tr>
  77 </table>
  78
  79 <b>Command show parameter</b><br/>
  80 <table>
  81   <tr>
  82     <th align="center" width="15%">Attribute</th>
  83     <th align="center" width="85%">Description</th>
  84   </tr>
  85   <tr>
  86     <td align="center">worker</td>
  87     <td>
  88       only bind properties from this balancer tcp worker (node)
  89     </td>
  90   </tr>
  91   <tr>
  92     <td align="center">loadbalancer</td>
  93     <td>
  94       only bind properties from this loadbalancer worker
  95     </td>
  96   </tr>
  97 </table>
  98
  99 <b>Command reset parameter</b><br/>
 100 <table>
 101   <tr>
 102     <th align="center" width="15%">Attribute</th>
 103     <th align="center" width="85%">Description</th>
 104   </tr>
 105   <tr>
 106     <td align="center">workerLb</td>
 107     <td>
 108       name of loadbalancer worker.
 109     </td>
 110   </tr>
 111 </table>
 112
 113 <b>Command update loadbalancer parameter</b><br/>
 114 <table>
 115   <tr>
 116     <th align="center" width="15%">Attribute</th>
 117     <th align="center" width="85%">Description</th>
 118   </tr>
 119   <tr>
 120     <td align="center">workerType=loadbalancer</td>
 121     <td>
 122       type of update
 123     </td>
 124   </tr>
 125   <tr>
 126     <td align="center">workerLb</td>
 127     <td>
 128       name of loadbalancer worker.
 129     </td>
 130   </tr>
 131   <tr>
 132     <td align="center">lbForceSession</td>
 133     <td>
 134       Force Sticky Session. (true/false)
 135     </td>
 136   </tr>
 137   <tr>
 138     <td align="center">lbStickySession</td>
 139     <td>
 140       Sticky Session. (true/false)
 141     </td>
 142   </tr>
 143   <tr>
 144     <td align="center">lbRetries</td>
 145     <td>
 146       loadbalancer retries after worker connection failure (int)
 147     </td>
 148   </tr>
 149   <tr>
 150     <td align="center">lbRecovertime</td>
 151     <td>
 152       Recover timeout after a worker set to "error" state (int sec's)
 153     </td>
 154   </tr>
 155 </table>
 156
 157 <b>Command update worker parameter</b><br/>
 158 <table>
 159   <tr>
 160     <th align="center" width="15%">Attribute</th>
 161     <th align="center" width="85%">Description</th>
 162   </tr>
 163   <tr>
 164     <td align="center">workerType=worker</td>
 165     <td>
 166       type of update
 167     </td>
 168   </tr>
 169   <tr>
 170     <td align="center">worker</td>
 171     <td>
 172       name of tcp worker.
 173     </td>
 174   </tr>
 175   <tr>
 176     <td align="center">workerActivation (>=1.2.19</td>
 177     <td>
 178       set worker activation  (1 Active, 2 Disabled, 3 Stopped)
 179     </td>
 180   </tr>
 181   <tr>
 182     <td align="center">workerDisabled (< 1.2.19)</td>
 183     <td>
 184       set disable state. (true/false)
 185     </td>
 186   </tr>
 187   <tr>
 188     <td align="center">workerStoppend (< 1.2.19)</td>
 189     <td>
 190       set stopped state. (true/false)
 191     </td>
 192   </tr>
 193   <tr>
 194     <td align="center">workerJvmRoute</td>
 195     <td>
 196       set jvm route
 197     </td>
 198   </tr>
 199   <tr>
 200     <td align="center">workerLaodFactor</td>
 201     <td>
 202       set load factor (int)
 203     </td>
 204   </tr>
 205   <tr>
 206     <td align="center">workerDistance</td>
 207     <td>
 208       set worker distance (int)
 209     </td>
 210   <tr>
 211     <td align="center">workerRedirect</td>
 212     <td>
 213       other worker name to redirect after failure
 214     </td>
 215   </tr>
 216   <tr>
 217     <td align="center">workerClusterDomain</td>
 218     <td>
 219       cluster domain name, group of worker at a repliation cluster.
 220     </td>
 221   </tr>
 222 </table>
 223
 224 </body>