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