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