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