granicus.if.org Git - apache/blob - docs/manual/mod/mod_proxy_ajp.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_proxy_ajp - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.3</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_proxy_ajp</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_ajp.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../ja/mod/mod_proxy_ajp.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  26 <a href="../zh-cn/mod/mod_proxy_ajp.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
  27 </div>
  28 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>AJP support module for
  29 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></td></tr>
  30 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  31 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_ajp_module</td></tr>
  32 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_ajp.c</td></tr>
  33 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.1 and later</td></tr></table>
  34 <h3>Summary</h3>
  35
  36     <p>This module <em>requires</em> the service of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>. It provides support for the
  37     <code>Apache JServ Protocol version 1.3</code> (hereafter
  38     <em>AJP13</em>).</p>
  39
  40     <p>Thus, in order to get the ability of handling <code>AJP13</code>
  41     protocol, <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and
  42     <code class="module"><a href="../mod/mod_proxy_ajp.html">mod_proxy_ajp</a></code> have to be present in the server.</p>
  43
  44     <div class="warning"><h3>Warning</h3>
  45       <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
  46       servers are dangerous both to your network and to the Internet at
  47       large.</p>
  48     </div>
  49 </div>
  50 <div id="quickview"><h3 class="directives">Directives</h3>
  51 <p>This module provides no
  52             directives.</p>
  53 <h3>Topics</h3>
  54 <ul id="topics">
  55 <li><img alt="" src="../images/down.gif" /> <a href="#env">Environment Variables</a></li>
  56 <li><img alt="" src="../images/down.gif" /> <a href="#overviewprotocol">Overview of the protocol</a></li>
  57 <li><img alt="" src="../images/down.gif" /> <a href="#basppacketstruct">Basic Packet Structure</a></li>
  58 <li><img alt="" src="../images/down.gif" /> <a href="#rpacetstruct">Request Packet Structure</a></li>
  59 <li><img alt="" src="../images/down.gif" /> <a href="#resppacketstruct">Response Packet Structure</a></li>
  60 </ul><h3>See also</h3>
  61 <ul class="seealso">
  62 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
  63 <li><a href="../env.html">Environment Variable documentation</a></li>
  64 </ul></div>
  65 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  66 <div class="section">
  67 <h2><a name="env" id="env">Environment Variables</a></h2>
  68     <p>Environment variables whose names have the prefix <code>AJP_</code>
  69     are forwarded to the origin server as AJP request attributes
  70     (with the AJP_ prefix removed from the name of the key).</p>
  71 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  72 <div class="section">
  73 <h2><a name="overviewprotocol" id="overviewprotocol">Overview of the protocol</a></h2>
  74     <p>The <code>AJP13</code> protocol is packet-oriented.  A binary format
  75     was presumably chosen over the more readable plain text for reasons of
  76     performance.  The web server communicates with the servlet container over
  77     TCP connections.  To cut down on the expensive process of socket creation,
  78     the web server will attempt to maintain persistent TCP connections to the
  79     servlet container, and to reuse a connection for multiple request/response
  80     cycles.</p>
  81     <p>Once a connection is assigned to a particular request, it will not be
  82     used for any others until the request-handling cycle has terminated.  In
  83     other words, requests are not multiplexed over connections.  This makes
  84     for much simpler code at either end of the connection, although it does
  85     cause more connections to be open at once.</p>
  86     <p>Once the web server has opened a connection to the servlet container,
  87     the connection can be in one of the following states:</p>
  88     <ul>
  89     <li> Idle <br /> No request is being handled over this connection. </li>
  90     <li> Assigned <br /> The connecton is handling a specific request.</li>
  91     </ul>
  92     <p>Once a connection is assigned to handle a particular request, the basic
  93     request informaton (e.g. HTTP headers, etc) is sent over the connection in
  94     a highly condensed form (e.g. common strings are encoded as integers).
  95     Details of that format are below in Request Packet Structure. If there is a
  96     body to the request <code>(content-length &gt; 0)</code>, that is sent in a
  97     separate packet immediately after.</p>
  98     <p>At this point, the servlet container is presumably ready to start
  99     processing the request.  As it does so, it can send the
 100     following messages back to the web server:</p>
 101     <ul>
 102     <li>SEND_HEADERS <br />Send a set of headers back to the browser.</li>
 103     <li>SEND_BODY_CHUNK <br />Send a chunk of body data back to the browser.
 104     </li>
 105     <li>GET_BODY_CHUNK <br />Get further data from the request if it hasn't all
 106     been transferred yet.  This is necessary because the packets have a fixed
 107     maximum size and arbitrary amounts of data can be included the body of a
 108     request (for uploaded files, for example).  (Note: this is unrelated to
 109     HTTP chunked tranfer).</li>
 110     <li>END_RESPONSE <br /> Finish the request-handling cycle.</li>
 111     </ul>
 112     <p>Each message is accompanied by a differently formatted packet of data.
 113     See Response Packet Structures below for details.</p>
 114 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 115 <div class="section">
 116 <h2><a name="basppacketstruct" id="basppacketstruct">Basic Packet Structure</a></h2>
 117     <p>There is a bit of an XDR heritage to this protocol, but it differs
 118     in lots of ways (no 4 byte alignment, for example).</p>
 119     <p>Byte order: I am not clear about the endian-ness of the individual
 120     bytes.  I'm guessing the bytes are little-endian, because that's what
 121     XDR specifies, and I'm guessing that sys/socket library is magically
 122     making that so (on the C side).  If anyone with a better knowledge of
 123     socket calls can step in, that would be great.</p>
 124     <p>There are four data types in the protocol: bytes, booleans,
 125     integers and strings.</p>
 126     <dl>
 127     <dt><strong>Byte</strong></dt><dd>A single byte.</dd>
 128     <dt><strong>Boolean</strong></dt>
 129       <dd>A single byte, <code>1 = true</code>, <code>0 = false</code>.
 130       Using other non-zero values as true (i.e. C-style) may work in some places,
 131       but it won't in others.</dd>
 132     <dt><strong>Integer</strong></dt>
 133       <dd>A number in the range of <code>0 to 2^16 (32768)</code>.  Stored in
 134       2 bytes with the high-order byte first.</dd>
 135     <dt><strong>String</strong></dt>
 136       <dd>A variable-sized string (length bounded by 2^16). Encoded with
 137       the length packed into two bytes first, followed by the string
 138       (including the terminating '\0').  Note that the encoded length does
 139       <strong>not</strong> include the trailing '\0' -- it is like
 140       <code>strlen</code>.  This is a touch confusing on the Java side, which
 141       is littered with odd autoincrement statements to skip over these
 142       terminators.  I believe the reason this was done was to allow the C
 143       code to be extra efficient when reading strings which the servlet
 144       container is sending back -- with the terminating \0 character, the
 145       C code can pass around references into a single buffer, without copying.
 146       if the \0 was missing, the C code would have to copy things out in order
 147       to get its notion of a string.</dd>
 148     </dl>
 149
 150   <h3>Packet Size</h3>
 151     <p>According to much of the code, the max packet size is <code>
 152     8 * 1024 bytes (8K)</code>.  The actual length of the packet is encoded in
 153     the header.</p>
 154
 155   <h3>Packet Headers</h3>
 156     <p>Packets sent from the server to the container begin with
 157     <code>0x1234</code>.  Packets sent from the container to the server
 158     begin with <code>AB</code> (that's the ASCII code for A followed by the
 159     ASCII code for B).  After those first two bytes, there is an integer
 160     (encoded as above) with the length of the payload.  Although this might
 161     suggest that the maximum payload could be as large as 2^16, in fact, the
 162     code sets the maximum to be 8K.</p>
 163     <table>
 164       <tr>
 165         <td colspan="6"><em>Packet Format (Server-&gt;Container)</em></td>
 166       </tr>
 167       <tr>
 168         <td>Byte</td>
 169         <td>0</td>
 170         <td>1</td>
 171         <td>2</td>
 172         <td>3</td>
 173         <td>4...(n+3)</td>
 174       </tr>
 175       <tr>
 176         <td>Contents</td>
 177         <td>0x12</td>
 178         <td>0x34</td>
 179         <td colspan="2">Data Length (n)</td>
 180         <td>Data</td>
 181       </tr>
 182     </table>
 183     <table>
 184       <tr>
 185         <td colspan="6"><em>Packet Format (Container-&gt;Server)</em></td>
 186       </tr>
 187       <tr>
 188         <td>Byte</td>
 189         <td>0</td>
 190         <td>1</td>
 191         <td>2</td>
 192         <td>3</td>
 193         <td>4...(n+3)</td>
 194       </tr>
 195       <tr>
 196         <td>Contents</td>
 197         <td>A</td>
 198         <td>B</td>
 199         <td colspan="2">Data Length (n)</td>
 200         <td>Data</td>
 201       </tr>
 202     </table>
 203     <p>For most packets, the first byte of the payload encodes the type of
 204      message.  The exception is for request body packets sent from the server to
 205      the container -- they are sent with a standard packet header (<code>
 206      0x1234</code> and then length of the packet), but without any prefix code
 207      after that.</p>
 208      <p>The web server can send the following messages to the servlet
 209      container:</p>
 210     <table>
 211       <tr>
 212         <td>Code</td>
 213         <td>Type of Packet</td>
 214         <td>Meaning</td>
 215       </tr>
 216       <tr>
 217         <td>2</td>
 218         <td>Forward Request</td>
 219         <td>Begin the request-processing cycle with the following data</td>
 220       </tr>
 221       <tr>
 222         <td>7</td>
 223         <td>Shutdown</td>
 224         <td>The web server asks the container to shut itself down.</td>
 225       </tr>
 226       <tr>
 227         <td>8</td>
 228         <td>Ping</td>
 229         <td>The web server asks the container to take control
 230         (secure login phase).</td>
 231       </tr>
 232       <tr>
 233         <td>10</td>
 234         <td>CPing</td>
 235         <td>The web server asks the container to respond quickly with a CPong.
 236         </td>
 237       </tr>
 238       <tr>
 239         <td>none</td>
 240         <td>Data</td>
 241         <td>Size (2 bytes) and corresponding body data.</td>
 242       </tr>
 243     </table>
 244     <p>To ensure some basic security, the container will only actually do the
 245     <code>Shutdown</code> if the request comes from the same machine on which
 246     it's hosted.</p>
 247     <p>The first <code>Data</code> packet is send immediatly after the
 248     <code>Forward Request</code> by the web server.</p>
 249     <p>The servlet container can send the following types of messages to the
 250     webserver:</p>
 251     <table>
 252       <tr>
 253         <td>Code</td>
 254         <td>Type of Packet</td>
 255         <td>Meaning</td>
 256       </tr>
 257       <tr>
 258         <td>3</td>
 259         <td>Send Body Chunk</td>
 260         <td>Send a chunk of the body from the servlet container to the web
 261         server (and presumably, onto the browser). </td>
 262       </tr>
 263       <tr>
 264         <td>4</td>
 265         <td>Send Headers</td>
 266         <td>Send the response headers from the servlet container to the web
 267         server (and presumably, onto the browser).</td>
 268       </tr>
 269       <tr>
 270         <td>5</td>
 271         <td>End Response</td>
 272         <td>Marks the end of the response (and thus the request-handling cycle).
 273         </td>
 274       </tr>
 275       <tr>
 276         <td>6</td>
 277         <td>Get Body Chunk</td>
 278         <td>Get further data from the request if it hasn't all been
 279         transferred yet.</td>
 280       </tr>
 281       <tr>
 282         <td>9</td>
 283         <td>CPong Reply</td>
 284         <td>The reply to a CPing request</td>
 285       </tr>
 286     </table>
 287     <p>Each of the above messages has a different internal structure, detailed
 288     below.</p>
 289
 290 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 291 <div class="section">
 292 <h2><a name="rpacetstruct" id="rpacetstruct">Request Packet Structure</a></h2>
 293     <p>For messages from the server to the container of type
 294     <em>Forward Request</em>:</p>
 295     <div class="example"><pre>
 296 AJP13_FORWARD_REQUEST :=
 297     prefix_code      (byte) 0x02 = JK_AJP13_FORWARD_REQUEST
 298     method           (byte)
 299     protocol         (string)
 300     req_uri          (string)
 301     remote_addr      (string)
 302     remote_host      (string)
 303     server_name      (string)
 304     server_port      (integer)
 305     is_ssl           (boolean)
 306     num_headers      (integer)
 307     request_headers *(req_header_name req_header_value)
 308     attributes      *(attribut_name attribute_value)
 309     request_terminator (byte) OxFF
 310     </pre></div>
 311     <p>The <code>request_headers</code> have the following structure:
 312     </p><div class="example"><pre>
 313 req_header_name :=
 314     sc_req_header_name | (string)  [see below for how this is parsed]
 315
 316 sc_req_header_name := 0xA0xx (integer)
 317
 318 req_header_value := (string)
 319 </pre></div>
 320     <p>The <code>attributes</code> are optional and have the following
 321     structure:</p>
 322     <div class="example"><pre>
 323 attribute_name := sc_a_name | (sc_a_req_attribute string)
 324
 325 attribute_value := (string)
 326
 327     </pre></div>
 328     <p>Not that the all-important header is <code>content-length</code>,
 329     because it determines whether or not the container looks for another
 330     packet immediately.</p>
 331   <h3>Detailed description of the elements of Forward Request
 332   </h3>
 333   <h3>Request prefix</h3>
 334     <p>For all requests, this will be 2. See above for details on other Prefix
 335     codes.</p>
 336
 337   <h3>Method</h3>
 338     <p>The HTTP method, encoded as a single byte:</p>
 339     <table>
 340       <tr><td>Command Name</td><td>Code</td></tr>
 341       <tr><td>OPTIONS</td><td>1</td></tr>
 342       <tr><td>GET</td><td>2</td></tr>
 343       <tr><td>HEAD</td><td>3</td></tr>
 344       <tr><td>POST</td><td>4</td></tr>
 345       <tr><td>PUT</td><td>5</td></tr>
 346       <tr><td>DELETE</td><td>6</td></tr>
 347       <tr><td>TRACE</td><td>7</td></tr>
 348       <tr><td>PROPFIND</td><td>8</td></tr>
 349       <tr><td>PROPPATCH</td><td>9</td></tr>
 350       <tr><td>MKCOL</td><td>10</td></tr>
 351       <tr><td>COPY</td><td>11</td></tr>
 352       <tr><td>MOVE</td><td>12</td></tr>
 353       <tr><td>LOCK</td><td>13</td></tr>
 354       <tr><td>UNLOCK</td><td>14</td></tr>
 355       <tr><td>ACL</td><td>15</td></tr>
 356       <tr><td>REPORT</td><td>16</td></tr>
 357       <tr><td>VERSION-CONTROL</td><td>17</td></tr>
 358       <tr><td>CHECKIN</td><td>18</td></tr>
 359       <tr><td>CHECKOUT</td><td>19</td></tr>
 360       <tr><td>UNCHECKOUT</td><td>20</td></tr>
 361       <tr><td>SEARCH</td><td>21</td></tr>
 362       <tr><td>MKWORKSPACE</td><td>22</td></tr>
 363       <tr><td>UPDATE</td><td>23</td></tr>
 364       <tr><td>LABEL</td><td>24</td></tr>
 365       <tr><td>MERGE</td><td>25</td></tr>
 366       <tr><td>BASELINE_CONTROL</td><td>26</td></tr>
 367       <tr><td>MKACTIVITY</td><td>27</td></tr>
 368     </table>
 369     <p>Later version of ajp13, will transport
 370     additional methods, even if they are not in this list.</p>
 371
 372   <h3>protocol, req_uri, remote_addr, remote_host, server_name,
 373   server_port, is_ssl</h3>
 374     <p>These are all fairly self-explanatory.  Each of these is required, and
 375     will be sent for every request.</p>
 376
 377   <h3>Headers</h3>
 378     <p>The structure of <code>request_headers</code> is the following:
 379     First, the number of headers <code>num_headers</code> is encoded.
 380     Then, a series of header name <code>req_header_name</code> / value
 381     <code>req_header_value</code> pairs follows.
 382     Common header names are encoded as integers,
 383     to save space.  If the header name is not in the list of basic headers,
 384     it is encoded normally (as a string, with prefixed length).  The list of
 385     common headers <code>sc_req_header_name</code>and their codes
 386     is as follows (all are case-sensitive):</p>
 387     <table>
 388       <tr><td>Name</td><td>Code value</td><td>Code name</td></tr>
 389       <tr><td>accept</td><td>0xA001</td><td>SC_REQ_ACCEPT</td></tr>
 390       <tr><td>accept-charset</td><td>0xA002</td><td>SC_REQ_ACCEPT_CHARSET
 391       </td></tr>
 392       <tr><td>accept-encoding</td><td>0xA003</td><td>SC_REQ_ACCEPT_ENCODING
 393       </td></tr>
 394       <tr><td>accept-language</td><td>0xA004</td><td>SC_REQ_ACCEPT_LANGUAGE
 395       </td></tr>
 396       <tr><td>authorization</td><td>0xA005</td><td>SC_REQ_AUTHORIZATION</td>
 397       </tr>
 398       <tr><td>connection</td><td>0xA006</td><td>SC_REQ_CONNECTION</td></tr>
 399       <tr><td>content-type</td><td>0xA007</td><td>SC_REQ_CONTENT_TYPE</td>
 400       </tr>
 401       <tr><td>content-length</td><td>0xA008</td><td>SC_REQ_CONTENT_LENGTH</td>
 402       </tr>
 403       <tr><td>cookie</td><td>0xA009</td><td>SC_REQ_COOKIE</td></tr>
 404       <tr><td>cookie2</td><td>0xA00A</td><td>SC_REQ_COOKIE2</td></tr>
 405       <tr><td>host</td><td>0xA00B</td><td>SC_REQ_HOST</td></tr>
 406       <tr><td>pragma</td><td>0xA00C</td><td>SC_REQ_PRAGMA</td></tr>
 407       <tr><td>referer</td><td>0xA00D</td><td>SC_REQ_REFERER</td></tr>
 408       <tr><td>user-agent</td><td>0xA00E</td><td>SC_REQ_USER_AGENT</td></tr>
 409     </table>
 410     <p>The Java code that reads this grabs the first two-byte integer and if
 411     it sees an <code>'0xA0'</code> in the most significant
 412     byte, it uses the integer in the second byte as an index into an array of
 413     header names.  If the first byte is not <code>0xA0</code>, it assumes that
 414     the two-byte integer is the length of a string, which is then read in.</p>
 415     <p>This works on the assumption that no header names will have length
 416     greater than <code>0x9999 (==0xA000 - 1)</code>, which is perfectly
 417     reasonable, though somewhat arbitrary.</p>
 418     <div class="note"><h3>Note:</h3>
 419     The <code>content-length</code> header is extremely
 420     important.  If it is present and non-zero, the container assumes that
 421     the request has a body (a POST request, for example), and immediately
 422     reads a separate packet off the input stream to get that body.
 423     </div>
 424
 425   <h3>Attributes</h3>
 426     <p>The attributes prefixed with a <code>?</code>
 427     (e.g. <code>?context</code>) are all optional.  For each, there is a
 428     single byte code to indicate the type of attribute, and then its value
 429     (string or integer).  They can be sent in any order (though the C code
 430     always sends them in the order listed below).  A special terminating code
 431     is sent to signal the end of the list of optional attributes. The list of
 432     byte codes is:</p>
 433     <table>
 434       <tr><td>Information</td><td>Code Value</td><td>Type Of Value</td><td>Note</td></tr>
 435       <tr><td>?context</td><td>0x01</td><td>-</td><td>Not currently implemented
 436       </td></tr>
 437       <tr><td>?servlet_path</td><td>0x02</td><td>-</td><td>Not currently implemented
 438       </td></tr>
 439       <tr><td>?remote_user</td><td>0x03</td><td>String</td><td /></tr>
 440       <tr><td>?auth_type</td><td>0x04</td><td>String</td><td /></tr>
 441       <tr><td>?query_string</td><td>0x05</td><td>String</td><td /></tr>
 442       <tr><td>?jvm_route</td><td>0x06</td><td>String</td><td /></tr>
 443       <tr><td>?ssl_cert</td><td>0x07</td><td>String</td><td /></tr>
 444       <tr><td>?ssl_cipher</td><td>0x08</td><td>String</td><td /></tr>
 445       <tr><td>?ssl_session</td><td>0x09</td><td>String</td><td /></tr>
 446       <tr><td>?req_attribute</td><td>0x0A</td><td>String</td><td>Name (the name of the
 447       attribute follows)</td></tr>
 448       <tr><td>?ssl_key_size</td><td>0x0B</td><td>Integer</td><td /></tr>
 449       <tr><td>are_done</td><td>0xFF</td><td>-</td><td>request_terminator</td></tr>
 450     </table>
 451     <p>The <code>context</code> and <code>servlet_path</code> are not
 452     currently set by the C code, and most of the Java code completely ignores
 453     whatever is sent over for those fields (and some of it will actually break
 454     if a string is sent along after one of those codes).  I don't know if this
 455     is a bug or an unimplemented feature or just vestigial code, but it's
 456     missing from both sides of the connection.</p>
 457     <p>The <code>remote_user</code> and <code>auth_type</code> presumably
 458     refer to HTTP-level authentication, and communicate the remote user's
 459     username and the type of authentication used to establish their identity
 460     (e.g. Basic, Digest).</p>
 461     <p>The <code>query_string</code>, <code>ssl_cert</code>,
 462     <code>ssl_cipher</code>, and <code>ssl_session</code> refer to the
 463     corresponding pieces of HTTP and HTTPS.</p>
 464     <p>The <code>jvm_route</code>, is used to support sticky
 465     sessions -- associating a user's sesson with a particular Tomcat instance
 466     in the presence of multiple, load-balancing servers.</p>
 467     <p>Beyond this list of basic attributes, any number of other attributes
 468     can be sent via the <code>req_attribute</code> code <code>0x0A</code>.
 469     A pair of strings to represent the attribute name and value are sent
 470     immediately after each instance of that code.  Environment values are passed
 471     in via this method.</p>
 472     <p>Finally, after all the attributes have been sent, the attribute
 473     terminator, <code>0xFF</code>, is sent.  This signals both the end of the
 474     list of attributes and also then end of the Request Packet.</p>
 475
 476 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 477 <div class="section">
 478 <h2><a name="resppacketstruct" id="resppacketstruct">Response Packet Structure</a></h2>
 479     <p>for messages which the container can send back to the server.</p>
 480     <div class="example"><pre>
 481 AJP13_SEND_BODY_CHUNK :=
 482   prefix_code   3
 483   chunk_length  (integer)
 484   chunk        *(byte)
 485   chunk_terminator (byte) Ox00
 486
 487
 488 AJP13_SEND_HEADERS :=
 489   prefix_code       4
 490   http_status_code  (integer)
 491   http_status_msg   (string)
 492   num_headers       (integer)
 493   response_headers *(res_header_name header_value)
 494
 495 res_header_name :=
 496     sc_res_header_name | (string)   [see below for how this is parsed]
 497
 498 sc_res_header_name := 0xA0 (byte)
 499
 500 header_value := (string)
 501
 502 AJP13_END_RESPONSE :=
 503   prefix_code       5
 504   reuse             (boolean)
 505
 506
 507 AJP13_GET_BODY_CHUNK :=
 508   prefix_code       6
 509   requested_length  (integer)
 510     </pre></div>
 511   <h3>Details:</h3>
 512   <h3>Send Body Chunk</h3>
 513     <p>The chunk is basically binary data, and is sent directly back to the
 514     browser.</p>
 515
 516   <h3>Send Headers</h3>
 517     <p>The status code and message are the usual HTTP things
 518     (e.g. <code>200</code> and <code>OK</code>). The response header names are
 519     encoded the same way the request header names are. See header_encoding above
 520     for details about how the codes are distinguished from the strings.<br />
 521     The codes for common headers are:</p>
 522     <table>
 523       <tr><td>Name</td><td>Code value</td></tr>
 524       <tr><td>Content-Type</td><td>0xA001</td></tr>
 525       <tr><td>Content-Language</td><td>0xA002</td></tr>
 526       <tr><td>Content-Length</td><td>0xA003</td></tr>
 527       <tr><td>Date</td><td>0xA004</td></tr>
 528       <tr><td>Last-Modified</td><td>0xA005</td></tr>
 529       <tr><td>Location</td><td>0xA006</td></tr>
 530       <tr><td>Set-Cookie</td><td>0xA007</td></tr>
 531       <tr><td>Set-Cookie2</td><td>0xA008</td></tr>
 532       <tr><td>Servlet-Engine</td><td>0xA009</td></tr>
 533       <tr><td>Status</td><td>0xA00A</td></tr>
 534       <tr><td>WWW-Authenticate</td><td>0xA00B</td></tr>
 535     </table>
 536     <p> After the code or the string header name, the header value is
 537     immediately encoded.</p>
 538
 539   <h3>End Response</h3>
 540     <p>Signals the end of this request-handling cycle.  If the
 541     <code>reuse</code> flag is true <code>(==1)</code>, this TCP connection can
 542     now be used to handle new incoming requests.  If <code>reuse</code> is false
 543     (anything other than 1 in the actual C code), the connection should
 544     be closed.</p>
 545
 546   <h3>Get Body Chunk</h3>
 547     <p>The container asks for more data from the request (If the body was
 548     too large to fit in the first packet sent over or when the request is
 549     chuncked). The server will send a body packet back with an amount of data
 550     which is the minimum of the <code>request_length</code>, the maximum send
 551     body size <code>(8186 (8 Kbytes - 6))</code>, and the number of bytes
 552     actually left to send from the request body.<br />
 553     If there is no more data in the body (i.e. the servlet container is
 554     trying to read past the end of the body), the server will send back an
 555     <em>empty</em> packet, which is a body packet with a payload length of 0.
 556     <code>(0x12,0x34,0x00,0x00)</code></p>
 557
 558 </div>
 559 </div>
 560 <div class="bottomlang">
 561 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_ajp.html" title="English">&nbsp;en&nbsp;</a> |
 562 <a href="../ja/mod/mod_proxy_ajp.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 563 <a href="../zh-cn/mod/mod_proxy_ajp.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
 564 </div><div id="footer">
 565 <p class="apache">Copyright 2011 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 566 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 567 </body></html>