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