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