Annotation of 2006/webapi/XMLHttpRequest/Overview.src.html, revision 1.96
1.60 avankest 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
1.1 avankest 2: <html lang="en-US">
3: <head>
4: <title>The XMLHttpRequest Object</title>
1.16 avankest 5: <style type="text/css">
6: pre.idl { border:solid thin; background:#eee; color:#000; padding:0.5em }
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.89 avankest 12: .issue { padding:.5em; border:solid #f00 }
1.16 avankest 13: p.issue::before { content:"Issue: " }
14: em.ct { text-transform:lowercase; font-variant:small-caps; font-style:normal }
15: dfn { font-weight:bold; font-style:normal }
16: code { color:orangered }
17: code :link, code :visited { color:inherit }
18: </style>
1.7 avankest 19: <link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/base">
1.58 avankest 20: <!--<link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-WD">-->
1.1 avankest 21: </head>
22: <body>
23: <div class="head">
24: <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 25:
1.10 avankest 26: <h1 class="head">The <code title="">XMLHttpRequest</code> Object</h1>
1.12 avankest 27:
1.53 avankest 28: <h2 class="no-num no-toc" id="pagesubtitle">Editor's draft<!--W3C Working Draft--> [DATE: 3 August 2002]</h2>
1.12 avankest 29:
1.1 avankest 30: <dl>
1.10 avankest 31: <dt>This Version:</dt>
1.24 avankest 32:
1.47 avankest 33: <dd><a href="[VERSION]/">http://www.w3.org/TR/[YEAR]/WD-XMLHttpRequest-[CDATE]/</a></dd>
1.14 avankest 34:
1.10 avankest 35: <dt>Latest Version:</dt>
1.24 avankest 36:
1.1 avankest 37: <dd><a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a></dd>
1.14 avankest 38:
1.10 avankest 39: <dt>Previous Versions:</dt>
1.24 avankest 40:
1.58 avankest 41: <dd><a href="http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070227/">http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070227/</a></dd>
42:
1.22 avankest 43: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060927/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060927/</a></dd>
1.24 avankest 44:
1.1 avankest 45: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/</a></dd>
1.24 avankest 46:
1.1 avankest 47: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/</a></dd>
1.14 avankest 48:
1.1 avankest 49: <dt>Editor:</dt>
1.24 avankest 50:
1.1 avankest 51: <dd><a href="http://annevankesteren.nl/">Anne van Kesteren</a>
52: (<a href="http://www.opera.com/">Opera Software ASA</a>)
53: <<a href="mailto:annevk@opera.com">annevk@opera.com</a>></dd>
54: </dl>
1.14 avankest 55:
1.1 avankest 56: <p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a>
1.51 avankest 57: © 2007
58: <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a><sup>®</sup>
59: (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>,
60: <a href="http://www.ercim.org/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>,
61: <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C
62: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
63: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>
64: and
65: <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document
66: use</a> rules apply.</p>
1.1 avankest 67: </div>
1.12 avankest 68:
1.1 avankest 69: <hr>
1.12 avankest 70:
1.1 avankest 71: <h2 class="no-num no-toc" id="specabstract">Abstract</h2>
1.10 avankest 72:
1.22 avankest 73: <p>The <code title="">XMLHttpRequest</code> Object specification defines an
74: <abbr title="Application Programming Interface">API</abbr> that provides
75: scripted client functionality for transferring data between a client and a
76: server.</p>
1.12 avankest 77:
1.1 avankest 78: <h2 class="no-num no-toc" id="sotd">Status of this Document</h2>
1.12 avankest 79:
1.1 avankest 80: <p><em>This section describes the status of this document at the time of its
1.36 avankest 81: publication. Other documents may supersede this document. A list of current
82: W3C publications and the latest revision of this technical report can be
83: found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a>
84: at http://www.w3.org/TR/.</em></p>
85:
1.63 avankest 86: <!-- change back to Last Call -->
87: <p>This is the [DATE: 3 August 2002] <strong>Editor's</strong> Working
1.54 avankest 88: Draft of The <code title="">XMLHttpRequest</code> Object specification.
1.47 avankest 89: Please send comments to
90: <a href="mailto:public-webapi@w3.org">public-webapi@w3.org</a>
91: (<a href="http://lists.w3.org/Archives/Public/public-webapi/">archived</a>)
92: with either <samp>[XHR]</samp> or <samp title="">[XMLHttpRequest]</samp> at
1.63 avankest 93: the start of the subject line<!-- by 2 April 2007-->.</p>
1.51 avankest 94:
1.47 avankest 95: <p>This document is produced by the
96: <a href="http://www.w3.org/2006/webapi/">Web API Working Group</a>, part of
97: the <a href="http://www.w3.org/2006/rwc/Activity">Rich Web Clients
98: Activity</a> in the W3C <a href="http://www.w3.org/Interaction/">Interaction
1.51 avankest 99: Domain</a>. Changes made to this document can be found in the
1.47 avankest 100: <a href="http://dev.w3.org/cvsweb/2006/webapi/XMLHttpRequest/Overview.html">W3C
101: public CVS server</a>.</p>
1.12 avankest 102:
1.1 avankest 103: <p>Publication as a Working Draft does not imply endorsement by the W3C
1.36 avankest 104: Membership. This is a draft document and may be updated, replaced or
105: obsoleted by other documents at any time. It is inappropriate to cite this
106: document as other than work in progress.</p>
1.12 avankest 107:
1.1 avankest 108: <p>This document was produced by a group operating under the
1.36 avankest 109: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February
1.52 avankest 110: 2004 W3C Patent Policy</a>. W3C maintains a
1.36 avankest 111: <a rel="disclosure" href="http://www.w3.org/2004/01/pp-impl/38482/status">public
112: list of any patent disclosures</a> made in connection with the deliverables
113: of the group; that page also includes instructions for disclosing a patent.
114: An individual who has actual knowledge of a patent which the individual
115: believes contains
116: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential
117: Claim(s)</a> must disclose the information in accordance with
118: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section
119: 6 of the W3C Patent Policy</a>.</p>
1.12 avankest 120:
1.1 avankest 121: <h2 class="no-num no-toc" id="toc">Table of Contents</h2>
1.21 avankest 122:
1.1 avankest 123: <!--toc-->
1.12 avankest 124:
1.1 avankest 125: <h2 id="introduction">Introduction</h2>
1.12 avankest 126:
1.1 avankest 127: <p><em>This section is non-normative.</em></p>
1.12 avankest 128:
1.33 avankest 129: <p>The <code>XMLHttpRequest</code> object implements an interface exposed by
130: a scripting engine that allows scripts to perform HTTP client functionality,
1.22 avankest 131: such as submitting form data or loading data from a server.</p>
1.24 avankest 132:
1.1 avankest 133: <p>The name of the object is <code>XMLHttpRequest</code> for compatibility
1.22 avankest 134: with the web, though each component of this name is potentially misleading.
1.39 avankest 135: First, the object supports any text based format, including XML. Second, it
136: can be used to make requests over both HTTP and HTTPS (some implementations
137: support protocols in addition to HTTP and HTTPS, but that functionality is
138: not covered by this specification). Finally, it supports "requests" in a
139: broad sense of the term as it pertains to HTTP; namely all activity involved
140: with HTTP requests or responses for the defined HTTP methods.</p>
1.12 avankest 141:
1.1 avankest 142: <h3 id="examples">Examples of Usage</h3>
1.12 avankest 143:
1.1 avankest 144: <p><em>This section is non-normative.</em></p>
1.12 avankest 145:
1.37 avankest 146: <p>Some [<cite><span>ECMAScript</span></cite>] examples
1.32 avankest 147: are listed in the specification. In addition, you can find some below.</p>
1.14 avankest 148:
149: <div class="example">
150: <p>Some simple code to do something with data from an XML document fetched
1.22 avankest 151: over the network:</p>
1.16 avankest 152:
1.58 avankest 153: <pre><code>function test(data) {
1.14 avankest 154: // taking care of data
155: }
156:
157: function handler() {
158: if(this.readyState == 4 && this.status == 200) {
159: // so far so good
160: if(this.responseXML != null && this.responseXML.getElementById('test').firstChild.data)
161: // success!
162: test(this.responseXML.getElementById('test').firstChild.data);
163: else
164: test(null);
165: } else if (this.readyState == 4 && this.status != 200) {
166: // fetched the wrong page or network error...
167: test(null);
168: }
169: }
1.12 avankest 170:
1.14 avankest 171: var client = new XMLHttpRequest();
172: client.onreadystatechange = handler;
173: client.open("GET", "test.xml");
1.58 avankest 174: client.send();</code></pre>
1.16 avankest 175:
1.56 avankest 176: <p>If you just want to log a message to the server:</p>
1.16 avankest 177:
1.58 avankest 178: <pre><code>function log(message) {
1.14 avankest 179: var client = new XMLHttpRequest();
1.56 avankest 180: client.open("POST", "/log");
1.57 avankest 181: client.setRequestHeader("Content-Type", "text/plain;charset=UTF-8");
1.14 avankest 182: client.send(message);
1.58 avankest 183: }</code></pre>
1.16 avankest 184:
1.14 avankest 185: <p>Or if you want to check the status of a document on the server:</p>
1.16 avankest 186:
1.58 avankest 187: <pre><code>function fetchStatus(address) {
1.14 avankest 188: var client = new XMLHttpRequest();
189: client.onreadystatechange = function() {
190: // in case of network errors this might not give reliable results
191: if(this.readyState == 4)
192: returnStatus(this.status);
193: }
194: client.open("HEAD", address);
195: client.send();
1.58 avankest 196: }</code></pre>
1.14 avankest 197: </div>
1.12 avankest 198:
1.1 avankest 199: <h3 id="conformance">Conformance</h3>
1.12 avankest 200:
1.27 avankest 201: <p>Everything in this specification is normative except for diagrams,
202: examples, notes and sections marked non-normative.</p>
1.12 avankest 203:
1.1 avankest 204: <p>The key words <em class="ct">must</em>, <em class="ct">must not</em>,
1.74 avankest 205: <em class="ct">should</em> and <em class="ct">may</em> in this document are
206: to be interpreted as described in RFC 2119.
207: [<cite><span>RFC2119</span></cite>]</p>
1.12 avankest 208:
1.1 avankest 209: <p>This specification defines the following classes of products:</p>
1.12 avankest 210:
1.1 avankest 211: <dl>
1.74 avankest 212: <dt><dfn id="conforming-user-agent">Conforming user agent</dfn></dt>
1.24 avankest 213:
1.74 avankest 214: <dd>
215: <p>A user agent <em class="ct">must</em> behave as described in this
216: specification in order to be considered conformant even when faced with
217: non-conforming scripts.</p>
1.95 avankest 218:
1.94 avankest 219: <p>If the user agent does not support XML (including support for
220: namespaces) the <span>XML response entity body</span>
221: <em class="ct">must</em> (always) be <code>null</code>.</p>
1.74 avankest 222:
1.75 avankest 223: <p>User agents <em class="ct">may</em> optimize any algorithm given in
224: this specification, so long as the end result is indistinguishable from
225: the result that would be obtained by the specification's algorithms. (The
226: algorithms in this specification are generally written with more concern
227: for clarity than efficiency.)</p>
1.95 avankest 228:
229: <p class="note">This specification uses both the terms "conforming user
230: agent(s)" and "user agent(s)" to refer to this product class.</p>
1.74 avankest 231: </dd>
1.94 avankest 232:
233: <dt><dfn id="conforming-xml-user-agent">Conforming XML user agent</dfn></dt>
234:
235: <dd><p>A user agent that is a <span>conforming user agent</span> and also
236: supports XML (including support for namespaces).</p></dd>
1.24 avankest 237:
1.74 avankest 238: <dt><dfn id="conforming-script">Conforming script</dfn></dt>
1.24 avankest 239:
1.74 avankest 240: <dd><p>A script <em class="ct">must</em> satisfy the constraints and
241: conditions described by this specification in order to be
242: conformant.</p></dd>
1.1 avankest 243: </dl>
1.32 avankest 244:
1.30 avankest 245: <h4 id="dependencies">Dependencies</h4>
1.33 avankest 246:
1.29 avankest 247: <p>This specification relies on several underlying specifications.</p>
248: <dl>
249: <dt>DOM</dt>
1.33 avankest 250:
1.29 avankest 251: <dd>
1.95 avankest 252: <p><span title="Conforming user agent">Conforming user agents</span>
253: <em class="ct">must</em> support some version of DOM Events and DOM Core,
254: because this specification uses some of the features defined in those
255: specifications. [<cite><span>DOM3Events</span></cite>]
256: [<cite><span>DOM3Core</span></cite>]</p>
257:
258: <p>It <em class="ct">must</em> also support some version of the Window
259: Object because some of the functionality in this specification relies on
260: it. [<cite><span>Window</span></cite>]</p>
1.29 avankest 261: </dd>
262:
263: <dt>HTTP</dt>
1.33 avankest 264:
1.29 avankest 265: <dd>
1.95 avankest 266: <p><span title="Conforming user agent">Conforming user agents</span>
267: <em class="ct">must</em> support some version of the HTTP protocol. The
268: user agent <em class="ct">should</em> support any HTTP method that matches
269: the <span><code>Method</code> production</span> and
270: <em class="ct">must</em> at least support the following methods:</p>
1.58 avankest 271:
272: <ul>
273: <li><code>GET</code></li>
274: <li><code>POST</code></li>
275: <li><code>HEAD</code></li>
276: <li><code>PUT</code></li>
277: <li><code>DELETE</code></li>
278: <li><code>OPTIONS</code></li>
279: </ul>
280:
281: <p>Other requirements regarding HTTP are made throughout the
1.39 avankest 282: specification. [<cite><span>RFC2616</span></cite>]</p>
1.29 avankest 283: </dd>
1.41 avankest 284:
285: <dt>XML</dt>
286:
1.95 avankest 287: <dd><p><span title="Conforming XML user agent">Conforming XML user
288: agents</span> <em class="ct">must</em> support XML (including support for
289: namespaces). [<cite><span>XML</span></cite>]
290: [<cite><span>XMLNS</span></cite>]</p></dd>
1.29 avankest 291: </dl>
1.12 avankest 292:
1.80 avankest 293: <h4 id="terminology">Terminology</h4>
1.12 avankest 294:
1.80 avankest 295: <p>There is a <dfn id="case-insensitive-match">case-insensitive match</dfn>
1.92 avankest 296: of strings <var>s1</var> and <var>s2</var> if after lowercasing both strings
1.93 avankest 297: (by mapping a-Z to A-Z) they are identical.</p>
1.80 avankest 298:
299: <h4 id="extensibility">Extensibility</h4>
1.12 avankest 300:
1.81 avankest 301: <p>Extensions of the API defined by this specification are <em>strongly
1.22 avankest 302: discouraged</em>. User agents, Working Groups and other interested parties
1.33 avankest 303: should discuss extensions on a relevant public forum, preferably
1.22 avankest 304: <a href="mailto:public-webapi@w3.org">public-webapi@w3.org</a>.</p>
1.12 avankest 305:
306: <h2 id="xmlhttprequest">The <code title="">XMLHttpRequest</code> Object</h2>
307:
1.58 avankest 308: <p>The <code>XMLHttpRequest</code> object can be used by scripts to
1.22 avankest 309: programmatically connect to their originating server via HTTP.</p>
1.12 avankest 310:
1.1 avankest 311: <p>Objects implementing the <code>XMLHttpRequest</code> interface
1.22 avankest 312: <em class="ct">must</em> also implement the <code>EventTarget</code>
1.58 avankest 313: interface. [<cite><span>DOM3Events</span></cite>]</p>
1.12 avankest 314:
1.58 avankest 315: <p>Objects implementing the <code title="">Window</code> interface
316: <em class="ct">must</em> provide an <code title="">XMLHttpRequest()</code>
317: constructor. [<cite><span>Window</span></cite>]</p>
1.12 avankest 318:
1.1 avankest 319: <div class="example">
1.58 avankest 320: <p>In ECMAScript this can be used as follows:</p>
321: <!-- [<cite><span>ECMAScript</span></cite>] -->
322:
323: <pre><code>var client = new XMLHttpRequest();</code></pre>
1.1 avankest 324: </div>
1.12 avankest 325:
1.58 avankest 326: <p>When the <code title="">XMLHttpRequest()</code> constructor is invoked a
327: persistent pointer to the associated <code title="">Window</code> object
328: <em class="ct">must</em> be stored on the newly created object. This is the
1.25 avankest 329: <dfn title="Window pointer" id="window-pointer"><code>Window</code>
1.58 avankest 330: pointer</dfn>. The associated <code title="">Window</code> object is the one
331: of which the <code title="">XMLHttpRequest</code> constructor was
332: invoked. This <span title="Window pointer">pointer</span>
1.25 avankest 333: <em class="ct">must</em> persist even if the browsing context in which the
1.37 avankest 334: <code title="">Window</code> is located is destroyed (by removing it from a
335: parent browsing context, for instance).</p>
1.25 avankest 336:
1.37 avankest 337: <p>The term browsing context is defined by the <cite>Window Object
338: 1.0</cite> specification. [<cite><span>Window</span></cite>]</p>
1.27 avankest 339:
340: <!-- XXX if the document object changes in the browsing context you get an
1.33 avankest 341: exception in some implementations. -->
1.27 avankest 342:
1.58 avankest 343: <div class="example">
1.65 avankest 344: <p>If <var><code>win</code></var> is a <code title="">Window</code> object
345: <var><code>client</code></var> will have a pointer to
346: <var><code>win</code></var> in the following example:</p>
1.58 avankest 347:
1.65 avankest 348: <pre><code>var client = new win.XMLHttpRequest()</code></pre>
1.58 avankest 349: </div>
1.12 avankest 350:
1.58 avankest 351: <pre class="idl">interface <dfn id="xmlhttprequest-object">XMLHttpRequest</dfn> {
352: // event handler
1.70 avankest 353: attribute EventListener <span>onreadystatechange</span>;
1.58 avankest 354:
355: // state
1.71 avankest 356: const unsigned short <span title="UNSENT state">UNSENT</span> = 0;
1.58 avankest 357: const unsigned short <span title="OPEN state">OPEN</span> = 1;
358: const unsigned short <span title="SENT state">SENT</span> = 2;
1.86 avankest 359: const unsigned short <span title="LOADING state">LOADING</span> = 3;
1.79 avankest 360: const unsigned short <span title="DONE state">DONE</span> = 4;
1.70 avankest 361: readonly attribute unsigned short <span>readyState</span>;
1.58 avankest 362:
363: // request
1.70 avankest 364: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>);
365: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>);
366: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>, in DOMString <var>user</var>);
367: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>, in DOMString <var>user</var>, in DOMString <var>password</var>);
368: void <span>setRequestHeader</span>(in DOMString <var>header</var>, in DOMString <var>value</var>);
369: void <span>send</span>();
370: void <span>send</span>(in DOMString <var>data</var>);
371: void <span>send</span>(in Document <var>data</var>);
372: void <span>abort</span>();
1.58 avankest 373:
374: // response
1.70 avankest 375: DOMString <span>getAllResponseHeaders</span>();
376: DOMString <span>getResponseHeader</span>(in DOMString <var>header</var>);
377: readonly attribute DOMString <span>responseText</span>;
378: readonly attribute Document <span>responseXML</span>;
379: readonly attribute unsigned short <span>status</span>;
380: readonly attribute DOMString <span>statusText</span>;
1.1 avankest 381: };</pre>
1.8 avankest 382:
1.58 avankest 383: <p>The <code>XMLHttpRequest</code> object can be in five states:
1.71 avankest 384: <span title="UNSENT state">UNSENT</span>,
1.58 avankest 385: <span title="OPEN state">OPEN</span>, <span title="SENT state">SENT</span>,
1.86 avankest 386: <span title="LOADING state">LOADING</span> and
1.79 avankest 387: <span title="DONE state">DONE</span>. The current state is exposed through
388: the <code>readyState</code> attribute. The method definitions below define
389: when a state transition takes place.</p>
1.58 avankest 390:
391: <p>When constructed, the <code>XMLHttpRequest</code> object
1.71 avankest 392: <em class="ct">must</em> be in the UNSENT state. This state is represented
393: by the <dfn id="unsent" title="UNSENT state"><code>UNSENT</code></dfn>
1.58 avankest 394: constant, whose value is <code>0</code>.</p>
395:
396: <p>The OPEN state is the state of the object when the <code>open()</code>
1.92 avankest 397: method has been successfully invoked. During this state request headers can
1.58 avankest 398: be set using <code>setRequestHeader()</code> and the request can be made
399: using <code>send()</code>. This state is represented by the
400: <dfn id="open" title="OPEN state"><code>OPEN</code></dfn> constant, whose
401: value is <code>1</code>.</p>
402:
1.87 avankest 403: <p>During the OPEN state there is a <dfn id="send-flag"><code>send()</code>
404: flag</dfn> which influences several algorithms described below. Outside the
405: OPEN state its value <em class="ct">must</em> (always) be "false". During
406: the OPEN state it can be set to "true" as described in the
407: <code>send()</code> method algorithm.</p>
408:
1.58 avankest 409: <p>The SENT state is the state of the object when the user agent
410: successfully acknowledged the request. This state is represented by the
411: <dfn id="sent" title="SENT state"><code>SENT</code></dfn> constant, whose
412: value is <code>2</code>.</p>
413:
1.86 avankest 414: <p>The LOADING state is the state of the object when all HTTP headers have
1.58 avankest 415: been received. The object typically remains in this state until the complete
416: message body (if any) has been received. This state is represented by the
1.86 avankest 417: <dfn id="loading" title="LOADING state"><code>LOADING</code></dfn> constant,
418: whose value is <code>3</code>.</p>
1.58 avankest 419:
1.79 avankest 420: <p>The DONE state is the state of the object when either the data transfer
1.58 avankest 421: has been completed or something went wrong during the transfer (infinite
422: redirects for instance). This state is represented by the
1.79 avankest 423: <dfn id="done" title="DONE state"><code>DONE</code></dfn> constant, whose
424: value is <code>4</code>.</p>
1.90 avankest 425:
1.88 avankest 426: <p>The <dfn id="response-entity-body">response entity body</dfn> is the
427: fragment of the <span>entity body</span> received so far (LOADING state) or
428: the complete entity body (DONE state). If there is no entity body the
429: response entity body is "null".</p>
430:
431: <p>The <dfn id="text-response-entity-body">text response entity body</dfn>
1.90 avankest 432: is either a <code>DOMString</code> or <code>null</code>. The value of the
1.96 ! avankest 433: text response entity body <em class="ct">must</em> be determined by running
! 434: the following algorithm:</p>
1.90 avankest 435:
1.88 avankest 436: <ol>
1.96 ! avankest 437: <li><p>If the <span>response entity body</span> is "null" return
! 438: <code>null</code> and terminate these steps.</p>
1.90 avankest 439:
440: <li><p>Let <var>charset</var> be UTF-8.</p></li>
441:
442: <li><p>If there is no <code>Content-Type</code> header or there is a
443: <code>Content-Type</code> header which contains a MIME type that is
1.91 avankest 444: <code>text/xml</code>, <code>application/xml</code>, <code>text/xsl</code>
445: or ends in <code title="">+xml</code> (ignoring any parameters) use the
446: rules set forth in the XML specification to determine the character
447: encoding. Let <var>charset</var> be the determined character
448: encoding.</p></li>
1.90 avankest 449:
450: <li><p>If the <code>Content-Type</code> MIME type contains a
451: <code>charset</code> parameter let <var>charset</var> be the value of that
452: parameter.</p></li>
453:
1.96 ! avankest 454: <li><p>Return the result of decoding the <span>response entity body</span>
! 455: using <var>charset</var>. Or, if that fails, return
1.90 avankest 456: <code>null</code>.</p></li>
1.88 avankest 457: </ol>
1.90 avankest 458:
1.88 avankest 459: <p>If the <span>response entity body</span> is "null" the text response
460: entity body is <code>null</code>. If the user agent fails to decode the
461: response entity body the text response entity body is also
462: <code>null</code>.</p>
1.90 avankest 463:
1.88 avankest 464: <p>The <dfn id="xml-response-entity-body">XML response entity body</dfn> is
465: a <code>Document</code> representing the response entity body or
1.96 ! avankest 466: <code>null</code> and is determined by running the following algorithm
! 467: (the return value is its value):</p>
1.90 avankest 468:
1.88 avankest 469: <ol>
1.96 ! avankest 470: <li><p>If the <span>response entity body</span> is "null" terminate these
! 471: steps and return <code>null</code>.</p></li>
1.88 avankest 472:
1.96 ! avankest 473: <li><p>If there is no <code>Content-Type</code> header terminate these
! 474: steps and return <code>null</code>.</p></li>
1.90 avankest 475: <!-- can it have no value? -->
1.88 avankest 476:
1.90 avankest 477: <li><p>If the <code>Content-Type</code> header does not contain a MIME type
478: (ignoring any parameters) that is <code>text/xml</code>,
1.91 avankest 479: <code>application/xml</code>, <code>text/xsl</code> or ends in
1.96 ! avankest 480: <code title="">+xml</code> terminate these steps and return
! 481: <code>null</code>.</p></li>
1.88 avankest 482:
483: <li><p>Parse the <span>response entity body</span> following the rules from
484: the XML specifications. Let the result be <var>parsed document</var>. If
485: this fails (unsupported character encoding, namespace well-formedness error
1.96 ! avankest 486: et cetera) terminate these steps return <code>null</code>.
! 487: [<cite><span>XML</span></cite>] [<cite><span>XMLNS</span></cite>]</p></li>
1.88 avankest 488:
1.96 ! avankest 489: <li><p>Return an object implementing the <code>Document</code>
1.88 avankest 490: interface representing the <var>parsed document</var>.</p></li>
491: </ol>
1.58 avankest 492:
1.5 avankest 493: <dl>
1.12 avankest 494:
1.39 avankest 495: <dt><dfn id="dfn-onreadystatechange"><code>onreadystatechange</code></dfn>
496: of type <code>EventListener</code></dt>
1.12 avankest 497:
1.1 avankest 498: <dd>
499: <p>An attribute that takes an <code>EventListener</code> as value that
1.58 avankest 500: <em class="ct">must</em> be invoked along with any other appropriate event
501: listeners that are registered on this object when a
1.87 avankest 502: <code>readystatechange</code> event is dispatched on it during the
503: bubbling phase. Its initial value <em class="ct">must</em> be
504: <code>null</code>.</p>
1.1 avankest 505: </dd>
1.12 avankest 506:
1.1 avankest 507: <dt><dfn id="dfn-readystate"><code>readyState</code></dfn> of type
1.22 avankest 508: <code>unsigned short</code>, readonly</dt>
1.12 avankest 509:
1.1 avankest 510: <dd>
1.58 avankest 511: <p>The attribute <em class="ct">must</em> be the value of the constant
512: corresponding to the object's current state.</p>
1.1 avankest 513: </dd>
1.12 avankest 514:
1.14 avankest 515: <dt><dfn id="dfn-open" title="open"><code>open(<var>method</var>,
1.22 avankest 516: <var>url</var>, <var>async</var>, <var>user</var>,
517: <var>password</var>)</code></dfn>, method</dt>
1.12 avankest 518:
1.1 avankest 519: <dd>
1.58 avankest 520: <p>When invoked, the user agent <em class="ct">must</em> follow the
1.96 ! avankest 521: following steps (unless otherwise indicated):</p>
1.58 avankest 522:
523: <ol>
524: <li><p>If the <var>method</var> argument doesn't match the
525: <dfn><code>Method</code> production</dfn> defined in section 5.1.1 of RFC
1.96 ! avankest 526: 2616 raise a <code>SYNTAX_ERR</code> exception and abort these steps.
1.58 avankest 527: [<cite><span>RFC2616</span></cite>]</p></li>
528:
529: <li><p>If the given <var>method</var> is not supported for security
530: reasons the user agent <em class="ct">should</em> raise a
531: <code>SECURITY_ERR</code> exception and abort these steps.</p></li>
532:
533: <li><p>Let <var>stored method</var> be <var>method</var>.</p></li>
534:
1.80 avankest 535: <li><p>If <var>method</var>
536: <span title="case-insensitive match">case-insensitively matches</span>
537: <code>GET</code>, <code>POST</code>, <code>HEAD</code>, <code>PUT</code>,
1.96 ! avankest 538: <code>DELETE</code> or <code>OPTIONS</code> convert it to its uppercase
! 539: equivalent (by mapping a-z to A-Z) and let <var>stored method</var> be
! 540: the result.</p></li>
1.68 avankest 541: <!-- WebKit (and supposedly Firefox) also uppercase: CONNECT, COPY,
542: INDEX, LOCK, M-POST, MKCOL, MOVE, PROPFIND, PROPPATCH, TRACE and UNLOCK.
543: Not sure if TRACE and CONNECT are worth it though. They raise a
544: SECURITY_ERR exception anyway... -->
1.58 avankest 545:
546: <li><p>Drop the fragment identifier (if any) from <var>url</var> and let
547: <var>stored url</var> be the result of that operation.</p></li>
548:
1.96 ! avankest 549: <li><p>If <var>stored url</var> is a relative reference resolve it using
! 550: the current value of the <code>baseURI</code> attribute of the
! 551: <code>Document</code> object currently associated with the
! 552: <span><code>Window</code> pointer</span>. If this fails raise a
1.58 avankest 553: <code>SYNTAX_ERR</code> exception and abort these steps.</p></li>
554:
555: <li><p>If the <code>"user:password"</code> format in the
556: <code>userinfo</code> production defined in section 3.2.1 of RFC 3986 is
557: not supported for the relevant scheme and <var>stored url</var> contains
1.96 ! avankest 558: this format raise a <code>SYNTAX_ERR</code> and abort these steps.
1.69 avankest 559: [<cite><span>RFC3986</span></cite>]</p></li>
1.58 avankest 560:
561: <li><p>If <var>stored url</var> contains the <code>"user:password"</code>
562: format let <var>stored user</var> be the user part and <var>stored
563: password</var> be the password part.</p></li>
564:
565: <li><p>If <var>stored url</var> just contains the <code>"user"</code>
566: format let <var>stored user</var> be the user part.</p></li>
567:
1.69 avankest 568: <li>
569: <p>If <var>stored url</var> is non same-origin the user agent
570: <em class="ct">should</em> raise a <code>SECURITY_ERR</code> exception
571: and abort these steps.</p>
572: <p class="note">This specification does not define what constitutes as
1.71 avankest 573: non same-origin.<!-- XXX reference HTML5? --></p>
1.69 avankest 574: </li>
1.58 avankest 575:
576: <li><p>Let <var>async</var> be the value of the <var>async</var> argument
577: or <code>false</code> if it was omitted.</p></li>
578:
579: <li><p>If the <var>user</var> argument was not omitted and its syntax
1.96 ! avankest 580: does not match that specified by the relevant authentication scheme raise
! 581: a <code>SYNTAX_ERR</code> exception and abort these steps.</p></li>
1.14 avankest 582:
1.58 avankest 583: <li>
584: <p>If the <var>user</var> argument was not omitted and is not
585: <code>null</code> let <var>stored user</var> be <var>user</var> encoded
586: using the encoding specified in the relevant authentication scheme or
587: UTF-8 if the scheme fails to specify an encoding.</p>
1.14 avankest 588:
1.58 avankest 589: <p class="note">This step overrides any user that may have been set by
590: the <var>url</var> argument.</p>
591: </li>
1.16 avankest 592:
1.58 avankest 593: <li><p>If the <var>user</var> argument was not omitted and is
594: <code>null</code> remove <var>stored user</var>.</p></li>
1.14 avankest 595:
1.58 avankest 596: <li><p>If the <var>password</var> argument was not omitted and its syntax
1.96 ! avankest 597: does not match that specified by the relevant authentication scheme raise
! 598: a <code>SYNTAX_ERR</code> exception and abort these steps.</p></li>
1.58 avankest 599:
600: <li><p>If the <var>password</var> argument was not omitted and is not
601: <code>null</code> let <var>stored password</var> be <var>password</var>
602: encoded using the encoding specified in the relevant authentication
603: scheme or UTF-8 if the scheme fails to specify an encoding.</p></li>
604:
605: <li><p>If the <var>password</var> argument was not omitted and is
606: <code>null</code> remove <var>stored password</var>.</p></li>
607:
1.89 avankest 608: <li><p>Set <span>response entity body</span> to "null" and reset the list
609: of request headers.<p></li>
1.58 avankest 610:
1.60 avankest 611: <li><p>Any network activity for which the object responsible
612: <em class="ct">should</em> be cancelled.</p></li>
1.58 avankest 613: <!-- we can hardly require it... -->
614:
615: <li><p>Switch the object to the <span title="OPEN state">OPEN</span>
1.96 ! avankest 616: state and then synchronously dispatch a <code>readystatechange</code>
! 617: event on the object and return the method call.</p></li>
1.58 avankest 618: </ol>
1.14 avankest 619:
1.19 avankest 620: <p class="note">A future version or extension of this specification will
1.33 avankest 621: most likely define a way of doing cross-site requests.</p>
1.1 avankest 622: </dd>
1.12 avankest 623:
1.14 avankest 624: <dt><dfn id="dfn-setrequestheader" title="setrequestheader"><code>setRequestHeader(<var>header</var>,
1.22 avankest 625: <var>value</var>)</code></dfn>, method</dt>
1.12 avankest 626:
1.5 avankest 627: <dd>
1.45 avankest 628: <p>Each request has a list of request headers with associated values. This
629: method can be used to manipulate those values and set new request
630: headers.</p>
631:
1.58 avankest 632: <p>When invoked, the user agent <em class="ct">must</em> follow the
1.96 ! avankest 633: following steps (unless otherwise indicated):</p>
1.14 avankest 634:
1.58 avankest 635: <ol>
636: <li><p>If the state of the object is not
1.96 ! avankest 637: <span title="OPEN state">OPEN</span> raise an
! 638: <code>INVALID_STATE_ERR</code> exception and abort these steps.</p></li>
! 639:
! 640: <li><p>If the <span><code>send()</code> flag</span> is "true" raise an
! 641: <code>INVALID_STATE_ERR</code> exception and abort these steps.</p></li>
1.14 avankest 642:
1.58 avankest 643: <li><p>If the <var>header</var> argument doesn't match the
1.22 avankest 644: <dfn><code>field-name</code> production</dfn> as defined by section 4.2
1.96 ! avankest 645: of RFC 2616 or is <code>null</code> raise a <code>SYNTAX_ERR</code>
! 646: exception and abort these steps.
! 647: [<cite><span>RFC2616</span></cite>]</p></li>
! 648:
! 649: <li><p>If the <var>value</var> argument is <code>null</code> abort these
! 650: steps. (Don't raise an exception.)</li>
1.70 avankest 651: <!-- undefined is to be treated as null here... -->
1.79 avankest 652:
1.58 avankest 653: <li><p>If the <var>value</var> argument doesn't match the
1.22 avankest 654: <dfn><code>field-value</code> production</dfn> as defined by section 4.2
1.96 ! avankest 655: of RFC 2616 raise a <code>SYNTAX_ERR</code> and abort these steps.
1.58 avankest 656: [<cite><span>RFC2616</span></cite>]</p></li>
1.14 avankest 657:
1.32 avankest 658: <li>
1.58 avankest 659: <p>For security reasons these steps <em class="ct">should</em> be
1.80 avankest 660: aborted if the <var>header</var> argument
661: <span title="case-insensitive match">case-insensitively matches</span>
662: one of the following headers:</p>
1.58 avankest 663:
1.32 avankest 664: <ul>
665: <li><code>Accept-Charset</code></li>
666: <li><code>Accept-Encoding</code></li>
1.68 avankest 667: <li><code>Connection</code></li>
1.32 avankest 668: <li><code>Content-Length</code></li>
1.68 avankest 669: <li><code>Content-Transfer-Encoding</code></li>
670: <li><code>Date</code></li>
1.32 avankest 671: <li><code>Expect</code></li>
672: <li><code>Host</code></li>
673: <li><code>Keep-Alive</code></li>
674: <li><code>Referer</code></li>
675: <li><code>TE</code></li>
676: <li><code>Trailer</code></li>
677: <li><code>Transfer-Encoding</code></li>
678: <li><code>Upgrade</code></li>
1.68 avankest 679: <li><code>Via</code></li>
1.32 avankest 680: </ul>
681: </li>
1.5 avankest 682:
1.58 avankest 683: <li><p>If the <var>header</var> argument is not in the list of request
1.96 ! avankest 684: headers append the <var>header</var> with its associated <var>value</var>
! 685: to the list and abort these steps.</p></li>
1.58 avankest 686:
687: <li><p>If the <var>header</var> argument is in the list of request
1.96 ! avankest 688: headers either use multiple headers, combine the values or use a
! 689: combination of those (section 4.2, RFC 2616).
! 690: [<cite><span>RFC2616</span></cite>]</p></li>
! 691: <!-- XXX it seems UAs always combine the values -->
1.58 avankest 692: </ol>
1.45 avankest 693:
694: <p class="note">See also the <code>send()</code> method regarding user
1.71 avankest 695: agent header handling for caching, authentication, proxies, and
696: cookies.</p>
1.14 avankest 697:
698: <div class="example">
1.58 avankest 699: <pre><code>// The following script:
1.14 avankest 700: var client = new XMLHttpRequest();
701: client.open('GET', 'demo.cgi');
702: client.setRequestHeader('X-Test', 'one');
703: client.setRequestHeader('X-Test', 'two');
704: client.send();
705:
706: // ...would result in the following header being sent:
707: ...
708: X-Test: one, two
1.58 avankest 709: ...</code></pre>
1.14 avankest 710: </div>
1.5 avankest 711: </dd>
1.12 avankest 712:
1.14 avankest 713: <dt><dfn id="dfn-send" title="send"><code>send(<var>data</var>)</code></dfn>,
1.22 avankest 714: method</dt>
1.12 avankest 715:
1.17 avankest 716: <dd>
1.58 avankest 717: <p>The <code>send()</code> method initiates the request and its optional
718: argument <em class="ct">may</em> be used by scripts to provide the entity
719: body. When the argument is provided scripts <em class="ct">should</em>
720: ensure that they have specified (before invoking <code>send()</code>) the
1.60 avankest 721: <code>Content-Type</code> header via <code>setRequestHeader()</code>.</p>
1.58 avankest 722:
723: <p>When invoked, the user agent <em class="ct">must</em> follow the
1.96 ! avankest 724: following steps (unless otherwise noted):</p>
1.58 avankest 725:
726: <ol>
727: <li><p>If the state of the object is not
1.96 ! avankest 728: <span title="OPEN state">OPEN</span> raise an
! 729: <code>INVALID_STATE_ERR</code> exception and abort these steps.</p></li>
! 730:
! 731: <li><p>If the <span><code>send()</code> flag</span> is "true" raise an
! 732: <code>INVALID_STATE_ERR</code> exception and abort these steps.</p></li>
1.58 avankest 733:
734: <li>
735: <p>If the <var>data</var> argument has not been omitted and is not
1.96 ! avankest 736: <code>null</code> use it for the <dfn id="dfn-entity-body">entity
! 737: body</dfn> as defined by section 7.2 of RFC 2616 observing the following
! 738: rules: [<cite><span>RFC2616</span></cite>]</p>
1.58 avankest 739:
740: <dl>
741: <dt><var>data</var> is a <code>DOMString</code></dt>
742:
1.96 ! avankest 743: <dd><p>Encode <var>data</var> using UTF-8 for transmission.</p></dd>
1.58 avankest 744:
745: <dt><var>data</var> is a <code>Document</code>
746:
747: <dd>
1.96 ! avankest 748: <p>Serialize <var>data</var> into a namespace well-formed XML document
! 749: and encoded using the encoding given by
! 750: <code><var>data</var>.xmlEncoding</code>, if specified, or UTF-8
! 751: otherwise. Or, if this fails because the <code>Document</code>
! 752: cannot be serialized act as if <var>data</var> is
! 753: <code>null</code>.</p>
! 754:
! 755: <p>If no <code>Content-Type</code> header is in the list of request
! 756: headers append it to the list of request headers with a value of
! 757: <code>application/xml</code>.</p>
1.58 avankest 758:
759: <p class="note">Subsequent changes to the <code>Document</code> have
760: no effect on what is submitted.</p>
761: </dd>
762:
763: <dt><var>data</var> is not a <code>DOMString</code> or
764: <code>Document</code></dt>
765:
1.96 ! avankest 766: <dd><p>Use the stringification mechanisms of the host language on
! 767: <var>data</var> and treat the result as if <var>data</var> is a
! 768: <code>DOMString</code>. Or, if this fails, act as if <var>data</var> is
! 769: <code>null</code>.</p></dd>
1.58 avankest 770: </dl>
771:
772: <p>If the data argument has been omitted or is <code>null</code> no
1.96 ! avankest 773: entity body is used in the request.</p>
1.58 avankest 774: </li>
775:
1.71 avankest 776: <li><p>Make a request to <var>stored url</var>, using HTTP method
777: <var>stored method</var>, user <var>stored user</var> (if provided) and
778: password <var>stored password</var> (if provided), taking into account
779: the entity body, list of request headers and the rules listed directly
780: after this set of steps.</p></li>
1.60 avankest 781:
1.67 avankest 782: <li>
1.96 ! avankest 783: <p>Synchronously dispatch a <code>readystatechange</code> event on the
! 784: object.</p>
1.67 avankest 785:
1.96 ! avankest 786: <p class="note">The state of the object does not change. The event is
! 787: dispatched for historical reasons.</p>
1.67 avankest 788: </li>
789:
1.96 ! avankest 790: <li><p>If <var>async</var> is <code>true</code> set the
! 791: <dfn><code>send()</code> flag</dfn> to "true" and return the
! 792: <code>send()</code> method call. (Don't abort the steps in the algorithm
! 793: though.)</p></li>
1.58 avankest 794:
1.82 avankest 795: <li><p>If the request has been successfully acknowledged synchronously
1.96 ! avankest 796: switch the state to <span title="SENT state">SENT</span> and then
! 797: synchronously dispatch a <code>readystatechange</code> event on the
! 798: object.</p></li>
1.58 avankest 799:
800: <li><p>If all HTTP headers have been receieved, immediately before
1.82 avankest 801: receiving the message body (if any), synchronously switch the state to
1.96 ! avankest 802: <span title="LOADING state">LOADING</span> and then synchronously
! 803: dispatch a <code>readystatechange</code> event on the object.</p></li>
1.58 avankest 804:
805: <li>
806: <p>If the response is an HTTP redirect (status code <code>301</code>,
1.96 ! avankest 807: <code>302</code>, <code>303</code> or <code>307</code>), transparently
! 808: follow it (unless it violates security, infinite loop precautions or the
! 809: scheme is not supported).</p>
1.60 avankest 810:
1.58 avankest 811: <p class="note">HTTP places requirements on the user agent regarding the
812: preservation of the request method and entity body during redirects, and
813: also requires users to be notified of certain kinds of automatic
814: redirections.</p>
815: <!-- Arguably HTTP should be fixed for the latter case. No browser
816: follows that as far as I know. -->
817: </li>
1.60 avankest 818:
1.58 avankest 819: <li>
1.96 ! avankest 820: <p>If something goes wrong (infinite loop, network errors) run the
! 821: following set of steps:</p>
1.60 avankest 822:
1.58 avankest 823: <ol>
1.96 ! avankest 824: <li><p>Set <span>response entity body</span> to "null" and reset the
1.89 avankest 825: list of request headers.</p></li>
1.60 avankest 826:
1.82 avankest 827: <li><p>Synchronously switch the state to
1.79 avankest 828: <span title="DONE state">DONE</span>.</p></li>
1.60 avankest 829:
1.96 ! avankest 830: <li><p>If <var>async</var> is set to <code>false</code> raise a
! 831: <code>NETWORK_ERR</code> exception. (Don't abort these steps.)</p></li>
1.60 avankest 832:
1.58 avankest 833: <li><p>Synchronously dispatch a <code>readystatechange</code> event on
834: the object.</p></li>
1.60 avankest 835:
1.58 avankest 836: <li><p>Abort the overall algorithm.</p></li>
837: </ol>
1.60 avankest 838:
1.82 avankest 839: <p class="note">It is likely that a future version of the
840: <code>XMLHttpRequest</code> object will dispatch an <code>error</code>
841: event here as well.</p>
1.58 avankest 842: </li>
843:
1.82 avankest 844: <li><p>When the request has successfully completed loading, synchronously
1.96 ! avankest 845: switch the state to <span title="DONE state">DONE</span> and then
! 846: synchronously dispatch a <code>readystatechange</code> event on the
! 847: object and return the method call in case of <var>async</var> being
! 848: <code>false</code>.</p></li>
1.58 avankest 849: </ol>
1.14 avankest 850:
1.91 avankest 851: <p>If the user agent allows the user to configure a proxy it
1.22 avankest 852: <em class="ct">should</em> modify the request appropriately;
1.42 avankest 853: <abbr title="in other words">i.e.</abbr>, connect to the proxy host
854: instead of the origin server, modify the <code>Request-Line</code> and
855: send <code>Proxy-Authorization</code> headers as specified.</p>
1.12 avankest 856:
1.42 avankest 857: <p>If the user agent supports HTTP Authentication it
1.22 avankest 858: <em class="ct">should</em> consider requests originating from this object
1.42 avankest 859: to be part of the protection space that includes the accessed URIs and
860: send <code>Authorization</code> headers and handle <code>401
1.72 avankest 861: Unauthorised</code> requests appropriately. If authentication fails, user
1.42 avankest 862: agents <em class="ct">should</em> prompt the users for credentials.
863: [<cite><span>RFC2617</span></cite>]</p>
864:
1.57 avankest 865: <p>If the user agent supports HTTP State Management it
1.42 avankest 866: <em class="ct">should</em> persist, discard and send cookies (as received
867: in the <code>Set-Cookie</code> and <code>Set-Cookie2</code> response
868: headers, and sent in the <code>Cookie</code> header) as applicable.
869: [<cite><span>RFC2965</span></cite>]</p>
870:
871: <p>If the user agent implements a HTTP cache it <em class="ct">should</em>
872: respect <code>Cache-Control</code> request headers set by the script
873: (<abbr title="for example">e.g.</abbr>, <code>Cache-Control:
874: no-cache</code> bypasses the cache). It <em class="ct">must not</em> send
875: <code>Cache-Control</code> or <code>Pragma</code> request headers
876: automatically unless the user explicitly requests such behaviour
877: (<abbr>e.g.</abbr>, by (force-)reloading the page). <code>304 Not
1.22 avankest 878: Modified</code> responses that are a result of a user agent generated
879: conditional request <em class="ct">must</em> be presented as <code>200
1.57 avankest 880: OK</code> responses with the appropriate content. The user agent
1.39 avankest 881: <em class="ct">must</em> allow scripts to override automatic cache
1.22 avankest 882: validation by setting request headers (e.g., <code>If-None-Match</code>,
1.42 avankest 883: <code>If-Modified-Since</code>), in which case <code>304 Not
884: Modified</code> responses <em class="ct">must</em> be passed through.
885: [<cite><span>RFC2616</span></cite>]</p>
1.12 avankest 886:
1.8 avankest 887: <p>If the user agent implements server-driven content-negotiation
1.42 avankest 888: it <em class="ct">should</em> set <code>Accept-Language</code>,
1.22 avankest 889: <code>Accept-Encoding</code> and <code>Accept-Charset</code> headers as
890: appropriate; it <em class="ct">must not</em> automatically set the
891: <code>Accept</code> header. Responses to such requests
1.40 avankest 892: <em class="ct">must</em> have the content-codings automatically
1.42 avankest 893: decoded. [<cite><span>RFC2616</span></cite>]</p>
1.8 avankest 894: </dd>
1.12 avankest 895:
1.14 avankest 896: <dt><dfn id="dfn-abort"><code>abort()</code></dfn>, method</dt>
1.12 avankest 897:
1.5 avankest 898: <dd>
1.60 avankest 899: <p>When invoked, the user agent <em class="ct">must</em> run the following
1.96 ! avankest 900: steps (unless otherwise noted):</p>
1.60 avankest 901:
902: <ol>
1.96 ! avankest 903: <li><p>Set the <span>response entity body</span> to "null" well as
! 904: removing any registered request headers.</p></li>
1.60 avankest 905:
906: <li><p>Any network activity for which the object responsible
907: <em class="ct">should</em> be cancelled.</p></li>
908:
1.83 avankest 909: <li>
1.85 avankest 910: <p>If the state is <span title="UNSENT state">UNSENT</span>,
1.83 avankest 911: <span title="OPEN state">OPEN</span> and the <span><code>send()</code>
1.87 avankest 912: flag</span> is "false", or <span title="DONE state">DONE</span> go to
913: the next step.</p>
1.85 avankest 914:
1.96 ! avankest 915: <p>Otherwise, switch the state to <span title="DONE state">DONE</span>
! 916: and synchronously dispatch a <code>readystatechange</code> event on the
! 917: object.</p>
1.83 avankest 918: </li>
1.67 avankest 919:
1.60 avankest 920: <li>
1.71 avankest 921: <p>Switch the state to <span title="UNSENT state">UNSENT</span>. (Don't
922: dispatch the <code>readystatechange</code> event.)</p>
1.60 avankest 923:
1.82 avankest 924: <p class="note">It is likely that a future version of the
925: <code>XMLHttpRequest</code> object will dispatch an
926: <code title="">abort</code> event here as well.</p>
1.60 avankest 927: </li>
928: </ol>
1.5 avankest 929: </dd>
1.12 avankest 930:
1.14 avankest 931: <dt><dfn id="dfn-getallresponseheaders"><code>getAllResponseHeaders()</code></dfn>,
1.22 avankest 932: method</dt>
1.12 avankest 933:
1.5 avankest 934: <dd>
1.60 avankest 935: <p>When invoked, the user agent <em class="ct">must</em> run
1.58 avankest 936: the following steps:</p>
937:
938: <ol>
1.86 avankest 939: <li><p>If the state is not <span title="LOADING state">LOADING</span> or
1.96 ! avankest 940: <span title="DONE state">DONE</span> raise an
! 941: <code>INVALID_STATE_ERR</code> exception and abort these steps.</p></li>
! 942:
! 943: <li><p>Return all the HTTP headers, as a single string, with each header
! 944: line separated by a U+000D CR U+000A LF pair excluding the status
! 945: line.</p></li>
1.58 avankest 946: </ol>
1.24 avankest 947:
1.5 avankest 948: <div class="example">
1.58 avankest 949: <pre><code>// The following script:
1.5 avankest 950: var client = new XMLHttpRequest();
1.14 avankest 951: client.open("GET", "test.txt", true);
1.5 avankest 952: client.send();
1.12 avankest 953: client.onreadystatechange = function() {
1.13 avankest 954: if(this.readyState == 3) {
1.12 avankest 955: print(this.getAllResponseHeaders());
956: }
957: }
1.5 avankest 958:
959: // ...should output something similar to the following text:
960: Date: 2004年10月24日 04:58:38 GMT
961: Server: Apache/1.3.31 (Unix)
962: Keep-Alive: timeout=15, max=99
963: Connection: Keep-Alive
964: Transfer-Encoding: chunked
1.58 avankest 965: Content-Type: text/plain; charset=utf-8</code></pre>
1.5 avankest 966: </div>
967: </dd>
1.12 avankest 968:
1.18 avankest 969: <dt><dfn id="dfn-getresponseheader" title="getresponseheader"><code>getResponseHeader(<var>header</var>)</code></dfn>,
1.22 avankest 970: method</dt>
1.12 avankest 971:
1.1 avankest 972: <dd>
1.58 avankest 973: <p>When the method is invoked, the user agent <em class="ct">must</em> run
974: the following steps:</p>
1.14 avankest 975:
1.58 avankest 976: <ol>
1.86 avankest 977: <li><p>If the state is not <span title="LOADING state">LOADING</span> or
1.96 ! avankest 978: <span title="DONE state">DONE</span> raise an
! 979: <code>INVALID_STATE_ERR</code> exception and abort these steps.</p></li>
1.58 avankest 980:
1.76 avankest 981: <li><p>If the <var>header</var> argument doesn't match the
1.96 ! avankest 982: <span><code>field-name</code> production</span> raise a
! 983: <code>SYNTAX_ERR</code> exception and abort these steps.</p></li>
1.58 avankest 984:
1.80 avankest 985: <li><p>If the <var>header</var> argument
986: <span title="case-insensitive match">case-insensitively matches</span>
1.96 ! avankest 987: multiple HTTP headers for the last request sent return the values of
! 988: these headers as a single concatenated string separated from each other
! 989: by an U+002C COMMA followed by an U+0020 SPACE and abort these
! 990: steps.</p></li>
1.58 avankest 991:
1.80 avankest 992: <li><p>If the <var>header</var> argument
993: <span title="case-insensitive match">case-insensitively matches</span> a
1.96 ! avankest 994: single HTTP header for the last request sent return the value of that
! 995: header and abort these steps.</p></li>
1.58 avankest 996:
1.96 ! avankest 997: <li><p>Return <code>null</code>.</p></li>
1.58 avankest 998: </ol>
1.12 avankest 999:
1.1 avankest 1000: <div class="example">
1.58 avankest 1001: <pre><code>// The following script:
1.1 avankest 1002: var client = new XMLHttpRequest();
1.14 avankest 1003: client.open("GET", "test.txt", true);
1.5 avankest 1004: client.send();
1.12 avankest 1005: client.onreadystatechange = function() {
1.13 avankest 1006: if(this.readyState == 3) {
1.14 avankest 1007: print(client.getResponseHeader("Content-Type"));
1.12 avankest 1008: }
1009: }
1.1 avankest 1010:
1.5 avankest 1011: // ...should output something similar to the following text:
1.58 avankest 1012: Content-Type: text/plain; charset=utf-8</code></pre>
1.1 avankest 1013: </div>
1.5 avankest 1014: </dd>
1.12 avankest 1015:
1.5 avankest 1016: <dt><dfn id="dfn-responsetext"><code>responseText</code></dfn> of type
1.22 avankest 1017: <code>DOMString</code>, readonly</dt>
1.12 avankest 1018:
1.5 avankest 1019: <dd>
1.88 avankest 1020: <p>On getting, the user agent <em class="ct">must</em> run the following
1021: steps:</p>
1022:
1023: <ol>
1024: <li><p>If the state is not <span title="LOADING state">LOADING</span> or
1.96 ! avankest 1025: <span title="DONE state">DONE</span> raise an
! 1026: <code>INVALID_STATE_ERR</code> exception and abort these steps.</p></li>
1.12 avankest 1027:
1.88 avankest 1028: <li><p>Return the <span>text response entity body</span>.</p></li>
1029: </ol>
1.5 avankest 1030: </dd>
1.12 avankest 1031:
1.5 avankest 1032: <dt><dfn id="dfn-responsexml"><code>responseXML</code></dfn> of type
1.22 avankest 1033: <code>Document</code>, readonly</dt>
1.12 avankest 1034:
1.8 avankest 1035: <dd>
1.75 avankest 1036: <p>On getting, the user agent <em class="ct">must</em> run the following
1037: steps:</p>
1.79 avankest 1038:
1.75 avankest 1039: <ol>
1.96 ! avankest 1040: <li><p>If the state is not <span title="DONE state">DONE</span> raise an
! 1041: <code>INVALID_STATE_ERR</code> exception and abort these steps.</p></li>
1.75 avankest 1042:
1.88 avankest 1043: <li><p>Return the <span>XML response entity body</span>.</p></li>
1.75 avankest 1044: </ol>
1.5 avankest 1045: </dd>
1.12 avankest 1046:
1.22 avankest 1047: <dt><dfn id="dfn-status"><code>status</code></dfn> of type <code>unsigned
1048: short</code>, readonly</dt>
1.12 avankest 1049:
1.5 avankest 1050: <dd>
1.72 avankest 1051: <p>On getting, if available, it <em class="ct">must</em> return the HTTP
1052: status code sent by the server (typically <code>200</code> for a
1053: successful request). Otherwise, if not available, the user agent
1054: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1055: exception.</p>
1.12 avankest 1056: </dd>
1057:
1.5 avankest 1058: <dt><dfn id="dfn-statustext"><code>statusText</code></dfn> of type
1.22 avankest 1059: <code>DOMString</code>, readonly</dt>
1.12 avankest 1060:
1.5 avankest 1061: <dd>
1.72 avankest 1062: <p>On getting, if available, it <em class="ct">must</em> return the HTTP
1063: status text sent by the server (appears after the status code). Otherwise,
1064: if not available, the user agent <em class="ct">must</em> raise an
1065: <code>INVALID_STATE_ERR</code> exception.</p>
1.1 avankest 1066: </dd>
1067: </dl>
1.12 avankest 1068:
1.31 avankest 1069: <h3 id="events">Events for the <code title="">XMLHttpRequest</code>
1070: Object</h3>
1.12 avankest 1071:
1.1 avankest 1072: <p>These sections describe the various events that can be dispatched on the
1.22 avankest 1073: object implementing the <code>XMLHttpRequest</code> interface. For this
1074: version of the specification only one event is defined.</p>
1.12 avankest 1075:
1.1 avankest 1076: <dl>
1077: <dt><dfn id="dfn-readystatechange"><code>readystatechange</code></dfn></dt>
1.24 avankest 1078:
1.72 avankest 1079: <dd>When the user agent dispatches a <code title="">readystatechange</code>
1080: event (as indicated above) it <em class="ct">must not</em> bubble,
1081: <em class="ct">must not</em> be cancelable and <em class="ct">must</em>
1082: implement the <code>Event</code> interface. Its <code>namespaceURI</code>
1083: attribute <em class="ct">must</em> be <code>null</code>.
1084: [<cite><span>DOM3Events</span></cite>]</dd>
1.1 avankest 1085: </dl>
1.32 avankest 1086:
1.31 avankest 1087: <h3 id="exceptions">Exceptions for the <code title="">XMLHttpRequest</code>
1088: Object</h3>
1089:
1.32 avankest 1090: <pre class="idl">exception <dfn>XMLHttpRequestException</dfn> {
1.31 avankest 1091: unsigned short code;
1092: };
1093: const unsigned short <span>NETWORK_ERR</span> = 101;</pre>
1094:
1.33 avankest 1095: <p>The <dfn id="network-err"><code>NETWORK_ERR</code></dfn> exception is
1096: thrown when a network error occurs in synchronous requests. See the section
1097: on <code>send()</code> for more details.</p>
1.11 avankest 1098:
1.29 avankest 1099: <h2 class="no-num" id="notcovered">Not in this Specification</h2>
1100:
1101: <p><em>This section is non normative.</em></p>
1102:
1.72 avankest 1103: <p>This specification does not include the following features which are
1104: being considered for a future version of this specification:</p>
1.29 avankest 1105:
1106: <ul>
1107: <li><code>load</code> event and <code>onload</code> attribute;</li>
1108: <li><code>error</code> event and <code>onerror</code> attribute;</li>
1109: <li><code>progress</code> event and <code>onprogress</code> attribute;</li>
1110: <li><code title="">abort</code> event and <code>onabort</code> attribute;</li>
1111: <li>Timers have been suggested, perhaps an <code>ontimeout</code>
1112: attribute;</li>
1113: <li>Property to disable following redirects;</li>
1.30 avankest 1114: <li><code title="">responseXML</code> for <code>text/html</code>
1115: documents;</li>
1.40 avankest 1116: <li>Cross-site <code title="">XMLHttpRequest</code>;</li>
1.87 avankest 1117: <li><code>responseBody</code> to deal with byte streams;</li>
1118: <li><code>getRequestHeader()</code> and
1119: <code>removeRequestHeader()</code>.</li>
1.29 avankest 1120: </ul>
1121:
1.1 avankest 1122: <h2 class="no-num" id="bibref">References</h2>
1.11 avankest 1123:
1.6 avankest 1124: <dl>
1.37 avankest 1125: <dt>[<dfn id="DOM3">DOM3Core</dfn>]</dt>
1.24 avankest 1126:
1.11 avankest 1127: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-3-Core">Document Object
1.92 avankest 1128: Model (DOM) Level 3 Core Specification</a></cite>, A. Le Hors, P. Le
1129: Hégaret, L. Wood, G. Nicol, J. Robie, M. Champion, S. Byrne, editors. World
1130: Wide Web Consortium, April 2004.</dd>
1.11 avankest 1131:
1.37 avankest 1132: <dt>[<dfn id="DOM3EV">DOM3Events</dfn>]</dt>
1.24 avankest 1133:
1.92 avankest 1134: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-3-Events/">Document
1135: Object Model (DOM) Level 3 Events Specification</a></cite>, Björn Höhrmann,
1136: editor. World Wide Web Consortium, April 2006.</dd>
1.11 avankest 1137:
1.37 avankest 1138: <dt>[<dfn id="ref-ecmascript">ECMAScript</dfn>]</dt>
1.24 avankest 1139:
1.92 avankest 1140: <dd><cite><a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript
1141: Language Specification</a></cite>, Third Edition. ECMA, December 1999.</dd>
1.14 avankest 1142:
1.37 avankest 1143: <dt>[<dfn id="ref-rfc2046">RFC2046</dfn>]</dt>
1.24 avankest 1144:
1.19 avankest 1145: <dd><cite><a href="http://ietf.org/rfc/rfc2046">Multipurpose Internet Mail
1.92 avankest 1146: Extensions (MIME) Part Two: Media Types</a></cite>, N. Freed, N.
1147: Borenstein, editors. IETF, November 1996.</dd>
1.14 avankest 1148:
1.37 avankest 1149: <dt>[<dfn id="RFC2119">RFC2119</dfn>]</dt>
1.24 avankest 1150:
1.92 avankest 1151: <dd><cite><a href="http://ietf.org/rfc/rfc2119">RFC 2119: Key words for use
1152: in RFCs to Indicate Requirement Levels</a></cite>, S. Bradner. IETF, March
1153: 1997.</dd>
1.12 avankest 1154:
1.37 avankest 1155: <dt>[<dfn id="RFC2616">RFC2616</dfn>]</dt>
1.24 avankest 1156:
1.11 avankest 1157: <dd><cite><a href="http://ietf.org/rfc/rfc2616">Hypertext Transfer Protocol
1.92 avankest 1158: -- HTTP/1.1</a></cite>, R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L.
1159: Masinter, P. Leach, T. Berners-Lee, editors. IETF, June 1999.</dd>
1.12 avankest 1160:
1.37 avankest 1161: <dt>[<dfn id="ref-rfc2617">RFC2617</dfn>]</dt>
1.24 avankest 1162:
1.11 avankest 1163: <dd><cite><a href="http://ietf.org/rfc/rfc2617">HTTP Authentication: Basic
1.92 avankest 1164: and Digest Access Authentication</a></cite>, P. Hallam-Baker, J.
1165: Hostetler, S. Lawrence, P. Leach, A. Luotonen, L. Stewart, editors. IETF,
1166: June 1999.</dd>
1.12 avankest 1167:
1.37 avankest 1168: <dt>[<dfn id="ref-rfc2965">RFC2965</dfn>]</dt>
1.24 avankest 1169:
1.19 avankest 1170: <dd><cite><a href="http://ietf.org/rfc/rfc2965">HTTP State Management
1.92 avankest 1171: Mechanism</a></cite>, D. Kristol, L. Montulli, editors. IETF, October
1172: 2000.</dd>
1.19 avankest 1173:
1.37 avankest 1174: <dt>[<dfn id="ref-rfc3986">RFC3986</dfn>]</dt>
1.24 avankest 1175:
1.11 avankest 1176: <dd><cite><a href="http://ietf.org/rfc/rfc3986">Uniform Resource Identifier
1.92 avankest 1177: (URI): Generic Syntax</a></cite>, T. Berners-Lee, R. Fielding, L. Masinter,
1178: editors. IETF, January 2005.</dd>
1.28 avankest 1179:
1.92 avankest 1180: <dt>[<dfn id="ref-window">Window</dfn>]</dt>
1.28 avankest 1181:
1.92 avankest 1182: <dd><cite><a href="http://www.w3.org/TR/Window/">Window Object
1183: 1.0</a></cite>, I. Davis, M. Stachowiak, editors. W3C, April 2006.</dd>
1.41 avankest 1184:
1.92 avankest 1185: <dt>[<dfn id="ref-xml">XML</dfn>]</dt>
1.41 avankest 1186:
1.92 avankest 1187: <dd><cite><a href="http://www.w3.org/TR/xml/">Extensible Markup Language
1188: (XML) 1.0 (Fourth Edition)</a></cite>, T. Bray, J. Paoli, C.
1189: Sperberg-McQueen, E. Maler, F. Yergeau. W3C, September 2006.</dd>
1.41 avankest 1190:
1.92 avankest 1191: <dt>[<dfn id="ref-xmlns">XMLNS</dfn>]</dt>
1.41 avankest 1192:
1.92 avankest 1193: <dd><cite><a href="http://www.w3.org/TR/xml-names/">Namespaces in XML
1194: (Second Edition)</a></cite>, T. Bray, D. Hollander, A. Layman, R. Tobin.
1195: W3C, August 2006.</dd>
1.1 avankest 1196: </dl>
1.11 avankest 1197:
1.1 avankest 1198: <h2 class="no-num" id="acknowledgements">Acknowledgements</h2>
1.11 avankest 1199:
1.1 avankest 1200: <p><em>This section is non-normative</em></p>
1.12 avankest 1201:
1.7 avankest 1202: <p>The editor would like to thank to the following people who have contributed
1.33 avankest 1203: to this specification (ordered by first name):</p>
1.12 avankest 1204:
1.1 avankest 1205: <ul>
1.22 avankest 1206: <li>Alex Hopmann</li>
1.7 avankest 1207: <li>Alex Vincent</li>
1.15 avankest 1208: <li>Alexey Proskuryakov</li>
1.1 avankest 1209: <li>Asbjørn Ulsberg</li>
1210: <li>Boris Zbarsky</li>
1211: <li>Björn Höhrmann</li>
1212: <li>Cameron McCormack</li>
1213: <li>Christophe Jolif</li>
1214: <li>Charles McCathieNevile</li>
1.54 avankest 1215: <li>Dan Winship</li>
1.72 avankest 1216: <li>David Håsäther</li>
1.1 avankest 1217: <li>Dean Jackson</li>
1218: <li>Doug Schepers</li>
1219: <li>Douglas Livingstone</li>
1220: <li>Gorm Haug Eriksen</li>
1221: <li>Hallvord R. M. Steen</li>
1222: <li>Håkon Wium Lie</li>
1223: <li>Ian Davis</li>
1224: <li>Ian Hickson</li>
1225: <li>Ivan Herman</li>
1226: <li>Jens Lindström</li>
1227: <li>Jim Deegan</li>
1228: <li>Jim Ley</li>
1229: <li>Jonas Sicking</li>
1230: <li>Julian Reschke</li>
1231: <li>Karl Dubost</li>
1232: <li>Maciej Stachowiak</li>
1.7 avankest 1233: <li>Magnus Kristiansen</li>
1.1 avankest 1234: <li>Marc Hadley</li>
1.53 avankest 1235: <li>Marcos Caceres</li>
1.87 avankest 1236: <li>Mark Baker</li>
1.1 avankest 1237: <li>Mark Nottingham</li>
1.92 avankest 1238: <li>Mohamed Zergaoui</li>
1.1 avankest 1239: <li>Pawel Glowacki</li>
1240: <li>Robin Berjon</li>
1241: <li>Ruud Steltenpool</li>
1.33 avankest 1242: <li>Simon Pieters</li>
1.1 avankest 1243: </ul>
1.12 avankest 1244:
1.1 avankest 1245: <p>Special thanks to the Microsoft employees who first implemented the
1.22 avankest 1246: <code>XMLHttpRequest</code> interface, which was first widely deployed by the
1247: Windows Internet Explorer browser.</p>
1.12 avankest 1248:
1.54 avankest 1249: <p>Special thanks also to the WHATWG for drafting an initial version of this
1.22 avankest 1250: specification in their Web Applications 1.0 document.</p>
1.12 avankest 1251:
1.1 avankest 1252: <p>Thanks also to all those who have helped to improve this specification by
1.22 avankest 1253: sending suggestions and corrections. (Please, keep bugging us with your
1254: issues!)</p>
1.1 avankest 1255: </body>
1256: </html>
1.92 avankest 1257:
Webmaster