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