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