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