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