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