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