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