Annotation of 2006/webapi/XMLHttpRequest/Overview.src.html, revision 1.277
1.248 avankest 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
1.1 avankest 2: <html lang="en-US">
3: <head>
1.207 avankest 4: <title>XMLHttpRequest</title>
1.16 avankest 5: <style type="text/css">
1.117 avankest 6: pre.idl { border:solid thin; background:#eee; color:#000; padding:0.5em }
1.16 avankest 7: pre.idl :link, pre.idl :visited { color:inherit; background:transparent }
1.58 avankest 8: pre code { color:inherit; background:transparent }
1.16 avankest 9: div.example { margin-left:1em; padding-left:1em; border-left:double; color:#222; background:#fcfcfc }
1.89 avankest 10: .note { margin-left:2em; font-weight:bold; font-style:italic; color:#008000 }
1.16 avankest 11: p.note::before { content:"Note: " }
1.203 avankest 12: .XXX { padding:.5em; border:solid #f00 }
13: p.XXX::before { content:"Issue: " }
1.119 avankest 14: dl.switch { padding-left:2em }
1.248 avankest 15: dl.switch > dt { text-indent:-1.5em }
16: dl.switch > dt:before { content:'21円AA'; padding:0 0.5em 0 0; display:inline-block; width:1em; text-align:right; line-height:0.5em }
1.269 avankest 17: dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #DDFFDD; }
18: dl.domintro dt, dl.domintro dt * { color: black; text-decoration: none; }
19: dl.domintro dd { margin: 0.5em 0 1em 2em; padding: 0; }
20: dl.domintro dd p { margin: 0.5em 0; }
21: dl.domintro:before { display: table; margin: -1em -0.5em -0.5em auto; width: auto; content: 'This box is non-normative. Implementation requirements are given below this box.'; color: red; border: solid 2px; background: white; padding: 0 0.25em; }
1.16 avankest 22: em.ct { text-transform:lowercase; font-variant:small-caps; font-style:normal }
23: dfn { font-weight:bold; font-style:normal }
24: code { color:orangered }
25: code :link, code :visited { color:inherit }
1.203 avankest 26: hr:not(.top) { display:block; background:none; border:none; padding:0; margin:2em 0; height:auto }
27: table { border-collapse:collapse; border-style:hidden hidden none hidden }
28: table thead { border-bottom:solid }
29: table tbody th:first-child { border-left:solid }
30: table td, table th { border-left:solid; border-right:solid; border-bottom:solid thin; vertical-align:top; padding:0.2em }
1.16 avankest 31: </style>
1.147 avankest 32: <link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-[STATUS]">
1.1 avankest 33: </head>
34: <body>
35: <div class="head">
36: <p><a href="http://www.w3.org/"><img height="48" width="72" alt="W3C" src="http://www.w3.org/Icons/w3c_home"></a></p>
1.12 avankest 37:
1.229 avankest 38: <h1 class="head" id="the-xmlhttprequest-object">XMLHttpRequest</h1>
1.248 avankest 39:
1.12 avankest 40:
1.149 avankest 41: <h2 class="no-num no-toc" id="w3c-doctype">[LONGSTATUS] [DATE: 3 August 2002]</h2>
1.12 avankest 42:
1.1 avankest 43: <dl>
1.10 avankest 44: <dt>This Version:</dt>
1.246 avankest 45: <dd><a href="[VERSION]/">http://www.w3.org/TR/[YEAR]/ED-XMLHttpRequest-[CDATE]/</a></dd>
1.14 avankest 46:
1.10 avankest 47: <dt>Latest Version:</dt>
1.1 avankest 48: <dd><a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a></dd>
1.203 avankest 49:
1.189 avankest 50: <dt>Latest Editor Version:</dt>
51: <dd><a href="http://dev.w3.org/2006/webapi/XMLHttpRequest/">http://dev.w3.org/2006/webapi/XMLHttpRequest/</a></dd>
1.14 avankest 52:
1.10 avankest 53: <dt>Previous Versions:</dt>
1.248 avankest 54:
1.231 avankest 55: <dd><a href="http://www.w3.org/TR/2009/WD-XMLHttpRequest-20090820/">http://www.w3.org/TR/2009/WD-XMLHttpRequest-20090820/</a></dd>
1.173 avankest 56: <dd><a href="http://www.w3.org/TR/2008/WD-XMLHttpRequest-20080415/">http://www.w3.org/TR/2008/WD-XMLHttpRequest-20080415/</a></dd>
1.154 avankest 57: <dd><a href="http://www.w3.org/TR/2007/WD-XMLHttpRequest-20071026/">http://www.w3.org/TR/2007/WD-XMLHttpRequest-20071026/</a></dd>
1.133 avankest 58: <dd><a href="http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070618/">http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070618/</a></dd>
1.58 avankest 59: <dd><a href="http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070227/">http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070227/</a></dd>
1.22 avankest 60: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060927/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060927/</a></dd>
1.1 avankest 61: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/</a></dd>
62: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/</a></dd>
1.248 avankest 63:
64:
1.14 avankest 65:
1.1 avankest 66: <dt>Editor:</dt>
67: <dd><a href="http://annevankesteren.nl/">Anne van Kesteren</a>
68: (<a href="http://www.opera.com/">Opera Software ASA</a>)
69: <<a href="mailto:annevk@opera.com">annevk@opera.com</a>></dd>
70: </dl>
1.14 avankest 71:
1.1 avankest 72: <p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a>
1.229 avankest 73: © 2009
1.51 avankest 74: <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a><sup>®</sup>
75: (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>,
76: <a href="http://www.ercim.org/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>,
77: <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C
78: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
79: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>
80: and
81: <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document
82: use</a> rules apply.</p>
1.1 avankest 83: </div>
1.12 avankest 84:
1.1 avankest 85: <hr>
1.12 avankest 86:
1.1 avankest 87: <h2 class="no-num no-toc" id="specabstract">Abstract</h2>
1.10 avankest 88:
1.248 avankest 89:
90:
1.229 avankest 91: <p>The XMLHttpRequest specification defines an API
1.207 avankest 92: that provides scripted client functionality for transferring data between
93: a client and a server.</p>
1.248 avankest 94:
1.12 avankest 95:
1.1 avankest 96: <h2 class="no-num no-toc" id="sotd">Status of this Document</h2>
1.12 avankest 97:
1.1 avankest 98: <p><em>This section describes the status of this document at the time of its
1.36 avankest 99: publication. Other documents may supersede this document. A list of current
100: W3C publications and the latest revision of this technical report can be
101: found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a>
1.117 avankest 102: at http://www.w3.org/TR/.</em></p>
1.36 avankest 103:
1.248 avankest 104: <p>This is the [DATE: 3 August 2002] <!--Last Call Working Draft-->[LONGSTATUS] of
105: XMLHttpRequest. Please send comments to
106: <a href="mailto:public-webapps@w3.org?subject=[XHR]%20">public-webapps@w3.org</a>
1.207 avankest 107: (<a href="http://lists.w3.org/Archives/Public/public-webapps/">archived</a>)
1.248 avankest 108: with <samp>[XHR]</samp> at the start of the subject line.</p>
1.51 avankest 109:
1.47 avankest 110: <p>This document is produced by the
1.248 avankest 111: <a href="http://www.w3.org/2008/webapps/">Web Applications</a> (WebApps) Working Group.
112: The WebApps Working Group is part of the
1.207 avankest 113: <a href="http://www.w3.org/2006/rwc/Activity">Rich Web Clients Activity</a>
1.248 avankest 114: in the W3C <a href="http://www.w3.org/Interaction/">Interaction Domain</a>.</p>
1.12 avankest 115:
1.1 avankest 116: <p>This document was produced by a group operating under the
1.248 avankest 117: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February 2004
118: W3C Patent Policy</a>. W3C maintains a
1.207 avankest 119: <a rel="disclosure" href="http://www.w3.org/2004/01/pp-impl/42538/status">public
1.248 avankest 120: list of any patent disclosures</a> made in connection with the deliverables of
121: the group; that page also includes instructions for disclosing a patent. An
122: individual who has actual knowledge of a patent which the individual believes
123: contains
1.36 avankest 124: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential
125: Claim(s)</a> must disclose the information in accordance with
126: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section
127: 6 of the W3C Patent Policy</a>.</p>
1.12 avankest 128:
1.248 avankest 129: <p>Publication as a Working Draft does not imply endorsement by the W3C
130: Membership. This is a draft document and may be updated, replaced or
131: obsoleted by other documents at any time. It is inappropriate to cite this
132: document as other than work in progress.</p>
1.268 avankest 133:
134:
135: <h3 class="no-num no-toc" id="crec">Candidate Recommendation Exit Criteria</h3>
136:
137: <p>To exit the Candidate Recommendation (CR) stage the following criteria
138: <em class="ct">must</em> have been met:</p>
139:
140: <ol>
141: <li>There will be at least two interoperable implementations passing all
142: test cases in the test suite for this specification. An implementation is
143: to be available (i.e. for download), shipping (i.e. not private), and not
144: experimental (i.e. intended for a wide audience). The working group will
145: decide when the test suite is of sufficient quality to test
146: interoperability.</li>
147:
148: <li>A minimum of six months of the CR stage will have elapsed. This is to
149: ensure that enough time is given for any remaining major errors to be
150: caught. The CR period will be extended if implementations are slow to
151: appear.</li>
152: </ol>
153:
154: <p>An update to this draft will point to the test suite.</p>
155:
1.207 avankest 156:
157:
1.1 avankest 158: <h2 class="no-num no-toc" id="toc">Table of Contents</h2>
1.21 avankest 159:
1.1 avankest 160: <!--toc-->
1.12 avankest 161:
1.207 avankest 162:
163:
1.1 avankest 164: <h2 id="introduction">Introduction</h2>
1.12 avankest 165:
1.1 avankest 166: <p><em>This section is non-normative.</em></p>
1.12 avankest 167:
1.183 avankest 168: <p>The <code>XMLHttpRequest</code> object implements an interface exposed
169: by a scripting engine that allows scripts to perform HTTP client
170: functionality, such as submitting form data or loading data from a
171: server. It is the ECMAScript HTTP API.</p>
1.24 avankest 172:
1.1 avankest 173: <p>The name of the object is <code>XMLHttpRequest</code> for compatibility
1.183 avankest 174: with the Web, though each component of this name is potentially
175: misleading. First, the object supports any text based format, including
176: XML. Second, it can be used to make requests over both HTTP and HTTPS
177: (some implementations support protocols in addition to HTTP and HTTPS, but
178: that functionality is not covered by this specification). Finally, it
179: supports "requests" in a broad sense of the term as it pertains to HTTP;
180: namely all activity involved with HTTP requests or responses for the
181: defined HTTP methods.</p>
1.12 avankest 182:
1.14 avankest 183: <div class="example">
1.250 avankest 184: <p>Some simple code to do something with data from an XML document
185: fetched over the network:</p>
1.16 avankest 186:
1.58 avankest 187: <pre><code>function test(data) {
1.14 avankest 188: // taking care of data
189: }
190:
191: function handler() {
1.117 avankest 192: if(this.readyState == 4 && this.status == 200) {
1.14 avankest 193: // so far so good
1.117 avankest 194: if(this.responseXML != null && this.responseXML.getElementById('test').firstChild.data)
195: // success!
1.14 avankest 196: test(this.responseXML.getElementById('test').firstChild.data);
197: else
198: test(null);
1.117 avankest 199: } else if (this.readyState == 4 && this.status != 200) {
1.14 avankest 200: // fetched the wrong page or network error...
201: test(null);
202: }
203: }
1.12 avankest 204:
1.14 avankest 205: var client = new XMLHttpRequest();
206: client.onreadystatechange = handler;
1.250 avankest 207: client.open("GET", "unicorn.xml");
1.58 avankest 208: client.send();</code></pre>
1.16 avankest 209:
1.56 avankest 210: <p>If you just want to log a message to the server:</p>
1.16 avankest 211:
1.58 avankest 212: <pre><code>function log(message) {
1.14 avankest 213: var client = new XMLHttpRequest();
1.56 avankest 214: client.open("POST", "/log");
1.57 avankest 215: client.setRequestHeader("Content-Type", "text/plain;charset=UTF-8");
1.14 avankest 216: client.send(message);
1.58 avankest 217: }</code></pre>
1.16 avankest 218:
1.14 avankest 219: <p>Or if you want to check the status of a document on the server:</p>
1.16 avankest 220:
1.58 avankest 221: <pre><code>function fetchStatus(address) {
1.14 avankest 222: var client = new XMLHttpRequest();
223: client.onreadystatechange = function() {
224: // in case of network errors this might not give reliable results
225: if(this.readyState == 4)
226: returnStatus(this.status);
227: }
228: client.open("HEAD", address);
229: client.send();
1.58 avankest 230: }</code></pre>
1.14 avankest 231: </div>
1.12 avankest 232:
1.203 avankest 233:
234:
1.248 avankest 235:
236: <h2 id="conformance">Conformance Criteria</h2>
1.12 avankest 237:
1.27 avankest 238: <p>Everything in this specification is normative except for diagrams,
239: examples, notes and sections marked non-normative.</p>
1.12 avankest 240:
1.1 avankest 241: <p>The key words <em class="ct">must</em>, <em class="ct">must not</em>,
1.259 avankest 242: <em class="ct">should</em>, <em class="ct">should not</em>, and
243: <em class="ct">may</em> in this document are to be interpreted as
244: described in RFC 2119. [<cite><span>RFC2119</span></cite>]</p>
1.12 avankest 245:
1.1 avankest 246: <p>This specification defines the following classes of products:</p>
1.12 avankest 247:
1.1 avankest 248: <dl>
1.74 avankest 249: <dt><dfn id="conforming-user-agent">Conforming user agent</dfn></dt>
1.24 avankest 250:
1.74 avankest 251: <dd>
252: <p>A user agent <em class="ct">must</em> behave as described in this
1.106 avankest 253: specification in order to be considered conformant.</p>
1.95 avankest 254:
1.248 avankest 255:
1.224 avankest 256: <p>If the user agent is not a <span>conforming XML user agent</span> the
257: <span>XML response entity body</span> <em class="ct">must</em> (always)
1.239 avankest 258: be null.</p>
1.248 avankest 259:
1.140 avankest 260:
261: <p>User agents <em class="ct">may</em> implement algorithms given in
262: this specification in any way desired, so long as the end result is
263: indistinguishable from the result that would be obtained by the
264: specification's algorithms.</p>
1.110 avankest 265:
1.95 avankest 266: <p class="note">This specification uses both the terms "conforming user
267: agent(s)" and "user agent(s)" to refer to this product class.</p>
1.74 avankest 268: </dd>
1.248 avankest 269:
1.94 avankest 270: <dt><dfn id="conforming-xml-user-agent">Conforming XML user agent</dfn></dt>
1.110 avankest 271:
1.224 avankest 272: <dd><p>An XML user agent <em class="ct">must</em> be a
273: <span>conforming user agent</span> and <em class="ct">must</em> be a
274: conforming XML processor that reports violations of
275: namespace well-formedness. [<cite><span>XML</span></cite>]</p></dd>
1.248 avankest 276:
1.1 avankest 277: </dl>
1.32 avankest 278:
1.153 avankest 279: <h3 id="dependencies">Dependencies</h3>
1.33 avankest 280:
1.29 avankest 281: <p>This specification relies on several underlying specifications.</p>
1.248 avankest 282:
1.29 avankest 283: <dl>
1.248 avankest 284:
285:
1.29 avankest 286: <dt>DOM</dt>
1.33 avankest 287:
1.155 avankest 288: <dd><p>A <span title="conforming user agent">conforming user agent</span>
1.176 avankest 289: <em class="ct">must</em> support at least the subset of the functionality
1.182 avankest 290: defined in DOM Events and DOM Core that this specification relies upon,
291: such as various exceptions and <code>EventTarget</code>.
1.155 avankest 292: [<cite><span>DOM2Events</span></cite>]
293: [<cite><span>DOM3Core</span></cite>]</p></dd>
1.29 avankest 294:
1.250 avankest 295: <dt>HTML5</dt>
1.161 avankest 296:
297: <dd>
1.189 avankest 298: <p>A <span>conforming user agent</span> <em class="ct">must</em> support
1.250 avankest 299: at least the subset of the functionality defined in HTML5 that
1.197 avankest 300: this specification relies upon, such as the basics of the
301: <code>Window</code> object and serializing a <code>Document</code>
302: object. [<cite><span>HTML5</span></cite>]</p>
1.161 avankest 303:
304: <p class="note">The
305: <a href="http://www.w3.org/TR/2006/WD-Window-20060407/">Window Object
306: 1.0</a> draft is not referenced normatively as it appears to be no
1.250 avankest 307: longer maintained and HTML5 defines the <code>Window</code> object in
308: more detail. This specification already depends on HTML5 for other
309: reasons so there is not much additional overhead because of this.</p>
1.161 avankest 310:
1.29 avankest 311: <dt>HTTP</dt>
1.33 avankest 312:
1.248 avankest 313: <dd><p>A <span title="conforming user agent">conforming user agent</span>
314: <em class="ct">must</em> support some version of the HTTP protocol.
315: Requirements regarding HTTP are made throughout the specification.
316: [<cite><span>RFC2616</span></cite>]</p></dd>
1.189 avankest 317:
1.181 avankest 318: <dt>Web IDL</dt>
1.203 avankest 319:
1.248 avankest 320: <dd><p>A <span>conforming user agent</span> <em class="ct">must</em> also
321: be a conforming implementation of the IDL fragments in this
322: specification, as described in the Web IDL specification.
1.181 avankest 323: [<cite><span>WebIDL</span></cite>]
1.248 avankest 324:
325:
1.29 avankest 326: </dl>
1.12 avankest 327:
1.157 avankest 328:
1.153 avankest 329: <h3 id="terminology">Terminology</h3>
1.209 avankest 330:
1.233 avankest 331: <p><dfn id="dfn-obtain-unicode">convert a DOMString to a sequence of Unicode characters</dfn>
332: is defined by the Web IDL specification.
333: [<cite><span>WebIDL</span></cite>]</p>
1.266 avankest 334:
335: <p>The term <dfn>user credentials</dfn> for the purposes of this
336: specification means cookies, HTTP authentication, and client-side SSL
337: certificates. Specifically it does not refer to proxy authentication or
338: the <code title="http-origin">Origin</code> header.
339: <a href="#ref-cookies">[COOKIES]</a> <!-- XXX ref? --></p>
1.248 avankest 340:
1.200 avankest 341: <p>The terms and algorithms
1.257 avankest 342: <dfn id="url-fragment"><code><fragment></code></dfn>,
343: <dfn id="url-scheme"><code><scheme></code></dfn>,
1.265 avankest 344: <dfn id="cookie-free-document-object">cookie-free <code>Document</code> object</dfn>,
1.203 avankest 345: <dfn id="document-base-url">document base URL</dfn>,
1.244 avankest 346: <dfn id="document-character-encoding">document's character encoding</dfn>,
1.205 avankest 347: <dfn id="event-handler-attributes-0">event handler attributes</dfn>,
1.203 avankest 348: <dfn id="event-handler-event-type">event handler event type</dfn>,
1.260 avankest 349: <dfn id="fetch">fetch</dfn>,
1.203 avankest 350: <dfn id="fully-active">fully active</dfn>,
1.206 avankest 351: <dfn id="function"><code>Function</code></dfn>,
1.225 avankest 352: <dfn id="dom-innerhtml" title="dom-innerHTML"><code>innerHTML</code></dfn>,
1.200 avankest 353: <dfn id="origin">origin</dfn>,
1.232 avankest 354: <dfn id="preferred-mime-name">preferred MIME name</dfn>,
1.203 avankest 355: <dfn id="resolve-a-url">resolve a URL</dfn>,
356: <dfn id="same-origin">same origin</dfn>,
357: <dfn id="storage-mutex">storage mutex</dfn>,
358: <dfn id="task">task</dfn>,
359: <dfn id="task-source">task source</dfn>,
1.252 avankest 360: <dfn id="task-queues">task queues</dfn>,
1.203 avankest 361: <dfn id="url">URL</dfn>,
1.232 avankest 362: <dfn id="url-character-encoding">URL character encoding</dfn>,
363: <dfn id="queue-a-task">queue a task</dfn>, and
364: <dfn id="valid-mime-type">valid MIME type</dfn>
1.250 avankest 365: are defined by the HTML5 specification.
1.157 avankest 366: [<cite><span>HTML5</span></cite>]</p>
1.210 avankest 367:
1.203 avankest 368: <p>The term <dfn id="entity-body">entity body</dfn> is used as described
369: in RFC 2616. <dfn id="method-token">Method token</dfn> is used as
370: described in section 5.1.1 of RFC 2616. <dfn><code>field-name</code></dfn>
371: and <dfn><code>field-value</code></dfn> are used as described in section
372: 4.2 of RFC 2616. [<cite><span>RFC2616</span></cite>]</p>
1.218 avankest 373:
1.258 avankest 374: <p>To <dfn>deflate a DOMString into a byte sequence</dfn> means to create
375: a sequence of bytes such that the <var title="">n</var>th byte of the
376: sequence is equal to the low-order byte of the <var title="">n</var>th
377: code point in the original DOMString.</p>
378:
379: <p>To <dfn>inflate a byte sequence into a DOMString</dfn> means to create
380: a DOMString such that the <var title="">n</var>th code point has 0x00 as
381: the high-order byte and the <var title="">n</var>th byte of the byte
382: sequence as the low-order byte.</p>
1.256 avankest 383:
1.203 avankest 384: <p><dfn><code>userinfo</code></dfn> is used as described in section 3.2.1
385: of RFC 3986. [<cite><span>RFC3986</span></cite>]</p>
386:
387: <p>To <dfn id="dispatch-readystatechange-event">dispatch a
388: <code>readystatechange</code> event</dfn> means that an event with the
1.273 avankest 389: name <code title="event-xhr-readystatechange">readystatechange</code>, which does not bubble and is not
1.232 avankest 390: cancelable, and which uses the <code>Event</code> interface, is to be
391: dispatched at the <code>XMLHttpRequest</code> object.</p>
1.80 avankest 392:
1.248 avankest 393:
394:
1.153 avankest 395: <h3 id="extensibility">Extensibility</h3>
1.12 avankest 396:
1.250 avankest 397: <p>User agents, Working Groups, and other interested parties are
398: <em>strongly encouraged</em> to discuss extensions on a relevant public
399: forum, preferably
400: <a href="mailto:public-webapps@w3.org">public-webapps@w3.org</a>. If this
401: is for some reason not possible prefix the extension in some way and start
402: the prefix with an uppercase letter. E.g. if company Foo wants to add a
403: private method <code>bar()</code> it could be named <code>FooBar()</code>
404: to prevent clashes with a potential future standardized
405: <code>bar()</code>.</p>
1.12 avankest 406:
1.153 avankest 407:
1.223 avankest 408: <h2>The <code title="">XMLHttpRequest</code> Interface</h2>
1.12 avankest 409:
1.58 avankest 410: <p>The <code>XMLHttpRequest</code> object can be used by scripts to
1.22 avankest 411: programmatically connect to their originating server via HTTP.</p>
1.12 avankest 412:
1.228 avankest 413: <pre class="idl">[NoInterfaceObject]
414: interface <dfn id="xmlhttprequesteventtarget">XMLHttpRequestEventTarget</dfn> : EventTarget {
415: // for future use
416: };
417:
1.240 avankest 418: [<span title="dom-XMLHttpRequest">Constructor</span>]
1.228 avankest 419: interface <dfn id="xmlhttprequest">XMLHttpRequest</dfn> : <span>XMLHttpRequestEventTarget</span> {
1.206 avankest 420: // <a href="#event-handler-attributes">event handler attributes</a>
1.273 avankest 421: attribute <span>Function</span> <span title="handler-xhr-onreadystatechange">onreadystatechange</span>;
1.58 avankest 422:
1.205 avankest 423: // <a href="#states">states</a>
1.272 avankest 424: const unsigned short <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span> = 0;
425: const unsigned short <span title="dom-XMLHttpRequest-OPENED">OPENED</span> = 1;
426: const unsigned short <span title="dom-XMLHttpRequest-HEADERS_RECEIVED">HEADERS_RECEIVED</span> = 2;
427: const unsigned short <span title="dom-XMLHttpRequest-LOADING">LOADING</span> = 3;
428: const unsigned short <span title="dom-XMLHttpRequest-DONE">DONE</span> = 4;
1.277 ! avankest 429: readonly attribute unsigned short <span title="dom-XMLHttpRequest-readyState">readyState</span>;
1.58 avankest 430:
1.205 avankest 431: // <a href="#request">request</a>
1.274 avankest 432: void <span title="dom-XMLHttpRequest-open">open</span>(DOMString <var>method</var>, DOMString <var title="">url</var>);
433: void <span title="dom-XMLHttpRequest-open">open</span>(DOMString <var>method</var>, DOMString <var title="">url</var>, boolean <var>async</var>);
434: void <span title="dom-XMLHttpRequest-open">open</span>(DOMString <var>method</var>, DOMString <var title="">url</var>, boolean <var>async</var>, DOMString? <var>user</var>);
435: void <span title="dom-XMLHttpRequest-open">open</span>(DOMString <var>method</var>, DOMString <var title="">url</var>, boolean <var>async</var>, DOMString? <var>user</var>, DOMString? <var>password</var>);
1.226 avankest 436: void <span>setRequestHeader</span>(DOMString <var>header</var>, DOMString <var>value</var>);
1.271 avankest 437: void <span title="dom-XMLHttpRequest-send">send</span>();
438: void <span title="dom-XMLHttpRequest-send">send</span>(Document <var>data</var>);
439: void <span title="dom-XMLHttpRequest-send">send</span>([AllowAny] DOMString? <var>data</var>);
1.275 avankest 440: void <span title="dom-XMLHttpRequest-abort">abort</span>();
1.58 avankest 441:
1.205 avankest 442: // <a href="#response">response</a>
1.276 avankest 443: readonly attribute unsigned short <span title="dom-XMLHttpRequest-status">status</span>;
444: readonly attribute DOMString <span title="dom-XMLHttpRequest-statusText">statusText</span>;
1.226 avankest 445: DOMString <span>getResponseHeader</span>(DOMString <var>header</var>);
1.70 avankest 446: DOMString <span>getAllResponseHeaders</span>();
1.276 avankest 447: readonly attribute DOMString <span title="dom-XMLHttpRequest-responseText">responseText</span>;
448: readonly attribute Document <span title="dom-XMLHttpRequest-responseXML">responseXML</span>;
1.228 avankest 449: };</pre>
1.8 avankest 450:
1.235 avankest 451: <!-- XXX domintro boxes; HTML5-style -->
452:
1.124 avankest 453:
1.203 avankest 454: <h3>Origin and Base URL</h3>
455:
456: <p>Each <code>XMLHttpRequest</code> object has an associated
457: <dfn id="xmlhttprequest-origin"><code>XMLHttpRequest</code> origin</dfn>
458: and an
459: <dfn id="xmlhttprequest-base-url"><code>XMLHttpRequest</code> base URL</dfn>.
460:
461: <p>This specification defines their values when the global object is
462: represented by the <code>Window</code> object. When the
1.246 avankest 463: <code>XMLHttpRequest</code> object is used in other contexts their values
1.203 avankest 464: will have to be defined as appropriate for that context. That is
465: considered to be out of scope for this specification.</p>
466:
467: <p>In environments where the global object is represented by the
468: <code>Window</code> object the <code>XMLHttpRequest</code> object has an
469: associated
470: <dfn id="xmlhttprequest-document"><code>XMLHttpRequest</code> <code>Document</code></dfn>
471: which is the <code>Document</code> object associated with the
472: <code>Window</code> object for which the <code>XMLHttpRequest</code>
473: interface object was created.</p>
474:
475: <p class="note">The
476: <span><code>XMLHttpRequest</code> <code>Document</code></span> is used to
477: determine the <span><code>XMLHttpRequest</code> origin</span> and
478: <span><code>XMLHttpRequest</code> base URL</span> at a later stage.</p>
479:
480:
1.263 avankest 481:
1.203 avankest 482: <h3>Task Sources</h3>
1.218 avankest 483:
1.251 avankest 484: <p>The <span>task source</span> used by this specification is the
485: <dfn><code>XMLHttpRequest</code> task source</dfn>.</p>
1.203 avankest 486:
487:
1.211 avankest 488: <h3 id="constructors">Constructors</h3>
1.203 avankest 489:
1.263 avankest 490:
491:
1.270 avankest 492: <dl class="domintro">
493: <dt><var title="">client</var> = new <code title="dom-XMLHttpRequest">XMLHttpRequest</code>()</dt>
494: <dd>Returns a new <code>XMLHttpRequest</code> object.</dd>
495:
496: </dl>
497:
1.203 avankest 498: <p>When the
1.266 avankest 499: <dfn id="dom-xmlhttprequest" title="dom-XMLHttpRequest"><code>XMLHttpRequest()</code></dfn>
1.203 avankest 500: constructor is invoked, the user agent <em class="ct">must</em> return a
501: new <code>XMLHttpRequest</code> object.</p>
502:
1.263 avankest 503:
1.203 avankest 504:
1.205 avankest 505: <h3 id="event-handler-attributes">Event Handler Attributes</h3>
506:
1.248 avankest 507:
508:
1.205 avankest 509: <p>The following is the
510: <span title="event handler attributes">event handler attribute</span> (and
511: its corresponding <span>event handler event type</span>) that
512: <em class="ct">must</em> be supported as DOM attribute by the
513: <code>XMLHttpRequest</code> object:</p>
514:
515: <table>
516: <thead>
517: <tr>
518: <th><span title="event handler attributes">event handler attribute</span>
519: <th><span>event handler event type</span>
520: <tbody>
521: <tr>
1.273 avankest 522: <td><dfn id="handler-xhr-onreadystatechange" title="handler-xhr-onreadystatechange"><code>onreadystatechange</code></dfn>
523: <td><code title="event-xhr-readystatechange">readystatechange</code></td>
1.205 avankest 524: </table>
525:
526:
527: <h3 id="states">States</h3>
1.277 ! avankest 528:
! 529: <dl class="domintro">
! 530: <dt><var title="">client</var> . <code title="dom-XMLHttpRequest-readyState">readyState</code></dt>
! 531: <dd><p>Returns the current state.</p></dd>
! 532: </dl>
1.203 avankest 533:
534: <p>The <code>XMLHttpRequest</code> object can be in several states. The
1.277 ! avankest 535: <dfn id="dom-xmlhttprequest-readystate" title="dom-XMLHttpRequest-readyState"><code>readyState</code></dfn>
! 536: attribute <em class="ct">must</em> return the current state, which
1.203 avankest 537: <em class="ct">must</em> be one of the following values:</p>
538:
539: <dl>
1.272 avankest 540: <dt><dfn id="dom-xmlhttprequest-unsent" title="dom-XMLHttpRequest-UNSENT"><code>UNSENT</code></dfn>
1.203 avankest 541: (numeric value 0)</dt>
542: <dd><p>The object has been constructed.</p></dd>
543:
1.272 avankest 544: <dt><dfn id="dom-xmlhttprequest-opened" title="dom-XMLHttpRequest-OPENED"><code>OPENED</code></dfn>
1.203 avankest 545: (numeric value 1)</dt>
1.274 avankest 546: <dd><p>The <code title="dom-XMLHttpRequest-open">open()</code> method has been successfully invoked.
1.203 avankest 547: During this state request headers can be set using
548: <code>setRequestHeader()</code> and the request can be made using the
1.271 avankest 549: <code title="dom-XMLHttpRequest-send">send()</code> method.</p></dd>
1.203 avankest 550:
1.272 avankest 551: <dt><dfn id="dom-xmlhttprequest-headers_received" title="dom-XMLHttpRequest-HEADERS_RECEIVED"><code>HEADERS_RECEIVED</code></dfn>
1.203 avankest 552: (numeric value 2)</dt>
1.257 avankest 553: <dd><p>All redirects (if any) have been followed and all HTTP headers of
554: the final response have been received. Several response members of the
555: object are now available.</p></dd>
1.203 avankest 556:
1.272 avankest 557: <dt><dfn id="dom-xmlhttprequest-loading" title="dom-XMLHttpRequest-LOADING"><code>LOADING</code></dfn>
1.203 avankest 558: (numeric value 3)</dt>
559: <dd><p>The <span>response entity body</span> is being received.</p></dd>
560:
1.272 avankest 561: <dt><dfn id="dom-xmlhttprequest-done" title="dom-XMLHttpRequest-DONE"><code>DONE</code></dfn>
1.203 avankest 562: (numeric value 4)</dt>
563: <dd><p>The data transfer has been completed or something went wrong
564: during the transfer (e.g. infinite redirects).</p></dd>
565: </dl>
566:
1.272 avankest 567: <p>The <span title="dom-XMLHttpRequest-OPENED">OPENED</span> state has an associated
1.203 avankest 568: <dfn id="send-flag"><code>send()</code> flag</dfn> that indicates whether
1.271 avankest 569: the <code title="dom-XMLHttpRequest-send">send()</code> method has been
570: invoked. It can be either true or false and has an initial value of
571: false.</p>
1.203 avankest 572:
1.272 avankest 573: <p>The <span title="dom-XMLHttpRequest-DONE">DONE</span> state has an associated
1.203 avankest 574: <dfn id="error-flag">error flag</dfn> that indicates some type of network
575: error or abortion. It can be either true or false and has an initial value
576: of false.</p>
577:
578:
1.205 avankest 579: <h3 id="request">Request</h3>
1.203 avankest 580:
581: <p>The <code>XMLHttpRequest</code> object holds the following request
582: metadata variables:</p>
583:
1.204 avankest 584: <dl>
585: <dt>The <dfn>asynchronous flag</dfn></dt>
1.266 avankest 586: <dd>True when <span title="fetch">fetching</span> is done asychronously.
587: False when fetching is done synchronously.</dd>
1.204 avankest 588:
589: <dt>The <dfn>request method</dfn></dt>
590: <dd>The method used in the request.</dd>
591:
592: <dt>The <dfn>request URL</dfn></dt>
593: <dd>The <span>URL</span> used in the request.</dd>
1.218 avankest 594:
1.204 avankest 595: <dt>The <dfn>request username</dfn></dt>
596: <dd>The username used in the request or null if there is no
597: username.</dd>
1.218 avankest 598:
1.204 avankest 599: <dt>The <dfn>request password</dfn></dt>
600: <dd>The password used in the request or null if there is no
601: password.</dd>
1.218 avankest 602:
1.204 avankest 603: <dt>The <dfn id="author-request-headers">author request headers</dfn></dt>
604: <dd>A list consisting of HTTP header name/value pairs to be used in the
605: request.</p>
1.203 avankest 606:
1.204 avankest 607: <dt>The <dfn>request entity body</dfn></dt>
1.218 avankest 608: <dd>The <span>entity body</span> used in the request.</dd>
1.248 avankest 609:
610:
1.204 avankest 611: </dl>
1.203 avankest 612:
1.248 avankest 613:
614:
1.203 avankest 615:
616: <h4>The <code title="">open()</code> method</h4>
1.269 avankest 617:
618: <dl class="domintro">
1.274 avankest 619: <dt><var title="">client</var> . <code title="dom-XMLHttpRequest-open">open(<var title="">method</var>,
620: <var title="">url</var>, <var title="">async</var>, <var title="">user</var>,
621: <var title="">password</var>)</code></dt>
1.269 avankest 622:
623: <dd><p>Sets the <span>request method</span>, <span>request URL</span>,
624: <span>asynchronous flag</span>, <span>request username</span>, and
625: <span>request password</span>.</p></dd>
626: </dl>
1.88 avankest 627:
1.274 avankest 628: <p>When the
629: <dfn id="dom-xmlhttprequest-open" title="dom-XMLHttpRequest-open"><code>open(<var title="">method</var>, <var title="">url</var>, <var title="">async</var>, <var title="">user</var>, <var title="">password</var>)</code></dfn>
630: method is invoked, the user agent <em class="ct">must</em> run these steps
631: (unless otherwise indicated):</p>
1.90 avankest 632:
1.88 avankest 633: <ol>
1.203 avankest 634: <li>
635: <p>If the <code>XMLHttpRequest</code> object has an associated
636: <span><code>XMLHttpRequest</code> <code>Document</code></span> run
637: these substeps:</p>
1.90 avankest 638:
1.203 avankest 639: <ol>
640: <li><p>If the
641: <span><code>XMLHttpRequest</code> <code>Document</code></span> is not
642: <span>fully active</span> raise an <code>INVALID_STATE_ERR</code>
643: exception and terminate the overall set of steps.</p></li>
644:
645: <li><p>Let <span><code>XMLHttpRequest</code> base URL</span> be the
646: <span>document base URL</span> of the
647: <span><code>XMLHttpRequest</code> <code>Document</code></span>.</p></li>
648:
649: <li><p>Let <span><code>XMLHttpRequest</code> origin</span> be the
650: <span>origin</span> of the
651: <span><code>XMLHttpRequest</code> <code>Document</code></span>.</p></li>
652: </ol>
653: </li>
1.90 avankest 654:
1.256 avankest 655: <li><p>If any code point in <var>method</var> is higher than
656: U+00FF LATIN SMALL LETTER Y WITH DIAERESIS or after
657: <span title="deflate a DOMString into an byte sequence">deflating</span>
658: <var>method</var> it does not match the
1.210 avankest 659: <span>Method token</span> production raise a <code>SYNTAX_ERR</code>
1.256 avankest 660: exception and terminate these steps. Otherwise let <var>method</var> be
661: the result of
662: <span title="deflate a DOMString into an byte sequence">deflating</span>
663: <var>method</var>.</p></li> <!-- This sounds lame, but it works. -->
1.118 avankest 664:
1.115 avankest 665: <li>
1.256 avankest 666: <p>If <var>method</var> is a case-insensitive match for
1.203 avankest 667: <code>CONNECT</code>, <code>DELETE</code>, <code>GET</code>,
668: <code>HEAD</code>, <code>OPTIONS</code>, <code>POST</code>,
669: <code>PUT</code>, <code>TRACE</code>, or <code>TRACK</code>
1.256 avankest 670: subtract 0x20 from each byte in the range 0x61 (ASCII a) to
671: 0x7A (ASCII z).</p>
1.118 avankest 672:
1.203 avankest 673: <p class="note">If it does not match any of the above, it is passed
674: through <em>literally</em>, including in the final request.</p>
1.115 avankest 675: </li>
1.203 avankest 676: <!-- WebKit (and supposedly Gecko) also uppercase: COPY, INDEX, LOCK,
677: M-POST, MKCOL, MOVE, PROPFIND, PROPPATCH, and UNLOCK. -->
1.118 avankest 678:
1.111 avankest 679: <li>
1.256 avankest 680: <p>If <var>method</var> is a case-sensitive match for
1.259 avankest 681: <code>CONNECT</code>, <code>TRACE</code>, or <code>TRACK</code> raise a
682: <code>SECURITY_ERR</code> exception and terminate these steps.</p>
1.117 avankest 683:
1.203 avankest 684: <p class="note">Allowing these methods poses a security risk.
685: [<cite><span>HTTPVERBSEC</span></cite>]</p>
1.111 avankest 686: </li>
687:
1.203 avankest 688: <li><p>Let <var title="">url</var> be a <span>URL</span>.</p></li>
689:
1.209 avankest 690: <li><p>Let <span>URL character encoding</span> of <var title="">url</var>
691: be UTF-8.</p></li>
1.113 avankest 692:
1.255 avankest 693: <li><p><span title="Resolve a URL">Resolve</span> <var title="">url</var>
1.203 avankest 694: relative to the <span><code>XMLHttpRequest</code> base URL</span>.
695: If the algorithm returns an error raise a <code>SYNTAX_ERR</code>
696: exception and terminate these steps.</p></li>
697:
698: <!-- Presto and Gecko override the encoding. WebKit does not. Trident
699: does not support non-ASCII URLs. This matters for the <query> component,
700: see HTML5. -->
701:
702: <li><p>Drop <code><fragment></code> from <var title="">url</var>.</p></li>
703:
704: <li><p>If <var title="">url</var> contains an unsupported <code><scheme></code>
705: raise a <code>NOT_SUPPORTED_ERR</code> and terminate these
706: steps.</p></li>
707:
708: <li><p>If the <code>"user:password"</code> format in the
709: <code>userinfo</code> production is not supported for the relevant scheme
710: and <var title="">url</var> contains this format raise a
711: <code>SYNTAX_ERR</code> and terminate these steps.</p></li>
712:
713: <li><p>If <var title="">url</var> contains the <code>"user:password"</code>
714: format let <var>temp user</var> be the user part and
715: <var>temp password</var> be the password part.</p></li>
716:
717: <li><p>If <var title="">url</var> just contains the <code>"user"</code>
718: format let <var>temp user</var> be the user part.</p></li>
719:
1.248 avankest 720:
1.203 avankest 721: <li><p>If the <span>origin</span> of <var title="">url</var> is not
722: <span>same origin</span> with the
1.259 avankest 723: <span><code>XMLHttpRequest</code> origin</span> raise a
724: <code>SECURITY_ERR</code> exception and terminate these steps.</p></li>
1.248 avankest 725:
726:
1.203 avankest 727:
1.211 avankest 728: <li><p>Let <var>async</var> be the value of the <var>async</var> argument
1.266 avankest 729: or true if it was omitted.</p></li>
1.203 avankest 730:
731: <li>
732: <p>If the <var>user</var> argument was not omitted follow these sub
733: steps:</p>
1.90 avankest 734:
1.203 avankest 735: <ol>
1.263 avankest 736:
737:
1.203 avankest 738: <li><p>If the syntax of <var>user</var> does not match the syntax
739: specified by the relevant authentication scheme, raise a
740: <code>SYNTAX_ERR</code> exception and terminate the overall set of
741: steps.</p></li>
1.163 avankest 742:
1.239 avankest 743: <li><p>If <var>user</var> is null let <var>temp user</var>
1.203 avankest 744: be null.</p></li>
1.90 avankest 745:
1.203 avankest 746: <li><p>Otherwise let <var>temp user</var> be <var>user</var>.</p></li>
747: </ol>
1.88 avankest 748:
1.203 avankest 749: <p class="note">These steps override anything that may have been set by
750: the <var title="">url</var> argument.</p>
751: </li>
1.88 avankest 752:
1.128 avankest 753: <li>
1.203 avankest 754: <p>If the <var>password</var> argument was not omitted follow these sub
755: steps:</p>
756:
757: <ol>
1.263 avankest 758:
759:
1.203 avankest 760: <li><p>If the syntax of <var>password</var> does not match the syntax
761: specified by the relevant authentication scheme, raise a
762: <code>SYNTAX_ERR</code> exception and terminate the overall set of
763: steps.</p></li>
1.167 avankest 764:
1.239 avankest 765: <li><p>If <var>password</var> is null let
1.203 avankest 766: <var>temp password</var> be null.</p></li>
767:
768: <li><p>Otherwise let <var>temp password</var> be
769: <var>password</var>.</p></li>
770: </ol>
771:
772: <p class="note">These steps override anything that may have been set by
773: the <var title="">url</var> argument.</p>
1.128 avankest 774: </li>
1.88 avankest 775:
1.203 avankest 776: <li><p><span title="abort send()">Abort the <code>send()</code> algorithm</span>.</p></li>
777:
778: <li><p>The user agent <em class="ct">should</em> cancel any network
779: activity for which the object is responsible.</p></li>
780: <!-- we can hardly require it... -->
781:
1.252 avankest 782: <li><p>If there are any <span title="task">tasks</span> from the object's
783: <span><code>XMLHttpRequest</code> task source</span> in one of the
784: <span>task queues</span>, then remove those tasks.</p></li>
785:
1.203 avankest 786: <li>
787: <p>Set variables associated with the object as follows:</p>
788:
789: <ul>
790: <li><p>Set the <span><code>send()</code> flag</span> to false.</p></li>
791:
792: <li><p>Set <span>response entity body</span> to null.</p></li>
793:
794: <li><p>Empty the list of <span>author request headers</span>.</p>
795:
796: <li><p>Set the <span>request method</span> to <var>method</var>.</p></li>
797:
798: <li><p>Set the <span>request URL</span> to <var title="">url</var>.</p></li>
1.58 avankest 799:
1.203 avankest 800: <li><p>Set the <span>request username</span> to <var>temp user</var>.</p></li>
1.12 avankest 801:
1.203 avankest 802: <li><p>Set the <span>request password</span> to <var>temp password</var>.</p></li>
1.12 avankest 803:
1.266 avankest 804: <li><p>Set the <span>asynchronous flag</span> to the value of
805: <var>async</var>.</p></li>
1.203 avankest 806: </ul>
807: </li>
1.58 avankest 808:
1.203 avankest 809: <li><p>Switch the the state to
1.272 avankest 810: <span title="dom-XMLHttpRequest-OPENED">OPENED</span>.</p></li>
1.58 avankest 811:
1.203 avankest 812: <li><p><span>Dispatch a <code>readystatechange</code> event</span>.</p></li>
813: </ol>
1.248 avankest 814:
815:
1.203 avankest 816: <p class="note">A future version or extension of this specification will
817: define a way of doing cross-origin requests.</p>
1.248 avankest 818:
1.58 avankest 819:
1.14 avankest 820:
1.203 avankest 821: <h4>The <code title="">setRequestHeader()</code> method</h4>
1.12 avankest 822:
1.270 avankest 823: <dl class="domintro">
824: <dt><var title="">client</var> . <code>setRequestHeader(<var title="">header</var>,
825: <var title="">value</var>)</code></dt>
826:
827: <dd>
828: <p>Appends an header to the list of
829: <span>author request headers</span> or if the header is already in the
830: <span>author request headers</span> its value appended to.</p>
831: <!-- XXX should mention when it throws? -->
832: </dd>
833: </dl>
1.45 avankest 834:
1.203 avankest 835: <p>As indicated in the algorithm below certain headers cannot be set and
836: are left up to the user agent. In addition there are certain other headers
837: the user agent will take control of if they are not set by the author as
1.271 avankest 838: indicated at the end of the
839: <code title="dom-XMLHttpRequest-send">send()</code> method section.</p>
1.203 avankest 840:
841: <p class="note">The <code>setRequestHeader()</code> method appends a
842: value if the HTTP header given as argument is already part of the
843: <span>author request headers</span> list.</p>
844:
1.248 avankest 845:
846:
1.203 avankest 847: <p>When the
1.270 avankest 848: <dfn id="dom-xmlhttprequest-setrequestheader" title="setrequestheader"><code>setRequestHeader(<var title="">header</var>,
849: <var title="">value</var>)</code></dfn> method is invoked, the user agent
1.259 avankest 850: <em class="ct">must</em> run these steps:</p>
1.14 avankest 851:
1.203 avankest 852: <ol>
1.272 avankest 853: <li><p>If the state is not <span title="dom-XMLHttpRequest-OPENED">OPENED</span> raise
1.203 avankest 854: an <code>INVALID_STATE_ERR</code> exception and terminate these
855: steps.</p></li>
856:
857: <li><p>If the <span><code>send()</code> flag</span> is true raise an
858: <code>INVALID_STATE_ERR</code> exception and terminate these
859: steps.</p></li>
860:
1.256 avankest 861: <li><p>If any code point in <var>header</var> is higher than
862: U+00FF LATIN SMALL LETTER Y WITH DIAERESIS or after
863: <span title="deflate a DOMString into an byte sequence">deflating</span>
864: <var>header</var> it does not match the
865: <span>field-name</span> production raise a <code>SYNTAX_ERR</code>
866: exception and terminate these steps. Otherwise let <var>header</var> be
867: the result of
868: <span title="deflate a DOMString into an byte sequence">deflating</span>
869: <var>header</var>.</p></li> <!-- This sounds lame, but it works. -->
1.203 avankest 870:
871: <li>
1.256 avankest 872: <p>If any code point in <var>value</var> is higher than
873: U+00FF LATIN SMALL LETTER Y WITH DIAERESIS or after
874: <span title="deflate a DOMString into an byte sequence">deflating</span>
875: <var>value</var> it does not match the
876: <span>field-value</span> production raise a <code>SYNTAX_ERR</code>
877: exception and terminate these steps. Otherwise let <var>value</var> be
878: the result of
879: <span title="deflate a DOMString into an byte sequence">deflating</span>
880: <var>value</var>.</p> <!-- This sounds lame, but it works. -->
1.203 avankest 881:
882: <p class="note">The empty string is legal and represents the empty
883: header value.</p>
884: </li>
885:
886: <li>
1.259 avankest 887: <p>Terminate these steps if <var>header</var> is a case-insensitive
888: match for one of the following headers:</p>
1.203 avankest 889:
890: <ul>
891: <li><code>Accept-Charset</code></li>
892: <li><code>Accept-Encoding</code></li>
893: <li><code>Connection</code></li>
894: <li><code>Content-Length</code></li>
895: <li><code>Cookie</code></li>
896: <li><code>Cookie2</code></li>
897: <li><code>Content-Transfer-Encoding</code></li>
898: <li><code>Date</code></li>
899: <li><code>Expect</code></li>
900: <li><code>Host</code></li>
901: <li><code>Keep-Alive</code></li>
902: <li><code>Referer</code></li>
903: <li><code>TE</code></li>
904: <li><code>Trailer</code></li>
905: <li><code>Transfer-Encoding</code></li>
906: <li><code>Upgrade</code></li>
907: <li><code>User-Agent</code></li>
908: <li><code>Via</code></li>
909: </ul>
1.96 avankest 910:
1.256 avankest 911: <p>… or if the start of <var>header</var> is a case-insensitive
912: match for <code>Proxy-</code> or <code>Sec-</code> (including when
913: <var>header</var> is just <code>Proxy-</code> or <code>Sec-</code>).</p>
1.203 avankest 914:
915: <p class="note">The above headers are not allowed to be set as they are
916: better controlled by the user agent as it knows best what value they
1.259 avankest 917: ought to have. Header names starting with <code>Sec-</code> are not
1.203 avankest 918: allowed to be set to allow new headers to be minted in the future that
919: are guaranteed not to come from <code>XMLHttpRequest</code>. (Older
920: clients would however still be vulnerable as they allow such headers to
921: be set.)</p>
922: </li>
1.14 avankest 923:
1.203 avankest 924: <li><p>If <var>header</var> is not in the
925: <span>author request headers</span> list append <var>header</var> with
926: its associated <var>value</var> to the list and terminate these
927: steps.</p></li>
928:
929: <li><p>If <var>header</var> is in the <span>author request headers</span>
930: list either use multiple headers, combine the values or use a combination
931: of those (section 4.2, RFC 2616).
932: [<cite><span>RFC2616</span></cite>]</p></li>
933: <!-- XXX it seems UAs always combine the values -->
934: </ol>
1.45 avankest 935:
1.271 avankest 936: <p class="note">See also the
937: <code title="dom-XMLHttpRequest-send">send()</code> method regarding user
1.203 avankest 938: agent header handling for caching, authentication, proxies, and
939: cookies.</p>
1.14 avankest 940:
1.203 avankest 941: <div class="example">
942: <pre><code>// The following script:
1.14 avankest 943: var client = new XMLHttpRequest();
944: client.open('GET', 'demo.cgi');
945: client.setRequestHeader('X-Test', 'one');
946: client.setRequestHeader('X-Test', 'two');
947: client.send();
948:
949: // ...would result in the following header being sent:
950: ...
951: X-Test: one, two
1.58 avankest 952: ...</code></pre>
1.203 avankest 953: </div>
1.255 avankest 954:
1.248 avankest 955:
1.218 avankest 956:
1.203 avankest 957:
958: <h4>The <code title="">send()</code> method</h4>
1.12 avankest 959:
1.271 avankest 960: <dl class="domintro">
961: <dt><var title="">client</var> . <code title="dom-XMLHttpRequest-send">send(<var title="">data</var>)</code></dt>
962: <dd><p>Initiates the request. The optional argument provides the
963: <span>request entity body</span>.</p></dd>
964: </dl>
965: <!-- XXX throws?! -->
1.203 avankest 966:
967: <p>When the
1.271 avankest 968: <dfn id="dom-xmlhttprequest-send" title="dom-XMLHttpRequest-send"><code>send(<var>data</var>)</code></dfn>
1.203 avankest 969: method is invoked, the user agent <em class="ct">must</em> run the
970: following steps (unless otherwise noted). This algorithm gets aborted when
1.275 avankest 971: the <code title="dom-XMLHttpRequest-open">open()</code> or <code title="dom-XMLHttpRequest-abort">abort()</code> method is invoked. When
1.203 avankest 972: the
973: <dfn title="abort send()" id="abort-send-algorithm"><code>send()</code> algorithm is aborted</dfn>
974: the user agent <em class="ct">must</em> terminate the algorithm after
975: finishing the step it is on.</p>
976:
977: <p class="note">The <code title="">send()</code> algorithm can only be
978: aborted when the <span>asynchronous flag</span> is true and only after the
979: method call has returned.</p>
1.181 avankest 980:
1.203 avankest 981: <ol>
1.272 avankest 982: <li><p>If the state is not <span title="dom-XMLHttpRequest-OPENED">OPENED</span> raise
1.203 avankest 983: an <code>INVALID_STATE_ERR</code> exception and terminate these
984: steps.</p></li>
985:
986: <li><p>If the <span><code>send()</code> flag</span> is true raise an
987: <code>INVALID_STATE_ERR</code> exception and terminate these
988: steps.</p></li>
1.58 avankest 989:
1.203 avankest 990: <li>
991: <p>If the <span>request method</var> is <code>GET</code> or
1.239 avankest 992: <code>HEAD</code> act as if <var>data</var> is null.</p>
1.232 avankest 993:
994: <p>If the <var>data</var> argument has been omitted or is
1.239 avankest 995: null, do not include a <span>request entity body</span>
1.232 avankest 996: and go to the next step.</p>
1.248 avankest 997:
998: <p>Otherwise, let <var>encoding</var> be null, <var>mime type</var> be
999: null, and then follow these rules:</p>
1.203 avankest 1000:
1001: <dl class="switch">
1.248 avankest 1002:
1003:
1004: <dt>If <var>data</var> is a <code>Document</code>
1.203 avankest 1005:
1006: <dd>
1.232 avankest 1007: <p>Let <var>encoding</var> be the <span>preferred MIME name</span> of
1008: the
1009: <span title="document's character encoding">character encoding</span>
1010: of <var>data</var>. If <var>encoding</var> is UTF-16 change it to
1011: UTF-8.</p>
1012:
1.248 avankest 1013: <p>Let <var>mime type</var> be "<code>application/xml;charset=</code>"
1014: followed by <var>encoding</var>.</p>
1.232 avankest 1015:
1016: <p>Let the <span>request entity body</span> be the result of getting
1017: the <code title="dom-innerHTML">innerHTML</code> attribute on
1.233 avankest 1018: <var>data</var>
1019: <span title="convert a DOMString to a sequence of Unicode characters">converted to Unicode</span>
1020: and encoded as <var>encoding</var>. Re-raise any exception this
1021: raises.</p>
1.218 avankest 1022:
1.233 avankest 1023: <p class="note">In particular, if the document cannot be serialized an
1.217 avankest 1024: <code>INVALID_STATE_ERR</code> exception is raised.</p>
1025:
1.203 avankest 1026: <p class="note">Subsequent changes to the <code>Document</code> have
1027: no effect on what is submitted.</p>
1028: </dd>
1.237 avankest 1029:
1.248 avankest 1030: <dt>If <var>data</var> is a <code>DOMString</code></dt>
1.237 avankest 1031:
1.248 avankest 1032: <dd>
1033: <p>Let <var>encoding</var> be UTF-8.</p>
1034:
1035: <p>Let <var>mime type</var> be "<code>text/plain;charset=UTF-8</code>".</p>
1036:
1037: <p>Let the <span>request entity body</span> be <var>data</var>
1038: <span title="convert a DOMString to a sequence of Unicode characters">converted to Unicode</span>
1039: and encoded as UTF-8.</p>
1040: </dd>
1041:
1042:
1.203 avankest 1043: </dl>
1.58 avankest 1044:
1.232 avankest 1045: <p>If a <code>Content-Type</code> header is set using
1.248 avankest 1046: <code>setRequestHeader()</code> whose value is a
1047: <span>valid MIME type</span> and has a <code>charset</code>
1.256 avankest 1048: parameter whose value is not a case-insensitive match for
1049: <var>encoding</var>, and <var>encoding</var> is not null, set all the
1050: <code>charset</code> parameters of the <code>Content-Type</code> header
1051: to <var>encoding</var>.</p>
1.232 avankest 1052:
1053: <p>If no <code>Content-Type</code> header has been set using
1.248 avankest 1054: <code>setRequestHeader()</code> and <var>mime type</var> is not null set
1055: a <code>Content-Type</code> request header with as value
1056: <var>mime type</var>.</p>
1.236 avankest 1057:
1058: <!-- reminder: if we ever change this to always include charset it has
1059: to be included as the first parameter for compatibility reasons -->
1.203 avankest 1060: </li>
1.202 avankest 1061:
1.203 avankest 1062: <li><p>If the <span>asynchronous flag</span> is false release the
1063: <span>storage mutex</span>.</p></li>
1.103 avankest 1064:
1.248 avankest 1065:
1066:
1.203 avankest 1067: <li><p>Set the <span>error flag</span> to false.</p></li>
1.218 avankest 1068:
1.248 avankest 1069:
1070:
1.211 avankest 1071: <li>
1072: <p>If the <span>asynchronous flag</span> is true run these substeps:</p>
1.218 avankest 1073:
1.211 avankest 1074: <ol>
1.217 avankest 1075: <li><p>Set the <span><code>send()</code> flag</span> to true.</p></li>
1076:
1.211 avankest 1077: <li>
1078: <p><span>Dispatch a <code>readystatechange</code> event</span>.</p>
1.145 avankest 1079:
1.211 avankest 1080: <p class="note">The state does not change. The event is dispatched for
1081: historical reasons.</p>
1082: </li>
1083:
1.248 avankest 1084:
1085:
1.271 avankest 1086: <li><p>Return the <code title="dom-XMLHttpRequest-send">send()</code>
1087: method call, but continue running the steps in this algorithm.</p></li>
1.211 avankest 1088: </ol>
1089: </li>
1.218 avankest 1090:
1.203 avankest 1091: <li>
1.248 avankest 1092:
1.211 avankest 1093:
1.261 avankest 1094: <p><span>Fetch</span> the <span>request URL</span> from
1.260 avankest 1095: <i title="">origin</i>
1096: <span><code>XMLHttpRequest</code> origin</span>, with the
1097: <i title="">synchronous flag</i> set if the
1098: <span>asynchronous flag</span> is false, using HTTP method
1.248 avankest 1099: <span>request method</span>, user <span>request username</span> (if
1100: non-null) and password <span>request password</span> (if non-null),
1101: taking into account the <span>request entity body</span>, list of
1102: <span>author request headers</span> and the rules listed at the end of
1103: this section.</p>
1104:
1105: <dl class="switch">
1106: <dt>If the <span>asynchronous flag</span> is false</dt>
1107: <dd>
1108: <p>While making the request also follow the
1109: <span>same-origin request event rules</span>.</p>
1110:
1111: <!--
1112: This cannot involve any task queue whatsoever because that would
1113: mean other tasks on the task queue might get processed as well
1114: which is counter to the whole idea of doing things synchronous.
1115: -->
1116:
1.271 avankest 1117: <p class="note">The
1118: <code title="dom-XMLHttpRequest-send">send()</code> method call will
1119: now be returned by virtue of this algorithm ending.</p>
1.248 avankest 1120: </dd>
1121:
1122: <dt>If the <span>asynchronous flag</span> is true</dt>
1123: <dd>
1124: <p><span>Make progress notifications</span>.</p>
1125:
1126: <p><span>Make upload progress notifications</span>.</p>
1127:
1128: <p>While processing the request, as data becomes available and when
1129: the user interferes with the request,
1.255 avankest 1130: <span title="queue a task">queue tasks</span> to update the
1131: <span>response entity body</span> and follow the
1.254 avankest 1132: <span>same-origin request event rules</span>.</p>
1.248 avankest 1133: </dd>
1134: </dl>
1135:
1.203 avankest 1136: </li>
1137: </ol>
1.60 avankest 1138:
1.203 avankest 1139: <hr>
1140:
1.227 avankest 1141: <p>If the user agent allows the end user to configure a proxy it
1.248 avankest 1142: <em class="ct">should</em> modify the request appropriately; i.e., connect
1143: to the proxy host instead of the origin server, modify the
1144: <code>Request-Line</code> and send <code>Proxy-Authorization</code>
1145: headers as specified.</p>
1.262 avankest 1146:
1147: <hr>
1.212 avankest 1148:
1.218 avankest 1149: <p>If the user agent supports HTTP Authentication and
1.262 avankest 1150: <code title="http-authorization">Authorization</code> is not in the list
1151: of <span>author request headers</span>, it <em class="ct">should</em>
1.218 avankest 1152: consider requests originating from the <code>XMLHttpRequest</code> object
1153: to be part of the protection space that includes the accessed URIs and
1.262 avankest 1154: send <code title="http-authorization">Authorization</code> headers and
1155: handle <code>401 Unauthorized</code> requests appropriately.</p>
1156:
1157: <p>If authentication fails,
1158: <code title="http-authorization">Authorization</code> is not in the list
1159: of <span>author request headers</span>, <span>request username</span> is
1160: null, and <span>request password</span> is null, user agents
1161: <em class="ct">should</em> prompt the end user for their username and
1162: password.</p>
1163:
1164: <p>If authentication fails,
1165: <code title="http-authorization">Authorization</code> is not in the list
1166: of <span>author request headers</span>, <span>request username</span> is
1167: non-null, and <span>request password</span> is non-null, user agents
1168: <em class="ct">must not</em> prompt the end user for their username and
1169: password. [<cite><span>RFC2617</span></cite>]</p>
1.212 avankest 1170:
1.266 avankest 1171: <p class="note">End users are not prompted if username/password are
1.274 avankest 1172: provided through the <code title="dom-XMLHttpRequest-open">open()</code> API so that authors can implement
1.266 avankest 1173: their own user interface.</p>
1.262 avankest 1174:
1175: <hr>
1.212 avankest 1176:
1177: <p>If the user agent supports HTTP State Management it
1178: <em class="ct">should</em> persist, discard and send cookies (as received
1179: in the <code>Set-Cookie</code> and <code>Set-Cookie2</code> response
1180: headers, and sent in the <code>Cookie</code> header) as applicable.
1181: [<cite><span>COOKIES</span></cite>]</p>
1.262 avankest 1182:
1183: <hr>
1.212 avankest 1184:
1185: <p>If the user agent implements a HTTP cache it <em class="ct">should</em>
1.248 avankest 1186: respect <code>Cache-Control</code> request headers set by the
1187: <code>setRequestHeader()</code> (e.g., <code>Cache-Control:
1188: no-cache</code> bypasses the cache). It <em class="ct">must not</em> send
1.212 avankest 1189: <code>Cache-Control</code> or <code>Pragma</code> request headers
1.227 avankest 1190: automatically unless the end user explicitly requests such behavior
1.212 avankest 1191: (e.g. by (force-)reloading the page).</p>
1192:
1193: <p>For <code>304 Not Modified</code> responses that are a result of a
1194: user agent generated conditional request the user agent
1195: <em class="ct">must</em> act as if the server gave a <code>200 OK</code>
1196: response with the appropriate content. The user agent
1197: <em class="ct">must</em> allow <code>setRequestHeader()</code> to
1.248 avankest 1198: override automatic cache validation by setting request headers (e.g.
1199: <code>If-None-Match</code> or <code>If-Modified-Since</code>), in which
1.212 avankest 1200: case <code>304 Not Modified</code> responses <em class="ct">must</em> be
1201: passed through. [<cite><span>RFC2616</span></cite>]</p>
1.262 avankest 1202:
1203: <hr>
1.212 avankest 1204:
1205: <p>If the user agent implements server-driven content-negotiation
1206: it <em class="ct">should</em> set <code>Accept-Encoding</code> and
1.231 avankest 1207: <code>Accept-Charset</code> headers as appropriate. For
1208: <code>Accept</code> and <code>Accept-Language</code> the user agent
1209: <em class="ct">must</em> follow these constraints:</p>
1210:
1211: <ul>
1212: <li><p>Both headers <em class="ct">must not</em> be modified if they are
1213: already set through <code>setRequestHeader()</code>.</p></li>
1.255 avankest 1214:
1.231 avankest 1215: <li><p>If not set through <code>setRequestHeader()</code>
1.255 avankest 1216: <code>Accept-Language</code> <em class="ct">should</em> be set as
1.231 avankest 1217: appropriate.</p></li>
1218:
1219: <li><p>If not set through <code>setRequestHeader()</code>
1220: <code>Accept</code> <em class="ct">must</em> be set with as value
1221: <code>*/*</code>.</p></li>
1222: </ul>
1223:
1224: <p>Responses <em class="ct">must</em> have the content-encodings
1225: automatically decoded. [<cite><span>RFC2616</span></cite>]</p>
1.212 avankest 1226:
1.262 avankest 1227: <hr>
1228:
1.212 avankest 1229: <p>Besides the <span>author request headers</span> user agents
1230: <em class="ct">should not</em> include additional request headers other
1.248 avankest 1231: than those mentioned above or other than those authors are not allowed to
1232: set using <code>setRequestHeader()</code>. This ensures that authors have
1233: a reasonably predictable API.</p>
1.218 avankest 1234:
1.212 avankest 1235:
1236: <h4>Infrastructure for the <code title="">send()</code> method</h4>
1.216 avankest 1237:
1.219 avankest 1238: <p>The <dfn>same-origin request event rules</dfn> are as follows:</p>
1.118 avankest 1239:
1.203 avankest 1240: <dl class="switch">
1241: <dt>If the response is an HTTP redirect</dt>
1242: <dd>
1.248 avankest 1243:
1.257 avankest 1244: <p>If the <span>origin</span> of the <span>URL</span> conveyed by the
1245: <code title="http-location">Location</code> header is
1246: <span>same origin</span> with the
1247: <span><code>XMLHttpRequest</code> origin</span> and the redirect does
1248: not violate infinite loop precautions, transparently follow the redirect
1249: while observing the <span>same-origin request event rules</span>.</p>
1.248 avankest 1250:
1251: <p>Otherwise, this is a <span>network error</span>.</p>
1252:
1253:
1.203 avankest 1254:
1255: <p class="note">HTTP places requirements on the user agent regarding the
1.204 avankest 1256: preservation of the <span>request method</span> and
1.248 avankest 1257: <span>request entity body</span> during redirects, and also requires end
1258: users to be notified of certain kinds of automatic redirections.</p>
1.203 avankest 1259: <!-- XXX HTTP needs fixing here -->
1.213 avankest 1260: </dd>
1.121 avankest 1261:
1.227 avankest 1262: <dt>If the end user cancels the download</dt>
1.213 avankest 1263: <dd><p>This is an <span>abort error</span>.</p></dd>
1.60 avankest 1264:
1.214 avankest 1265: <dt>In case of network errors</dt>
1.213 avankest 1266: <dd>
1267: <p>In case of DNS errors, TLS negotiation failure, or other type of
1268: network errors, this is a <span>network error</span>. Do not request any
1.227 avankest 1269: kind of end user interaction.</p>
1.121 avankest 1270:
1.213 avankest 1271: <p class="note">This does not include HTTP responses that indicate
1272: some type of error, such as HTTP status code 410.</p>
1273: </dd>
1.60 avankest 1274:
1.248 avankest 1275:
1276:
1.213 avankest 1277: <dt>Once all HTTP headers have been received and the
1.257 avankest 1278: <span>asynchronous flag</span> is true (and this is not an HTTP
1279: redirect)</dt>
1.272 avankest 1280: <dd><p><span>Switch to the dom-XMLHttpRequest-HEADERS_RECEIVED</span>.</p></dd>
1.186 avankest 1281:
1.220 avankest 1282: <dt>Once the first byte (or more) of the
1283: <span>response entity body</span> has been received and the
1284: <span>asynchronous flag</span> is true</dt>
1285: <dt>If there is no <span>response entity body</span> and the
1.213 avankest 1286: <span>asynchronous flag</span> is true</dt>
1.272 avankest 1287: <dd><p><span>Switch to the dom-XMLHttpRequest-LOADING</span>.</p></dd>
1.220 avankest 1288:
1289: <dt>Once the whole <span>response entity body</span> has been
1290: received</dt>
1.224 avankest 1291: <dt>If there is no <span>response entity body</span> and the
1292: <span>asynchronous flag</span> is false or the state is
1.272 avankest 1293: <span title="dom-XMLHttpRequest-LOADING">LOADING</span></dt>
1294: <dd><p><span>Switch to the dom-XMLHttpRequest-DONE</span>.</p></dd>
1.213 avankest 1295: </dl>
1.218 avankest 1296:
1.248 avankest 1297:
1298:
1.213 avankest 1299: <hr>
1.218 avankest 1300:
1.241 avankest 1301: <p>When something is said to be a <dfn>network error</dfn> run the
1302: <span>request error</span> steps for exception
1303: <code>NETWORK_ERR</code>.</p>
1304:
1305: <p>When something is said to be an <dfn>abort error</dfn> run the
1306: <span>request error</span> steps for exception
1307: <code>ABORT_ERR</code>.</p>
1.60 avankest 1308:
1.248 avankest 1309:
1310:
1.242 avankest 1311: <p>When something is said to be a <dfn>request error</dfn> for
1.248 avankest 1312: exception <var>exception</var> run these
1313: steps:</p>
1.12 avankest 1314:
1.213 avankest 1315: <ol>
1.254 avankest 1316: <li><p>The user agent <em class="ct">should</em> cancel any network
1317: activity for which the object is responsible.</p></li>
1318:
1319: <li><p>If there are any <span title="task">tasks</span> from the object's
1320: <span><code>XMLHttpRequest</code> task source</span> in one of the
1321: <span>task queues</span>, then remove those tasks.</p></li>
1.250 avankest 1322:
1.213 avankest 1323: <li><p>Set the <span>response entity body</span> to null.</p></li>
1.203 avankest 1324:
1.254 avankest 1325: <li><p>Empty the list of <span>author request headers</span>.</p></li>
1326:
1.213 avankest 1327: <li><p>Set the the <span>error flag</span> to true.</p></li>
1.12 avankest 1328:
1.272 avankest 1329: <li><p>Switch the state to <span title="dom-XMLHttpRequest-DONE">DONE</span>.</p></li>
1.203 avankest 1330:
1.241 avankest 1331: <li><p>If the <span>asynchronous flag</span> is false raise an
1332: <var>exception</var> exception and terminate the overall set of
1.213 avankest 1333: steps.</p></li>
1.203 avankest 1334:
1.248 avankest 1335: <li>
1.249 avankest 1336: <p><span>Dispatch a <code>readystatechange</code> event</span>.</p>
1.248 avankest 1337:
1338: <p class="note">At this point it is clear that the
1339: <span>asynchronous flag</span> is true.</p>
1340: </li>
1341:
1342:
1.203 avankest 1343:
1.248 avankest 1344: <li><p>Terminate the overall algorithm.</p></li>
1.213 avankest 1345: </ol>
1.203 avankest 1346:
1.248 avankest 1347:
1348: <p class="note">A future version of this specification will dispatch an
1.273 avankest 1349: <code title="event-xhr-error">error</code>/<code>abort</code> event here as well. (Depending on
1.248 avankest 1350: the type of error.)</p>
1351:
1.203 avankest 1352:
1.213 avankest 1353: <hr>
1.203 avankest 1354:
1.213 avankest 1355: <p>When it is said to
1.272 avankest 1356: <dfn id="switch-headers-received">switch to the dom-XMLHttpRequest-HEADERS_RECEIVED</dfn>
1.213 avankest 1357: run these steps:</p>
1.203 avankest 1358:
1.213 avankest 1359: <ol>
1.272 avankest 1360: <li><p>Switch the state to <span title="dom-XMLHttpRequest-HEADERS_RECEIVED">HEADERS_RECEIVED</span>.</p></li>
1.203 avankest 1361:
1.249 avankest 1362: <li><p><span>Dispatch a <code>readystatechange</code> event</span>.</p></li>
1.213 avankest 1363: </ol>
1.218 avankest 1364:
1.213 avankest 1365: <p>When it is said to
1.272 avankest 1366: <dfn id="switch-loading">switch to the dom-XMLHttpRequest-LOADING</dfn> run these
1.213 avankest 1367: steps:</p>
1.218 avankest 1368:
1.213 avankest 1369: <ol>
1.272 avankest 1370: <li><p>Switch the state to <span title="dom-XMLHttpRequest-LOADING">LOADING</span>.</p></li>
1.203 avankest 1371:
1.249 avankest 1372: <li><p><span>Dispatch a <code>readystatechange</code> event</span>.</p></li>
1.213 avankest 1373: </ol>
1.218 avankest 1374:
1.216 avankest 1375: <p>When it is said to
1.272 avankest 1376: <dfn id="switch-done">switch to the dom-XMLHttpRequest-DONE</dfn> run these steps:</p>
1.218 avankest 1377:
1.216 avankest 1378: <ol>
1.255 avankest 1379: <li><p>If the <span>asynchronous flag</span> is false update the
1380: <span>response entity body</span>.</p></li>
1381:
1.272 avankest 1382: <li><p>Switch the state to <span title="dom-XMLHttpRequest-DONE">DONE</span>.</p></li>
1.216 avankest 1383:
1.248 avankest 1384: <li><p><span>Dispatch a <code>readystatechange</code> event</span>.</p></li>
1385:
1.220 avankest 1386:
1.216 avankest 1387: </ol>
1.218 avankest 1388:
1.248 avankest 1389:
1390:
1.203 avankest 1391:
1392: <h4>The <code title="">abort()</code> method</h4>
1.275 avankest 1393:
1394: <dl class="domintro">
1395: <dt><var title="">client</var> . <code title="dom-XMLHttpRequest-abort">abort()</code></dt>
1396: <dd>Cancels any network activity.</dd>
1397: </dl>
1.203 avankest 1398:
1.275 avankest 1399: <p>When the
1400: <dfn id="dom-xmlhttprequest-abort" title="dom-XMLHttpRequest-abort"><code>abort()</code></dfn>
1401: method is invoked, the user agent <em class="ct">must</em> run these steps
1402: (unless otherwise noted):</p>
1.12 avankest 1403:
1.203 avankest 1404: <ol>
1405: <li><p><span title="abort send()">Abort the <code>send()</code> algorithm</span>.</p></li>
1406:
1407: <li><p>The user agent <em class="ct">should</em> cancel any network
1408: activity for which the object is responsible.</p></li>
1.252 avankest 1409:
1410: <li><p>If there are any <span title="task">tasks</span> from the object's
1411: <span><code>XMLHttpRequest</code> task source</span> in one of the
1412: <span>task queues</span>, then remove those tasks.</p></li>
1.203 avankest 1413:
1414: <li><p>Set the <span>response entity body</span> to null.</p></li>
1415:
1.252 avankest 1416: <li><p>Empty the list of <span>author request headers</span>.</p></li>
1417:
1.203 avankest 1418: <li><p>Set the <span>error flag</span> to true.</p></li>
1419:
1420: <li>
1.272 avankest 1421: <p>If the state is <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span>,
1422: <span title="dom-XMLHttpRequest-OPENED">OPENED</span> with the
1.203 avankest 1423: <span><code>send()</code> flag</span> being false, or
1.272 avankest 1424: <span title="dom-XMLHttpRequest-DONE">DONE</span> go to the next step.</p>
1.12 avankest 1425:
1.203 avankest 1426: <p>Otherwise run these substeps:</p>
1.58 avankest 1427:
1428: <ol>
1.272 avankest 1429: <li><p>Switch the state to <span title="dom-XMLHttpRequest-DONE">DONE</span>.</p></li>
1.170 avankest 1430:
1.203 avankest 1431: <li><p>Set the <span><code>send()</code> flag</span> to false.</p></li>
1.96 avankest 1432:
1.203 avankest 1433: <li><p><span>Dispatch a <code>readystatechange</code> event</span>.</p></li>
1.248 avankest 1434:
1435:
1.58 avankest 1436: </ol>
1.250 avankest 1437:
1.248 avankest 1438:
1.250 avankest 1439: <p class="note">A future version of this specification will dispatch an
1.273 avankest 1440: <code title="event-xhr-abort">abort</code> event here.</p>
1.248 avankest 1441:
1.203 avankest 1442: </li>
1443:
1444: <li>
1.272 avankest 1445: <p>Switch the state to <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span>.</p>
1.203 avankest 1446:
1.273 avankest 1447: <p class="note">No <code title="event-xhr-readystatechange">readystatechange</code> event is dispatched.</p>
1.203 avankest 1448: </li>
1449: </ol>
1450:
1451:
1452:
1.205 avankest 1453: <h3 id="response">Response</h3>
1.203 avankest 1454:
1455: <h4>The <code title="">status</code> attribute</h4>
1456:
1.276 avankest 1457: <dl class="domintro">
1458: <dt><var title="">client</var> . <code title="dom-XMLHttpRequest-status">status</code></dt>
1459: <dd><p>Returns the HTTP status code.</p></dd>
1460: </dl>
1461:
1462: <p>The
1463: <dfn id="dom-xmlhttprequest-status" title="dom-XMLHttpRequest-status"><code>status</code></dfn>
1464: attribute <em class="ct">must</em> return the result of running these
1465: steps:</p>
1.226 avankest 1466:
1.222 avankest 1467: <ol>
1.272 avankest 1468: <li><p>If the state is <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span> or
1469: <span title="dom-XMLHttpRequest-OPENED">OPENED</span> return 0 and terminate these
1.222 avankest 1470: steps.</p></li>
1471:
1.239 avankest 1472: <li><p>If the <span>error flag</span> is true return 0 and terminate
1473: these steps.</p></li>
1.222 avankest 1474:
1475: <li><p>Return the HTTP status code.</p></li>
1.248 avankest 1476: </ol>
1.203 avankest 1477:
1478:
1479: <h4>The <code title="">statusText</code> attribute</h4>
1480:
1.276 avankest 1481: <dl class="domintro">
1482: <dt><var title="">client</var> . <code title="dom-XMLHttpRequest-statusText">statusText</code></dt>
1483: <dd><p>Returns the HTTP status text.</p></dd>
1484: </dl>
1485:
1486: <p>The
1487: <dfn id="dom-xmlhttprequest-statustext" title="dom-XMLHttpRequest-statusText"><code>statusText</code></dfn>
1488: attribute <em class="ct">must</em> return the result of running these
1489: steps:</p>
1.222 avankest 1490:
1491: <ol>
1.272 avankest 1492: <li><p>If the state is <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span> or
1493: <span title="dom-XMLHttpRequest-OPENED">OPENED</span> return the empty string and
1.239 avankest 1494: terminate these steps.</p></li>
1.222 avankest 1495:
1496: <li><p>If the <span>error flag</span> is true return the empty string and
1497: terminate these steps.</p></li>
1498:
1499: <li><p>Return the HTTP status text.</p></li>
1500: </ol>
1.203 avankest 1501:
1502:
1503: <h4>The <code title="">getResponseHeader()</code> method</h4>
1504:
1505: <p>When the
1.270 avankest 1506: <dfn id="dom-xmlhttprequest-getresponseheader" title="getresponseheader"><code>getResponseHeader(<var>header</var>)</code></dfn>
1.217 avankest 1507: is invoked, the user agent <em class="ct">must</em> run these steps:</p>
1.203 avankest 1508:
1509: <ol>
1.272 avankest 1510: <li><p>If the state is <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span> or
1511: <span title="dom-XMLHttpRequest-OPENED">OPENED</span> return null and terminate these
1.203 avankest 1512: steps.</p></li>
1513:
1.239 avankest 1514: <li><p>If the <span>error flag</span> is true return null
1.203 avankest 1515: and terminate these steps.</p></li>
1516:
1.256 avankest 1517: <li><p>If any code point in <var>header</var> is higher than
1518: U+00FF LATIN SMALL LETTER Y WITH DIAERESIS return null and terminate
1519: these steps.</p></li>
1520:
1521: <li><p>Let <var>header</var> be the result of
1522: <span title="deflate a DOMString into an byte sequence">deflating</span>
1523: <var>header</var>.</p></li> <!-- This sounds lame, but it works. -->
1524:
1525: <li><p>If <var>header</var> is a case-insensitive match for
1526: <code>Set-Cookie</code> or <code>Set-Cookie2</code> return null and
1527: terminate these steps.</p></li>
1.203 avankest 1528:
1.256 avankest 1529: <li><p>If <var>header</var> is a case-insensitive match for multiple HTTP
1530: response headers, return the
1531: <span title="inflate an byte sequence into a DOMString">inflated</span>
1532: values of these headers as a single concatenated string separated from
1533: each other by a U+002C COMMA U+0020 SPACE character pair and terminate
1534: these steps.</p></li>
1.203 avankest 1535:
1.256 avankest 1536: <li><p>If <var>header</var> is a case-insensitive match for a single HTTP
1537: response header, return the
1538: <span title="inflate an byte sequence into a DOMString">inflated</span>
1539: value of that header and terminate these steps.</p></li>
1.203 avankest 1540:
1.239 avankest 1541: <li><p>Return null.</p></li>
1.203 avankest 1542: </ol>
1543:
1.248 avankest 1544:
1545:
1.203 avankest 1546: <div class="example">
1.250 avankest 1547:
1548: <p>For the following script:</p>
1549:
1550: <pre><code>var client = new XMLHttpRequest();
1551: client.open("GET", "unicorns-are-teh-awesome.txt", true);
1.5 avankest 1552: client.send();
1.12 avankest 1553: client.onreadystatechange = function() {
1.250 avankest 1554: if(this.readyState == 2) {
1555: print(client.getResponseHeader("Content-Type"));
1556: }
1557: }</code></pre>
1558:
1559: <p>The <code>print()</code> function will get to process something
1560: like:</p>
1.5 avankest 1561:
1.250 avankest 1562: <pre><code>text/plain; charset=UTF-8</code></pre>
1.203 avankest 1563: </div>
1.12 avankest 1564:
1565:
1.203 avankest 1566: <h4>The <code title="">getAllResponseHeaders()</code> method</h4>
1.14 avankest 1567:
1.203 avankest 1568: <p>When the
1.270 avankest 1569: <dfn id="dom-xmlhttprequest-getallresponseheaders"><code>getAllResponseHeaders()</code></dfn>
1.203 avankest 1570: method is invoked, the user agent <em class="ct">must</em> run the
1571: following steps:</p>
1.58 avankest 1572:
1.203 avankest 1573: <ol>
1.272 avankest 1574: <li><p>If the state is <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span> or
1575: <span title="dom-XMLHttpRequest-OPENED">OPENED</span> return the empty string and
1.239 avankest 1576: terminate these steps.</p></li>
1.203 avankest 1577:
1578: <li><p>If the <span>error flag</span> is true return the empty string and
1579: terminate these steps.</p></li>
1580:
1.256 avankest 1581: <li><p>Return all the HTTP headers, excluding headers that are a
1582: case-insensitive match for <code>Set-Cookie</code> or
1583: <code>Set-Cookie2</code>,
1584: <span title="inflate an byte sequence into a DOMString">inflated</span>,
1585: as a single string, with each header line
1586: separated by a U+000D CR U+000A LF pair, excluding the status line, and
1.203 avankest 1587: with each header name and header value separated by a
1588: U+003A COLON U+0020 SPACE pair.</p></li>
1589: </ol>
1.58 avankest 1590:
1.250 avankest 1591:
1592:
1.203 avankest 1593: <div class="example">
1.250 avankest 1594: <p>For the following script:</p>
1595:
1596: <pre><code>var client = new XMLHttpRequest();
1597: client.open("GET", "narwhals-too.txt", true);
1.5 avankest 1598: client.send();
1.12 avankest 1599: client.onreadystatechange = function() {
1.179 avankest 1600: if(this.readyState == 2) {
1.203 avankest 1601: print(this.getAllResponseHeaders());
1.12 avankest 1602: }
1.250 avankest 1603: }</code></pre>
1604:
1605: <p>The <code>print()</code> function will get to process something
1606: like:</p>
1.1 avankest 1607:
1.250 avankest 1608: <pre><code>Date: 2004年10月24日 04:58:38 GMT
1.203 avankest 1609: Server: Apache/1.3.31 (Unix)
1610: Keep-Alive: timeout=15, max=99
1611: Connection: Keep-Alive
1612: Transfer-Encoding: chunked
1613: Content-Type: text/plain; charset=utf-8</code></pre>
1614: </div>
1615:
1.250 avankest 1616:
1.203 avankest 1617:
1618: <h4>Response Entity Body</h4>
1619:
1.248 avankest 1620: <p>The <dfn id="response-mime-type">response MIME type</dfn> is the MIME
1621: type the <code>Content-Type</code> header contains without any
1622: parameters or null if the header could not be parsed properly or was
1623: omitted. The <dfn id="override-mime-type">override MIME type</dfn> is
1624: always null. <dfn id="final-mime-type">Final MIME type</dfn> is the
1625: override MIME type unless that is null in which case it is the response
1626: MIME type.</p>
1627:
1628: <p>The <dfn id="response-charset">response charset</dfn> is the value of
1629: the <code>charset</code> parameter of the <code>Content-Type</code> header
1630: or null if there was no <code>charset</code> parameter or if
1631: the header could not be parsed properly or was omitted. The
1632: <dfn id="override-charset">override charset</dfn> is always null.
1633: <dfn id="final-charset">Final charset</dfn> is the override charset unless
1634: that is null in which case it is the response charset.</p>
1.250 avankest 1635:
1.248 avankest 1636:
1637: <p class="note"><span>Override MIME type</span> and
1638: <span>override charset</span> are introduced here solely to make editing
1639: several levels of XMLHttpRequest simultaneously somewhat easier. Apologies
1640: for any confusion they might cause.</p>
1641:
1.250 avankest 1642:
1.248 avankest 1643: <hr>
1644:
1.203 avankest 1645: <p>The <dfn id="response-entity-body">response entity body</dfn> is the
1.255 avankest 1646: fragment of the <span>entity body</span> of the response received so far
1.272 avankest 1647: (<span title="dom-XMLHttpRequest-LOADING">LOADING</span>) or the complete entity body
1648: of the response (<span title="dom-XMLHttpRequest-DONE">DONE</span>). If the response
1.255 avankest 1649: does not have an entity body the response entity body is null.</p>
1650:
1651: <p class="note">The <span>response entity body</span> is updated as part
1.271 avankest 1652: of the <code title="dom-XMLHttpRequest-send">send()</code> algorithm.</p>
1.250 avankest 1653:
1.203 avankest 1654: <hr>
1655:
1656: <p>The <dfn id="text-response-entity-body">text response entity body</dfn>
1.248 avankest 1657: is a <code>DOMString</code> representing the <span>response entity
1658: body</span>. The text response entity body is the return value of the
1.203 avankest 1659: following algorithm:</p>
1660:
1661: <ol>
1.248 avankest 1662: <li><p>If the response entity body is null return the empty string and
1663: terminate these steps.</p>
1664:
1665: <li><p>Let <var>charset</var> be the <span>final charset</span>.</p></li>
1.203 avankest 1666:
1.248 avankest 1667: <li><p>Let <var>mime</var> be the <span>final MIME type</span>.</p></li>
1.203 avankest 1668:
1.248 avankest 1669: <li><p>If <var>charset</var> is null and <var>mime</var> is null,
1.203 avankest 1670: <code>text/xml</code>, <code>application/xml</code> or ends in
1.248 avankest 1671: <code title="">+xml</code> use the rules set forth in the XML
1672: specifications to determine the character encoding. Let
1673: <var>charset</var> be the determined character encoding.</p></li>
1674:
1675: <li><p>If <var>charset</var> is null and <var>mime</var> is
1676: <code>text/html</code> follow the rules set forth in the HTML
1677: specification to determine the character encoding. Let
1.203 avankest 1678: <var>charset</var> be the determined character encoding.
1679: [<cite><span>HTML5</span></cite>]</p></li>
1680:
1681: <li>
1682: <p>If <var>charset</var> is null then, for each of the rows in the
1683: following table, starting with the first one and going down, if the first
1684: bytes of <var>bytes</var> match the bytes given in the first column, then
1685: let <var>charset</var> be the encoding given in the cell in the second
1686: column of that row. If there is no match <var>charset</var> remains
1687: null.</p>
1688:
1689: <table>
1690: <thead>
1691: <tr>
1692: <th>Bytes in Hexadecimal
1693: <th>Description
1.237 avankest 1694: <tbody>
1.203 avankest 1695: <tr>
1696: <td>FE FF
1697: <td>UTF-16BE BOM
1698: <tr>
1699: <td>FF FE
1700: <td>UTF-16LE BOM
1701: <tr>
1702: <td>EF BB BF
1.237 avankest 1703: <td>UTF-8 BOM
1.203 avankest 1704: </table>
1705: </li>
1706:
1707: <li><p>If <var>charset</var> is null let <var>charset</var> be
1708: UTF-8.</p></li>
1709:
1710: <li><p>Return the result of decoding the response entity body using
1711: <var>charset</var>. Replace bytes or sequences of bytes that are not
1.248 avankest 1712: valid accordng to the <var>charset</var> with a single
1713: U+FFFD REPLACEMENT CHARACTER character.</p></li>
1.203 avankest 1714: </ol>
1715:
1716: <p class="note">Authors are strongly encouraged to encode their resources
1717: using UTF-8.</p>
1.248 avankest 1718:
1.203 avankest 1719: <hr>
1720:
1.248 avankest 1721: <p>The <dfn id="document-response-entity-body">document response entity
1722: body</dfn> is either a <code>Document</code> representing the
1723: <span>response entity body</span> or null. The document
1724: response entity body is the return value of the following algorithm:</p>
1.12 avankest 1725:
1.203 avankest 1726: <ol>
1727: <li><p>If the <span>response entity body</span> is null terminate these
1.239 avankest 1728: steps and return null.</p></li>
1.12 avankest 1729:
1.248 avankest 1730: <li><p>If <span>final MIME type</span> is not null,
1731: <code>text/xml</code>,
1732: <code>application/xml</code>, and does not end in
1733: <code title="">+xml</code> terminate these steps and return
1734: null.</li>
1735:
1736:
1.203 avankest 1737:
1738: <li>
1.265 avankest 1739: <p>Let <var>document</var> be a
1740: <span>cookie-free <code>Document</code> object</span> that represents
1741: the result of parsing the response entity body into a document tree
1742: following the rules from the XML specifications. If this fails
1743: (unsupported character encoding, namespace well-formedness error et
1744: cetera) terminate these steps return null.
1745: [<cite><span>XML</span></cite>]</p>
1.248 avankest 1746:
1747: <p class="note">Scripts in the resulting document tree will not be executed,
1748: resources referenced will not be loaded and no associated XSLT will be
1749: applied.</p>
1.203 avankest 1750: </li>
1.88 avankest 1751:
1.248 avankest 1752: <li><p>Return <var>document</var>.</p></li>
1.203 avankest 1753: </ol>
1.12 avankest 1754:
1755:
1.248 avankest 1756:
1757:
1758:
1.203 avankest 1759: <h4>The <code title="">responseText</code> attribute</h4>
1.12 avankest 1760:
1.276 avankest 1761: <dl class="domintro">
1762: <dt><var title="">client</var> . <code title="dom-XMLHttpRequest-responseText">responseText</code></dt>
1763: <dd><p>Returns the <span>text response entity body</span>.</p></dd>
1764: </dl>
1765:
1766: <p>The
1767: <dfn id="dom-xmlhttprequest-responsetext" title="dom-XMLHttpRequest-responseText"><code>responseText</code></dfn>
1768: attribute <em class="ct">must</em> return the result of running these
1769: steps:</p>
1.79 avankest 1770:
1.203 avankest 1771: <ol>
1.272 avankest 1772: <li><p>If the state is not <span title="dom-XMLHttpRequest-LOADING">LOADING</span> or
1773: <span title="dom-XMLHttpRequest-DONE">DONE</span> return the empty string and
1.203 avankest 1774: terminate these steps.</p></li>
1.75 avankest 1775:
1.203 avankest 1776: <li><p>Return the <span>text response entity body</span>.</p></li>
1777: </ol>
1.12 avankest 1778:
1779:
1.203 avankest 1780: <h4>The <code title="">responseXML</code> attribute</h4>
1.12 avankest 1781:
1.276 avankest 1782: <dl class="domintro">
1783: <dt><var title="">client</var> . <code title="dom-XMLHttpRequest-responseXML">responseXML</code></dt>
1784: <dd><p>Returns the <span>document response entity body</span>.</p></dd>
1785: </dl>
1786:
1787:
1788: <p>The
1789: <dfn id="dom-xmlhttprequest-responsexml" title="dom-XMLHttpRequest-responseXML"><code>responseXML</code></dfn>
1790: attribute <em class="ct">must</em> return the result of running these
1791: steps:</p>
1.12 avankest 1792:
1.203 avankest 1793: <ol>
1.272 avankest 1794: <li><p>If the state is not <span title="dom-XMLHttpRequest-DONE">DONE</span> return
1.239 avankest 1795: null and terminate these steps.</p></li>
1.12 avankest 1796:
1.248 avankest 1797: <li><p>Return the <span>document response entity body</span>.</p></li>
1.203 avankest 1798: </ol>
1.121 avankest 1799:
1.248 avankest 1800:
1801:
1.12 avankest 1802:
1.240 avankest 1803: <h2 id="exceptions">Exceptions</h2>
1.24 avankest 1804:
1.138 avankest 1805: <p>Several algorithms in this specification may result in an exception
1806: being thrown. These exceptions are all part of the group
1.185 avankest 1807: <code>ExceptionCode</code> and use the <code>DOMException</code> object,
1.138 avankest 1808: which is defined in DOM Level 3 Core. In addition this specification
1809: extends the <code>ExceptionCode</code> group with several new
1810: constants as indicated below. [<cite><span>DOM3Core</span></cite>]</p>
1.203 avankest 1811:
1.193 avankest 1812: <p class="note">Thus, exceptions used by this specification and not
1813: defined in this section are defined by DOM Level 3 Core.</p>
1.31 avankest 1814:
1.138 avankest 1815: <pre class="idl">const unsigned short <span>SECURITY_ERR</span> = 18;
1.199 avankest 1816: const unsigned short <span>NETWORK_ERR</span> = 19;
1817: const unsigned short <span>ABORT_ERR</span> = 20;</pre>
1.31 avankest 1818:
1.138 avankest 1819: <p>The <dfn id="security-err"><code>SECURITY_ERR</code></dfn> exception is
1820: raised if an attempt is made to perform an operation or access some data
1821: in a way that would be a security risk or a violation of the user agent's
1822: security policy.</p>
1823:
1824: <!-- http://lists.w3.org/Archives/Public/public-webapi/2006May/0027.html -->
1825:
1.33 avankest 1826: <p>The <dfn id="network-err"><code>NETWORK_ERR</code></dfn> exception is
1.138 avankest 1827: raised when a network error occurs in synchronous requests.</p>
1.121 avankest 1828:
1.138 avankest 1829: <p>The <dfn id="abort-err"><code>ABORT_ERR</code></dfn> exception is
1830: raised when the user aborts a request in synchronous requests.</p>
1.248 avankest 1831:
1832:
1.203 avankest 1833:
1.240 avankest 1834: <p class="note">These exceptions will be folded into an update of
1.199 avankest 1835: DOM Level 3 Core in due course, as they are appropriate for other API
1836: specifications as well.</p>
1.121 avankest 1837:
1.248 avankest 1838:
1.29 avankest 1839: <h2 class="no-num" id="notcovered">Not in this Specification</h2>
1840:
1.143 avankest 1841: <p><em>This section is non-normative.</em></p>
1.29 avankest 1842:
1.72 avankest 1843: <p>This specification does not include the following features which are
1844: being considered for a future version of this specification:</p>
1.29 avankest 1845:
1846: <ul>
1.273 avankest 1847: <li><code title="event-xhr-load">load</code> event and <code>onload</code> attribute;</li>
1848: <li><code title="event-xhr-error">error</code> event and <code>onerror</code> attribute;</li>
1849: <li><code title="event-xhr-progress">progress</code> event and <code>onprogress</code> attribute;</li>
1.29 avankest 1850: <li><code title="">abort</code> event and <code>onabort</code> attribute;</li>
1851: <li>Timers have been suggested, perhaps an <code>ontimeout</code>
1852: attribute;</li>
1853: <li>Property to disable following redirects;</li>
1.30 avankest 1854: <li><code title="">responseXML</code> for <code>text/html</code>
1855: documents;</li>
1.203 avankest 1856: <li>Cross-origin <code title="">XMLHttpRequest</code>;</li>
1.87 avankest 1857: <li><code>responseBody</code> to deal with byte streams;</li>
1.114 avankest 1858: <li><code>overrideMimeType</code> to fix up MIME types;</li>
1.87 avankest 1859: <li><code>getRequestHeader()</code> and
1860: <code>removeRequestHeader()</code>.</li>
1.29 avankest 1861: </ul>
1.248 avankest 1862:
1.29 avankest 1863:
1.203 avankest 1864:
1.248 avankest 1865:
1866:
1.203 avankest 1867:
1.248 avankest 1868: <h2 class="no-num" id="references">References</h2>
1.203 avankest 1869:
1.177 avankest 1870: <p>Unless marked "Non-normative" these references are normative.</p>
1.11 avankest 1871:
1.6 avankest 1872: <dl>
1.230 avankest 1873: <dt>[<dfn id="ref-cookies">COOKIES</dfn>]</dt>
1.268 avankest 1874: <dd><cite><a href="http://tools.ietf.org/html/draft-ietf-httpstate-cookie">HTTP
1875: State Management Mechanism</a></cite> (work in progress), A. Barth. IETF.</dd>
1.203 avankest 1876:
1.248 avankest 1877:
1878:
1.155 avankest 1879: <dt>[<dfn id="ref-dom2events">DOM2Events</dfn>]</dt>
1880: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-2-Events/">Document
1.267 avankest 1881: Object Model (DOM) Level 2 Events Specification</a></cite>, T. Pixley.
1882: W3C.</dd>
1.155 avankest 1883:
1.145 avankest 1884: <dt>[<dfn id="ref-dom3core">DOM3Core</dfn>]</dt>
1.11 avankest 1885: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-3-Core">Document Object
1.92 avankest 1886: Model (DOM) Level 3 Core Specification</a></cite>, A. Le Hors, P. Le
1.267 avankest 1887: Hégaret, L. Wood, G. Nicol, J. Robie, M. Champion, S. Byrne.
1888: W3C.</dd>
1.11 avankest 1889:
1.117 avankest 1890: <dt>[<dfn id="ref-ecmascript">ECMAScript</dfn>]</dt>
1.92 avankest 1891: <dd><cite><a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript
1.267 avankest 1892: Language Specification</a></cite>. ECMA.</dd>
1.248 avankest 1893:
1894:
1.171 avankest 1895:
1.145 avankest 1896: <dt>[<dfn id="ref-html5">HTML5</dfn>]</dt>
1.250 avankest 1897: <dd><cite><a href="http://www.w3.org/html/wg/html5/">HTML5</a></cite>
1.267 avankest 1898: (work in progress), I. Hickson. W3C.</dd>
1.250 avankest 1899: <dd><cite><a href="http://www.whatwg.org/specs/html5/current-work/">HTML5</a></cite>
1.267 avankest 1900: (work in progress), I. Hickson. WHATWG.</dd>
1.198 avankest 1901:
1902: <dt>[<dfn id="ref-httpverbsec">HTTPVERBSEC</dfn>]</dt>
1.248 avankest 1903: <dd>(Non-normative)
1904: <cite><a href="http://www.kb.cert.org/vuls/id/867593">Multiple vendors'
1905: web servers enable HTTP TRACE method by default</a></cite>, US-CERT.</dd>
1906: <dd>(Non-normative)
1907: <cite><a href="http://www.kb.cert.org/vuls/id/288308">Microsoft Internet
1908: Information Server (IIS) vulnerable to cross-site scripting via HTTP
1909: TRACK method</a></cite>, US-CERT.</dd>
1910: <dd>(Non-normative)
1911: <cite><a href="http://www.kb.cert.org/vuls/id/150227">HTTP proxy default
1912: configurations allow arbitrary TCP connections</a></cite>, US-CERT.</dd>
1913:
1914:
1915:
1916: <dt>[<dfn id="ref-rfc2046">RFC2046</dfn>]</dt>
1917: <dd><cite><a href="http://ietf.org/rfc/rfc2046">Multipurpose Internet Mail
1918: Extensions (MIME) Part Two: Media Types</a></cite>, N. Freed, N.
1.267 avankest 1919: Borenstein. IETF.</dd>
1.198 avankest 1920:
1.145 avankest 1921: <dt>[<dfn id="ref-rfc2119">RFC2119</dfn>]</dt>
1.117 avankest 1922: <dd><cite><a href="http://ietf.org/rfc/rfc2119">Key words for use in RFCs to
1.267 avankest 1923: Indicate Requirement Levels</a></cite>, S. Bradner. IETF.</dd>
1.12 avankest 1924:
1.248 avankest 1925: <dt>[<dfn id="rfc-rfc2616">RFC2616</dfn>]</dt>
1.11 avankest 1926: <dd><cite><a href="http://ietf.org/rfc/rfc2616">Hypertext Transfer Protocol
1.92 avankest 1927: -- HTTP/1.1</a></cite>, R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L.
1.267 avankest 1928: Masinter, P. Leach, T. Berners-Lee. IETF.</dd>
1.12 avankest 1929:
1.37 avankest 1930: <dt>[<dfn id="ref-rfc2617">RFC2617</dfn>]</dt>
1.11 avankest 1931: <dd><cite><a href="http://ietf.org/rfc/rfc2617">HTTP Authentication: Basic
1.92 avankest 1932: and Digest Access Authentication</a></cite>, P. Hallam-Baker, J.
1.267 avankest 1933: Hostetler, S. Lawrence, P. Leach, A. Luotonen, L. Stewart. IETF.</dd>
1.12 avankest 1934:
1.37 avankest 1935: <dt>[<dfn id="ref-rfc3986">RFC3986</dfn>]</dt>
1.11 avankest 1936: <dd><cite><a href="http://ietf.org/rfc/rfc3986">Uniform Resource Identifier
1.267 avankest 1937: (URI): Generic Syntax</a></cite>, T. Berners-Lee, R. Fielding, L.
1938: Masinter. IETF.</dd>
1.184 avankest 1939:
1.248 avankest 1940: <dt>[<dfn id=ref-rfc3987>RFC3987</dfn>]</dt>
1941: <dd><cite><a href="http://ietf.org/rfc/rfc3987">Internationalized
1.267 avankest 1942: Resource Identifiers (IRIs)</a></cite>, M. Duerst, M. Suignard.
1943: IETF.</dd>
1.248 avankest 1944:
1.203 avankest 1945: <dt>[<dfn id="ref-webidl">WebIDL</dfn>]</dt>
1.200 avankest 1946: <dd><cite><a href="http://dev.w3.org/2006/webapi/WebIDL/">Web
1.267 avankest 1947: IDL</a></cite> (work in progress), C. McCormack. W3C.</dd> <!-- XXX add Sam -->
1.181 avankest 1948:
1.92 avankest 1949: <dt>[<dfn id="ref-xml">XML</dfn>]</dt>
1950: <dd><cite><a href="http://www.w3.org/TR/xml/">Extensible Markup Language
1.267 avankest 1951: (XML) 1.0</a></cite>, T. Bray, J. Paoli, C. Sperberg-McQueen, E. Maler,
1952: F. Yergeau. W3C.</dd>
1953: <dd><cite><a href="http://www.w3.org/TR/xml-names/">Namespaces in
1954: XML</a></cite>, T. Bray, D. Hollander, A. Layman, R. Tobin, H. S.
1955: Thompson. W3C.</dd>
1.1 avankest 1956: </dl>
1.11 avankest 1957:
1.203 avankest 1958:
1959:
1.130 avankest 1960: <h2 class="no-num" id="acknowledgments">Acknowledgments</h2>
1.11 avankest 1961:
1.159 avankest 1962: <p>The editor would like to thank
1.12 avankest 1963:
1.163 avankest 1964: Addison Phillips,
1.159 avankest 1965: Ahmed Kamel,
1966: Alex Hopmann,
1967: Alex Vincent,
1968: Alexey Proskuryakov,
1969: Asbjørn Ulsberg,
1970: Boris Zbarsky,
1971: Björn Höhrmann,
1972: Cameron McCormack,
1973: Christophe Jolif,
1974: Charles McCathieNevile,
1975: Dan Winship,
1.248 avankest 1976: David Andersson,
1.159 avankest 1977: David Håsäther,
1.248 avankest 1978: David Levin,
1.159 avankest 1979: Dean Jackson,
1980: Denis Sureau,
1981: Doug Schepers,
1982: Douglas Livingstone,
1983: Elliotte Harold,
1984: Eric Lawrence,
1.196 avankest 1985: Erik Dahlström,
1.163 avankest 1986: Geoffrey Sneddon,
1.159 avankest 1987: Gideon Cohn,
1988: Gorm Haug Eriksen,
1.247 avankest 1989: Håkon Wium Lie,
1.159 avankest 1990: Hallvord R. M. Steen,
1.247 avankest 1991: Huub Schaeks,
1.159 avankest 1992: Ian Davis,
1993: Ian Hickson,
1994: Ivan Herman,
1995: Jeff Walden,
1996: Jens Lindström,
1997: Jim Deegan,
1998: Jim Ley,
1999: Joe Farro,
2000: Jonas Sicking,
2001: Julian Reschke,
2002: Karl Dubost,
1.175 avankest 2003: Lachlan Hunt,
1.159 avankest 2004: Maciej Stachowiak,
2005: Magnus Kristiansen,
2006: Marc Hadley,
2007: Marcos Caceres,
2008: Mark Baker,
1.203 avankest 2009: Mark Birbeck,
1.159 avankest 2010: Mark Nottingham,
1.267 avankest 2011: Mark S. Miller,
1.248 avankest 2012: Martin Hassman,
1.159 avankest 2013: Mohamed Zergaoui,
1.256 avankest 2014: Olli Pettay,
1.159 avankest 2015: Pawel Glowacki,
1.231 avankest 2016: Peter Michaux,
1.264 avankest 2017: Philip Taylor,
1.159 avankest 2018: Robin Berjon,
1.248 avankest 2019: Rune Halvorsen,
1.159 avankest 2020: Ruud Steltenpool,
2021: Simon Pieters,
2022: Stewart Brodie,
2023: Sunava Dutta,
1.186 avankest 2024: Thomas Roessler,
1.203 avankest 2025: Tom Magliery, and
1.159 avankest 2026: Zhenbin Xu
1.181 avankest 2027:
1.159 avankest 2028: for their contributions to this specification.</p>
1.12 avankest 2029:
1.1 avankest 2030: <p>Special thanks to the Microsoft employees who first implemented the
1.143 avankest 2031: <code title="">XMLHttpRequest</code> interface, which was first widely
2032: deployed by the Windows Internet Explorer browser.</p>
1.12 avankest 2033:
1.143 avankest 2034: <p>Special thanks also to the WHATWG for drafting an initial version of
2035: this specification in their Web Applications 1.0 document (now renamed to
1.250 avankest 2036: HTML5). [<cite><span>HTML5</span></cite>]</p>
1.12 avankest 2037:
1.143 avankest 2038: <p>Thanks also to all those who have helped to improve this specification
2039: by sending suggestions and corrections. (Please, keep bugging us with your
1.22 avankest 2040: issues!)</p>
1.1 avankest 2041: </body>
2042: </html>
1.211 avankest 2043:
Webmaster