Annotation of 2006/webapi/XMLHttpRequest/Overview.src.html, revision 1.78
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 }
10: p.note { margin-left:2em; font-weight:bold; font-style:italic; color:#008000 }
11: p.note::before { content:"Note: " }
12: p.issue { padding:.5em; border:solid #f00 }
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>
218:
1.75 avankest 219: <p>User agents <em class="ct">may</em> optimize any algorithm given in
220: this specification, so long as the end result is indistinguishable from
221: the result that would be obtained by the specification's algorithms. (The
222: algorithms in this specification are generally written with more concern
223: for clarity than efficiency.)</p>
1.74 avankest 224: </dd>
1.24 avankest 225:
1.74 avankest 226: <dt><dfn id="conforming-script">Conforming script</dfn></dt>
1.24 avankest 227:
1.74 avankest 228: <dd><p>A script <em class="ct">must</em> satisfy the constraints and
229: conditions described by this specification in order to be
230: conformant.</p></dd>
1.1 avankest 231: </dl>
1.32 avankest 232:
1.30 avankest 233: <h4 id="dependencies">Dependencies</h4>
1.33 avankest 234:
1.29 avankest 235: <p>This specification relies on several underlying specifications.</p>
236: <dl>
237: <dt>DOM</dt>
1.33 avankest 238:
1.29 avankest 239: <dd>
240: <p>Implementations <em class="ct">must</em> support some version of DOM
1.37 avankest 241: Events because this specification uses some of the features defined in
242: that specification. [<cite><span>DOM3Events</span></cite>]</p>
1.39 avankest 243:
1.37 avankest 244: <p>Implementations <em class="ct">must</em> support some version of DOM
245: Core because this specification uses some of the features defined in that
246: specification. [<cite><span>DOM3Core</span></cite>]</p>
1.29 avankest 247:
248: <p>Implementations <em class="ct">must</em> support some version of the
1.37 avankest 249: Window Object because some of the functionality in this specification
250: relies on it. [<cite><span>Window</span></cite>]</p>
1.29 avankest 251: </dd>
252:
253: <dt>HTTP</dt>
1.33 avankest 254:
1.29 avankest 255: <dd>
1.39 avankest 256: <p>Implementations <em class="ct">must</em> support some version of the
1.58 avankest 257: HTTP protocol. The user agent <em class="ct">should</em> support any HTTP
258: method that matches the <span><code>Method</code> production</span> and
1.73 avankest 259: <em class="ct">must</em> at least support the following methods:</p>
1.74 avankest 260: <!-- define case-insensitive a-z -> A-Z -->
1.58 avankest 261:
262: <ul>
263: <li><code>GET</code></li>
264: <li><code>POST</code></li>
265: <li><code>HEAD</code></li>
266: <li><code>PUT</code></li>
267: <li><code>DELETE</code></li>
268: <li><code>OPTIONS</code></li>
269: </ul>
270:
271: <p>Other requirements regarding HTTP are made throughout the
1.39 avankest 272: specification. [<cite><span>RFC2616</span></cite>]</p>
1.29 avankest 273: </dd>
1.41 avankest 274:
275: <dt>XML</dt>
276:
277: <dd>
1.64 avankest 278: <p>Implementations <em class="ct">should</em> support some version of XML.
279: If they don't support some version of XML <code>responseXML</code>
1.41 avankest 280: <em class="ct">must</em> always be <code>null</code>.
281: [<cite><span>XML</span></cite>] [<cite><span>XMLNS</span></cite>]</p>
282: </dd>
1.29 avankest 283: </dl>
1.12 avankest 284:
1.1 avankest 285: <h3 id="extensibility">Extensibility</h3>
1.12 avankest 286:
287: <p><em>This section is non-normative.</em></p>
288:
1.25 avankest 289: <p>Extensions of the APIs defined by this specification are <em>strongly
1.22 avankest 290: discouraged</em>. User agents, Working Groups and other interested parties
1.33 avankest 291: should discuss extensions on a relevant public forum, preferably
1.22 avankest 292: <a href="mailto:public-webapi@w3.org">public-webapi@w3.org</a>.</p>
1.12 avankest 293:
294: <h2 id="xmlhttprequest">The <code title="">XMLHttpRequest</code> Object</h2>
295:
1.58 avankest 296: <p>The <code>XMLHttpRequest</code> object can be used by scripts to
1.22 avankest 297: programmatically connect to their originating server via HTTP.</p>
1.12 avankest 298:
1.1 avankest 299: <p>Objects implementing the <code>XMLHttpRequest</code> interface
1.22 avankest 300: <em class="ct">must</em> also implement the <code>EventTarget</code>
1.58 avankest 301: interface. [<cite><span>DOM3Events</span></cite>]</p>
1.12 avankest 302:
1.58 avankest 303: <p>Objects implementing the <code title="">Window</code> interface
304: <em class="ct">must</em> provide an <code title="">XMLHttpRequest()</code>
305: constructor. [<cite><span>Window</span></cite>]</p>
1.12 avankest 306:
1.1 avankest 307: <div class="example">
1.58 avankest 308: <p>In ECMAScript this can be used as follows:</p>
309: <!-- [<cite><span>ECMAScript</span></cite>] -->
310:
311: <pre><code>var client = new XMLHttpRequest();</code></pre>
1.1 avankest 312: </div>
1.12 avankest 313:
1.58 avankest 314: <p>When the <code title="">XMLHttpRequest()</code> constructor is invoked a
315: persistent pointer to the associated <code title="">Window</code> object
316: <em class="ct">must</em> be stored on the newly created object. This is the
1.25 avankest 317: <dfn title="Window pointer" id="window-pointer"><code>Window</code>
1.58 avankest 318: pointer</dfn>. The associated <code title="">Window</code> object is the one
319: of which the <code title="">XMLHttpRequest</code> constructor was
320: invoked. This <span title="Window pointer">pointer</span>
1.25 avankest 321: <em class="ct">must</em> persist even if the browsing context in which the
1.37 avankest 322: <code title="">Window</code> is located is destroyed (by removing it from a
323: parent browsing context, for instance).</p>
1.25 avankest 324:
1.37 avankest 325: <p>The term browsing context is defined by the <cite>Window Object
326: 1.0</cite> specification. [<cite><span>Window</span></cite>]</p>
1.27 avankest 327:
328: <!-- XXX if the document object changes in the browsing context you get an
1.33 avankest 329: exception in some implementations. -->
1.27 avankest 330:
1.58 avankest 331: <div class="example">
1.65 avankest 332: <p>If <var><code>win</code></var> is a <code title="">Window</code> object
333: <var><code>client</code></var> will have a pointer to
334: <var><code>win</code></var> in the following example:</p>
1.58 avankest 335:
1.65 avankest 336: <pre><code>var client = new win.XMLHttpRequest()</code></pre>
1.58 avankest 337: </div>
1.12 avankest 338:
1.58 avankest 339: <pre class="idl">interface <dfn id="xmlhttprequest-object">XMLHttpRequest</dfn> {
340: // event handler
1.70 avankest 341: attribute EventListener <span>onreadystatechange</span>;
1.58 avankest 342:
343: // state
1.71 avankest 344: const unsigned short <span title="UNSENT state">UNSENT</span> = 0;
1.58 avankest 345: const unsigned short <span title="OPEN state">OPEN</span> = 1;
346: const unsigned short <span title="SENT state">SENT</span> = 2;
347: const unsigned short <span title="RECEIVING state">RECEIVING</span> = 3;
348: const unsigned short <span title="LOADED state">LOADED</span> = 4;
1.70 avankest 349: readonly attribute unsigned short <span>readyState</span>;
1.58 avankest 350:
351: // request
1.70 avankest 352: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>);
353: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>);
354: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>, in DOMString <var>user</var>);
355: 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>);
356: void <span>setRequestHeader</span>(in DOMString <var>header</var>, in DOMString <var>value</var>);
357: void <span>send</span>();
358: void <span>send</span>(in DOMString <var>data</var>);
359: void <span>send</span>(in Document <var>data</var>);
360: void <span>abort</span>();
1.58 avankest 361:
362: // response
1.70 avankest 363: DOMString <span>getAllResponseHeaders</span>();
364: DOMString <span>getResponseHeader</span>(in DOMString <var>header</var>);
365: readonly attribute DOMString <span>responseText</span>;
366: readonly attribute Document <span>responseXML</span>;
367: readonly attribute unsigned short <span>status</span>;
368: readonly attribute DOMString <span>statusText</span>;
1.1 avankest 369: };</pre>
1.8 avankest 370:
1.58 avankest 371: <p>The <code>XMLHttpRequest</code> object can be in five states:
1.71 avankest 372: <span title="UNSENT state">UNSENT</span>,
1.58 avankest 373: <span title="OPEN state">OPEN</span>, <span title="SENT state">SENT</span>,
374: <span title="RECEIVING state">RECEIVING</span> and
375: <span title="LOADED state">LOADED</span>. The current state is exposed
376: through the <code>readyState</code> attribute. The method definitions below
1.63 avankest 377: define when a state transition takes place.</p>
1.58 avankest 378:
379: <p>When constructed, the <code>XMLHttpRequest</code> object
1.71 avankest 380: <em class="ct">must</em> be in the UNSENT state. This state is represented
381: by the <dfn id="unsent" title="UNSENT state"><code>UNSENT</code></dfn>
1.58 avankest 382: constant, whose value is <code>0</code>.</p>
383:
384: <p>The OPEN state is the state of the object when the <code>open()</code>
385: method has been successfully invoked. During this state reqeust headers can
386: be set using <code>setRequestHeader()</code> and the request can be made
387: using <code>send()</code>. This state is represented by the
388: <dfn id="open" title="OPEN state"><code>OPEN</code></dfn> constant, whose
389: value is <code>1</code>.</p>
390:
391: <p>The SENT state is the state of the object when the user agent
392: successfully acknowledged the request. This state is represented by the
393: <dfn id="sent" title="SENT state"><code>SENT</code></dfn> constant, whose
394: value is <code>2</code>.</p>
395:
396: <p>The RECEIVING state is the state of the object when all HTTP headers have
397: been received. The object typically remains in this state until the complete
398: message body (if any) has been received. This state is represented by the
399: <dfn id="receiving" title="RECEIVING state"><code>RECEIVING</code></dfn>
400: constant, whose value is <code>3</code>.</p>
401:
402: <p>The LOADED state is the state of the object when either the data transfer
403: has been completed or something went wrong during the transfer (infinite
404: redirects for instance). This state is represented by the
405: <dfn id="loaded" title="LOADED state"><code>LOADED</code></dfn> constant,
406: whose value is <code>4</code>.</p>
407:
1.5 avankest 408: <dl>
1.12 avankest 409:
1.39 avankest 410: <dt><dfn id="dfn-onreadystatechange"><code>onreadystatechange</code></dfn>
411: of type <code>EventListener</code></dt>
1.12 avankest 412:
1.1 avankest 413: <dd>
414: <p>An attribute that takes an <code>EventListener</code> as value that
1.58 avankest 415: <em class="ct">must</em> be invoked along with any other appropriate event
416: listeners that are registered on this object when a
417: <code>readystatechange</code> event is dispatched on it. Its initial value
418: <em class="ct">must</em> be <code>null</code>.</p>
1.1 avankest 419: </dd>
1.12 avankest 420:
1.1 avankest 421: <dt><dfn id="dfn-readystate"><code>readyState</code></dfn> of type
1.22 avankest 422: <code>unsigned short</code>, readonly</dt>
1.12 avankest 423:
1.1 avankest 424: <dd>
1.58 avankest 425: <p>The attribute <em class="ct">must</em> be the value of the constant
426: corresponding to the object's current state.</p>
1.1 avankest 427: </dd>
1.12 avankest 428:
1.14 avankest 429: <dt><dfn id="dfn-open" title="open"><code>open(<var>method</var>,
1.22 avankest 430: <var>url</var>, <var>async</var>, <var>user</var>,
431: <var>password</var>)</code></dfn>, method</dt>
1.12 avankest 432:
1.1 avankest 433: <dd>
1.58 avankest 434: <p>When invoked, the user agent <em class="ct">must</em> follow the
435: following steps:</p>
436:
437: <ol>
438: <li><p>If the <var>method</var> argument doesn't match the
439: <dfn><code>Method</code> production</dfn> defined in section 5.1.1 of RFC
440: 2616 the user agent <em class="ct">must</em> raise a
441: <code>SYNTAX_ERR</code> exception and abort these steps.
442: [<cite><span>RFC2616</span></cite>]</p></li>
443:
444: <li><p>If the given <var>method</var> is not supported for security
445: reasons the user agent <em class="ct">should</em> raise a
446: <code>SECURITY_ERR</code> exception and abort these steps.</p></li>
447:
448: <li><p>Let <var>stored method</var> be <var>method</var>.</p></li>
449:
450: <li><p>If <var>method</var> case-insensitively matches <code>GET</code>,
451: <code>POST</code>, <code>HEAD</code>, <code>PUT</code>,
452: <code>DELETE</code> or <code>OPTIONS</code> the user agent
1.72 avankest 453: <em class="ct">must</em> convert it to its uppercase equivalent and let
454: <var>stored method</var> be the result.</p></li>
1.68 avankest 455: <!-- WebKit (and supposedly Firefox) also uppercase: CONNECT, COPY,
456: INDEX, LOCK, M-POST, MKCOL, MOVE, PROPFIND, PROPPATCH, TRACE and UNLOCK.
457: Not sure if TRACE and CONNECT are worth it though. They raise a
458: SECURITY_ERR exception anyway... -->
1.58 avankest 459:
460: <li><p>Drop the fragment identifier (if any) from <var>url</var> and let
461: <var>stored url</var> be the result of that operation.</p></li>
462:
463: <li><p>If <var>stored url</var> is a relative reference it
464: <em class="ct">must</em> be resolved using the current value of the
465: <code>baseURI</code> attribute of the <code>Document</code> object
466: currently associated with the <span><code>Window</code> pointer</span>.
467: If this fails the user agent <em class="ct">must</em> raise a
468: <code>SYNTAX_ERR</code> exception and abort these steps.</p></li>
469:
470: <li><p>If the <code>"user:password"</code> format in the
471: <code>userinfo</code> production defined in section 3.2.1 of RFC 3986 is
472: not supported for the relevant scheme and <var>stored url</var> contains
473: this format the user agent <em class="ct">must</em> throw a
1.69 avankest 474: <code>SYNTAX_ERR</code> and abort these steps.
475: [<cite><span>RFC3986</span></cite>]</p></li>
1.58 avankest 476:
477: <li><p>If <var>stored url</var> contains the <code>"user:password"</code>
478: format let <var>stored user</var> be the user part and <var>stored
479: password</var> be the password part.</p></li>
480:
481: <li><p>If <var>stored url</var> just contains the <code>"user"</code>
482: format let <var>stored user</var> be the user part.</p></li>
483:
1.69 avankest 484: <li>
485: <p>If <var>stored url</var> is non same-origin the user agent
486: <em class="ct">should</em> raise a <code>SECURITY_ERR</code> exception
487: and abort these steps.</p>
488: <p class="note">This specification does not define what constitutes as
1.71 avankest 489: non same-origin.<!-- XXX reference HTML5? --></p>
1.69 avankest 490: </li>
1.58 avankest 491:
492: <li><p>Let <var>async</var> be the value of the <var>async</var> argument
493: or <code>false</code> if it was omitted.</p></li>
494:
495: <li><p>If the <var>user</var> argument was not omitted and its syntax
496: does not match that specified by the relevant authentication scheme the
497: user agent <em class="ct">must</em> raise a <code>SYNTAX_ERR</code>
498: exception and abort these steps.</p></li>
1.14 avankest 499:
1.58 avankest 500: <li>
501: <p>If the <var>user</var> argument was not omitted and is not
502: <code>null</code> let <var>stored user</var> be <var>user</var> encoded
503: using the encoding specified in the relevant authentication scheme or
504: UTF-8 if the scheme fails to specify an encoding.</p>
1.14 avankest 505:
1.58 avankest 506: <p class="note">This step overrides any user that may have been set by
507: the <var>url</var> argument.</p>
508: </li>
1.16 avankest 509:
1.58 avankest 510: <li><p>If the <var>user</var> argument was not omitted and is
511: <code>null</code> remove <var>stored user</var>.</p></li>
1.14 avankest 512:
1.58 avankest 513: <li><p>If the <var>password</var> argument was not omitted and its syntax
514: does not match that specified by the relevant authentication scheme the
515: user agent <em class="ct">must</em> raise a <code>SYNTAX_ERR</code>
516: exception and abort these steps.</p></li>
517:
518: <li><p>If the <var>password</var> argument was not omitted and is not
519: <code>null</code> let <var>stored password</var> be <var>password</var>
520: encoded using the encoding specified in the relevant authentication
521: scheme or UTF-8 if the scheme fails to specify an encoding.</p></li>
522:
523: <li><p>If the <var>password</var> argument was not omitted and is
524: <code>null</code> remove <var>stored password</var>.</p></li>
525:
526: <li><p>Set <code>responseText</code>, <code>responseXML</code>,
527: <code>status</code> and <code>statusText</code> to their initial
528: values and reset the list of request headers.<p></li>
529:
1.60 avankest 530: <li><p>Any network activity for which the object responsible
531: <em class="ct">should</em> be cancelled.</p></li>
1.58 avankest 532: <!-- we can hardly require it... -->
533:
534: <li><p>Switch the object to the <span title="OPEN state">OPEN</span>
535: state; the user agent <em class="ct">must</em> then synchronously
536: dispatch a <code>readystatechange</code> event on the object and abort
537: these steps (returning the method call).</p></li>
538: </ol>
1.14 avankest 539:
1.19 avankest 540: <p class="note">A future version or extension of this specification will
1.33 avankest 541: most likely define a way of doing cross-site requests.</p>
1.1 avankest 542: </dd>
1.12 avankest 543:
1.14 avankest 544: <dt><dfn id="dfn-setrequestheader" title="setrequestheader"><code>setRequestHeader(<var>header</var>,
1.22 avankest 545: <var>value</var>)</code></dfn>, method</dt>
1.12 avankest 546:
1.5 avankest 547: <dd>
1.45 avankest 548: <p>Each request has a list of request headers with associated values. This
549: method can be used to manipulate those values and set new request
550: headers.</p>
551:
1.58 avankest 552: <p>When invoked, the user agent <em class="ct">must</em> follow the
553: following steps:</p>
1.14 avankest 554:
1.58 avankest 555: <ol>
556: <li><p>If the state of the object is not
557: <span title="OPEN state">OPEN</span> the user agent
558: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
559: exception and abort these steps.</p></li>
560:
561: <li><p>If the <span><code>send()</code> flag</span> is set the user agent
562: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
563: exception and abort these steps.</p></li>
1.14 avankest 564:
1.58 avankest 565: <li><p>If the <var>header</var> argument doesn't match the
1.22 avankest 566: <dfn><code>field-name</code> production</dfn> as defined by section 4.2
1.70 avankest 567: of RFC 2616 or is <code>null</code> the user agent
1.72 avankest 568: <em class="ct">must</em> raise a <code>SYNTAX_ERR</code> exception and
569: abort these steps. [<cite><span>RFC2616</span></cite>]</p></li>
1.70 avankest 570:
571: <li><p>If the <var>value</var> argument is <code>null</code> the user
572: agent <em class="ct">must</em> abort these steps. (Don't raise an
573: exception.)</li>
574: <!-- undefined is to be treated as null here... -->
575:
1.58 avankest 576: <li><p>If the <var>value</var> argument doesn't match the
1.22 avankest 577: <dfn><code>field-value</code> production</dfn> as defined by section 4.2
1.58 avankest 578: of RFC 2616 the user agent <em class="ct">must</em> raise a
579: <code>SYNTAX_ERR</code> and abort these steps.
580: [<cite><span>RFC2616</span></cite>]</p></li>
1.14 avankest 581:
1.32 avankest 582: <li>
1.58 avankest 583: <p>For security reasons these steps <em class="ct">should</em> be
584: aborted if the <var>header</var> argument case-insensitively matches one
585: of the following headers:</p>
586:
1.32 avankest 587: <ul>
588: <li><code>Accept-Charset</code></li>
589: <li><code>Accept-Encoding</code></li>
1.68 avankest 590: <li><code>Connection</code></li>
1.32 avankest 591: <li><code>Content-Length</code></li>
1.68 avankest 592: <li><code>Content-Transfer-Encoding</code></li>
593: <li><code>Date</code></li>
1.32 avankest 594: <li><code>Expect</code></li>
595: <li><code>Host</code></li>
596: <li><code>Keep-Alive</code></li>
597: <li><code>Referer</code></li>
598: <li><code>TE</code></li>
599: <li><code>Trailer</code></li>
600: <li><code>Transfer-Encoding</code></li>
601: <li><code>Upgrade</code></li>
1.68 avankest 602: <li><code>Via</code></li>
1.32 avankest 603: </ul>
604: </li>
1.5 avankest 605:
1.59 avankest 606: <!--
1.58 avankest 607: <li>
608: <p>If the <var>header</var> argument case-insensitively matches one of
609: the following headers the user agent <em class="ct">must</em> set the
610: value of that HTTP header to <var>value</var> and abort these steps:</p>
1.14 avankest 611:
1.58 avankest 612: <ul>
613: <li><code>Apply-To-Redirect-Ref</code></li>
614: <li><code>Authorization</code></li>
615: <li><code>C-Ext</code></li>
616: <li><code>Content-Base</code></li>
617: <li><code>Content-Location</code></li>
618: <li><code>Content-MD5</code></li>
619: <li><code>Content-Range</code></li>
620: <li><code>Content-Type</code></li>
621: <li><code>Content-Version</code></li>
622: <li><code>Cookie</code></li>
623: <li><code>Cookie2</code></li>
624: <li><code>Delta-Base</code></li>
625: <li><code>Depth</code></li>
626: <li><code>Destination</code></li>
627: <li><code>ETag</code></li>
628: <li><code>Ext</code></li>
629: <li><code>From</code></li>
630: <li><code>If</code></li>
631: <li><code>If-Modified-Since</code></li>
632: <li><code>If-Range</code></li>
633: <li><code>If-Unmodified-Since</code></li>
634: <li><code>Label</code></li>
635: <li><code>Lock-Token</code></li>
636: <li><code>Max-Forwards</code></li>
637: <li><code>MIME-Version</code></li>
638: <li><code>Ordering-Type</code></li>
639: <li><code>Overwrite</code></li>
640: <li><code>Proxy-Authorization</code></li>
641: <li><code>Redirect-Ref</code></li>
642: <li><code>SOAPAction</code></li>
643: <li><code>Status-URI</code></li>
644: <li><code>Timeout</code></li>
645: </ul>
646: </li>
1.59 avankest 647: -->
1.44 avankest 648:
1.58 avankest 649: <li><p>If the <var>header</var> argument is not in the list of request
650: headers the user agent <em class="ct">must</em> append the
651: <var>header</var> with its associated <var>value</var> to the list and
652: abort these steps.</p></li>
653:
654: <li><p>If the <var>header</var> argument is in the list of request
655: headers the user agent <em class="ct">must</em> either use multiple
656: headers, combine the values or use a combination of those (section 4.2,
1.66 avankest 657: RFC 2616). [<cite><span>RFC2616</span></cite>]</p></li>
1.58 avankest 658: </ol>
1.45 avankest 659:
660: <p class="note">See also the <code>send()</code> method regarding user
1.71 avankest 661: agent header handling for caching, authentication, proxies, and
662: cookies.</p>
1.14 avankest 663:
664: <div class="example">
1.58 avankest 665: <pre><code>// The following script:
1.14 avankest 666: var client = new XMLHttpRequest();
667: client.open('GET', 'demo.cgi');
668: client.setRequestHeader('X-Test', 'one');
669: client.setRequestHeader('X-Test', 'two');
670: client.send();
671:
672: // ...would result in the following header being sent:
673: ...
674: X-Test: one, two
1.58 avankest 675: ...</code></pre>
1.14 avankest 676: </div>
1.5 avankest 677: </dd>
1.12 avankest 678:
1.14 avankest 679: <dt><dfn id="dfn-send" title="send"><code>send(<var>data</var>)</code></dfn>,
1.22 avankest 680: method</dt>
1.12 avankest 681:
1.17 avankest 682: <dd>
1.58 avankest 683: <p>The <code>send()</code> method initiates the request and its optional
684: argument <em class="ct">may</em> be used by scripts to provide the entity
685: body. When the argument is provided scripts <em class="ct">should</em>
686: ensure that they have specified (before invoking <code>send()</code>) the
1.60 avankest 687: <code>Content-Type</code> header via <code>setRequestHeader()</code>.</p>
1.58 avankest 688:
689: <p>When invoked, the user agent <em class="ct">must</em> follow the
690: following steps:</p>
691:
692: <ol>
693: <li><p>If the state of the object is not
694: <span title="OPEN state">OPEN</span> the user agent
695: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
696: exception and abort these steps.</p></li>
697:
698: <li><p>If the <span><code>send()</code> flag</span> is set the user agent
699: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
700: exception and abort these steps.</p></li>
701:
702: <li>
703: <p>If the <var>data</var> argument has not been omitted and is not
704: <code>null</code> it <em class="ct">must</em> be used for the
705: <dfn id="dfn-entity-body">entity body</dfn> as defined by section 7.2 of
1.71 avankest 706: RFC 2616. [<cite><span>RFC2616</span></cite>]</p>
707:
708: <p>The following rules <em class="ct">must</em> be followed by the user
709: agent:</p>
1.58 avankest 710:
711: <dl>
712: <dt><var>data</var> is a <code>DOMString</code></dt>
713:
1.78 ! avankest 714: <dd><p><var>data</var> <em class="ct">must</em> be encoded as UTF-8 for
! 715: transmission.</p></dd>
1.58 avankest 716:
717: <dt><var>data</var> is a <code>Document</code>
718:
719: <dd>
720: <p><var>data</var> <em class="ct">must</em> be serialized into a
721: namespace well-formed XML document and encoded using the encoding
722: given by <code><var>data</var>.xmlEncoding</code>, if specified, or
723: UTF-8 otherwise. If this fails because the <code>Document</code>
724: cannot be serialized the user agent <em class="ct">must</em> act as if
725: <var>data</var> was <code>null</code>.</p>
726:
727: <p>If no <code>Content-Type</code> header has been set by the script
1.71 avankest 728: the user agent <em class="ct">must</em> append it to the list of
1.58 avankest 729: request headers with a value of <code>application/xml</code>.</p>
730:
731: <p class="note">Subsequent changes to the <code>Document</code> have
732: no effect on what is submitted.</p>
733: </dd>
734:
735: <dt><var>data</var> is not a <code>DOMString</code> or
736: <code>Document</code></dt>
737:
1.78 ! avankest 738: <dd><p>The stringification mechanisms of the host language
1.58 avankest 739: <em class="ct">must</em> be used on <var>data</var> and the result
740: <em class="ct">must</em> be treated as if <var>data</var> is a
1.78 ! avankest 741: <code>DOMString</code>.</p></dd>
! 742: <!-- XXX What if the host language doesn't have stringification for
! 743: each type? Do we care? -->
1.58 avankest 744: </dl>
745:
746: <p>If the data argument has been omitted or is <code>null</code> no
747: entity body <em class="ct">must</em> be used in the request.</p>
748: </li>
749:
1.71 avankest 750: <li><p>Make a request to <var>stored url</var>, using HTTP method
751: <var>stored method</var>, user <var>stored user</var> (if provided) and
752: password <var>stored password</var> (if provided), taking into account
753: the entity body, list of request headers and the rules listed directly
754: after this set of steps.</p></li>
1.60 avankest 755:
1.67 avankest 756: <li>
757: <p>The user agent <em class="ct">must</em> then synchronously
758: dispatch a <code>readystatechange</code> event on the object.</p>
759:
1.71 avankest 760: <p class="note">The state of the object doesn't actually change as the
1.67 avankest 761: event is dispatched for historical reasons.</p>
762: </li>
763:
1.58 avankest 764: <li><p>If <var>async</var> is <code>true</code> the user agent
765: <em class="ct">must</em> set the <dfn><code>send()</code> flag</dfn>,
766: directly unset it when the state changes and return the
767: <code>send()</code> method call. (Don't abort the steps in the algorithm
768: though.)</p></li>
769:
770: <li><p>If the request has been successfully acknowledged switch the
771: state to <span title="SENT state">SENT</span>; the user agent
772: <em class="ct">must</em> then synchronously dispatch a
773: <code>readystatechange</code> event on the object.</p></li>
1.67 avankest 774: <!-- IE does this regardless of the async value -->
1.58 avankest 775:
776: <li><p>If all HTTP headers have been receieved, immediately before
777: receiving the message body (if any), switch the state to
778: <span title="RECEIVING state">RECEIVING</span>; the user agent
779: <em class="ct">must</em> then synchronously dispatch a
780: <code>readystatechange</code> event on the object.</p></li>
1.67 avankest 781: <!-- IE does this regardless of the async value -->
1.58 avankest 782:
783: <li>
784: <p>If the response is an HTTP redirect (status code <code>301</code>,
785: <code>302</code>, <code>303</code> or <code>307</code>), then it
786: <em class="ct">must</em> be transparently followed (unless it violates
787: security, infinite loop precautions or the scheme isn't supported).</p>
1.60 avankest 788:
1.58 avankest 789: <p class="note">HTTP places requirements on the user agent regarding the
790: preservation of the request method and entity body during redirects, and
791: also requires users to be notified of certain kinds of automatic
792: redirections.</p>
793: <!-- Arguably HTTP should be fixed for the latter case. No browser
794: follows that as far as I know. -->
795: </li>
1.60 avankest 796:
1.58 avankest 797: <li>
798: <p>If something goes wrong (infinite loop, network errors) the user
799: agent <em class="ct">must</em> follow the following set of steps:</p>
1.60 avankest 800:
1.58 avankest 801: <ol>
802: <li><p>Set <code>responseText</code>, <code>responseXML</code>,
803: <code>status</code> and <code>statusText</code> to their initial
804: values and reset the list of request headers.</p></li>
1.60 avankest 805:
1.58 avankest 806: <li><p>Switch the state to
807: <span title="LOADED state">LOADED</span>.</p></li>
1.60 avankest 808:
1.58 avankest 809: <li><p>If <var>async</var> is set to <code>false</code> the user agent
810: <em class="ct">must</em> raise a <code>NETWORK_ERR</code> exception.
811: (Don't abort these steps.)</p></li>
1.60 avankest 812:
1.58 avankest 813: <li><p>Synchronously dispatch a <code>readystatechange</code> event on
814: the object.</p></li>
1.60 avankest 815:
1.58 avankest 816: <li><p>Abort the overall algorithm.</p></li>
817: </ol>
1.60 avankest 818:
1.58 avankest 819: <p class="note">In future versions of this specification the user agent
820: will be required to dispatch an <code>error</code> event if the above
821: occurs.</p>
822: </li>
823:
824: <li><p>When the request has successfully completed loading, switch the
825: state to <span title="LOADED state">LOADED</span>; the user agent
826: <em class="ct">must</em> then synchronously dispatch a
827: <code>readystatechange</code> event on the object and abort these
828: steps (and return the method call in case of <var>async</var> being
829: <code>false</code>).</p></li>
830: </ol>
1.14 avankest 831:
1.8 avankest 832: <p>If the user agent allows the specification of a proxy it
1.22 avankest 833: <em class="ct">should</em> modify the request appropriately;
1.42 avankest 834: <abbr title="in other words">i.e.</abbr>, connect to the proxy host
835: instead of the origin server, modify the <code>Request-Line</code> and
836: send <code>Proxy-Authorization</code> headers as specified.</p>
1.12 avankest 837:
1.42 avankest 838: <p>If the user agent supports HTTP Authentication it
1.22 avankest 839: <em class="ct">should</em> consider requests originating from this object
1.42 avankest 840: to be part of the protection space that includes the accessed URIs and
841: send <code>Authorization</code> headers and handle <code>401
1.72 avankest 842: Unauthorised</code> requests appropriately. If authentication fails, user
1.42 avankest 843: agents <em class="ct">should</em> prompt the users for credentials.
844: [<cite><span>RFC2617</span></cite>]</p>
845:
1.57 avankest 846: <p>If the user agent supports HTTP State Management it
1.42 avankest 847: <em class="ct">should</em> persist, discard and send cookies (as received
848: in the <code>Set-Cookie</code> and <code>Set-Cookie2</code> response
849: headers, and sent in the <code>Cookie</code> header) as applicable.
850: [<cite><span>RFC2965</span></cite>]</p>
851:
852: <p>If the user agent implements a HTTP cache it <em class="ct">should</em>
853: respect <code>Cache-Control</code> request headers set by the script
854: (<abbr title="for example">e.g.</abbr>, <code>Cache-Control:
855: no-cache</code> bypasses the cache). It <em class="ct">must not</em> send
856: <code>Cache-Control</code> or <code>Pragma</code> request headers
857: automatically unless the user explicitly requests such behaviour
858: (<abbr>e.g.</abbr>, by (force-)reloading the page). <code>304 Not
1.22 avankest 859: Modified</code> responses that are a result of a user agent generated
860: conditional request <em class="ct">must</em> be presented as <code>200
1.57 avankest 861: OK</code> responses with the appropriate content. The user agent
1.39 avankest 862: <em class="ct">must</em> allow scripts to override automatic cache
1.22 avankest 863: validation by setting request headers (e.g., <code>If-None-Match</code>,
1.42 avankest 864: <code>If-Modified-Since</code>), in which case <code>304 Not
865: Modified</code> responses <em class="ct">must</em> be passed through.
866: [<cite><span>RFC2616</span></cite>]</p>
1.12 avankest 867:
1.8 avankest 868: <p>If the user agent implements server-driven content-negotiation
1.42 avankest 869: it <em class="ct">should</em> set <code>Accept-Language</code>,
1.22 avankest 870: <code>Accept-Encoding</code> and <code>Accept-Charset</code> headers as
871: appropriate; it <em class="ct">must not</em> automatically set the
872: <code>Accept</code> header. Responses to such requests
1.40 avankest 873: <em class="ct">must</em> have the content-codings automatically
1.42 avankest 874: decoded. [<cite><span>RFC2616</span></cite>]</p>
1.8 avankest 875: </dd>
1.12 avankest 876:
1.14 avankest 877: <dt><dfn id="dfn-abort"><code>abort()</code></dfn>, method</dt>
1.12 avankest 878:
1.5 avankest 879: <dd>
1.60 avankest 880: <p>When invoked, the user agent <em class="ct">must</em> run the following
881: steps:</p>
882:
883: <ol>
884: <li><p>Set the <code>responseText</code>, <code>responseXML</code>,
885: <code>status</code> and <code>responseText</code> attributes to their
886: initial value as well as removing any registered request
887: headers.</p></li>
888:
889: <li><p>Any network activity for which the object responsible
890: <em class="ct">should</em> be cancelled.</p></li>
891:
1.67 avankest 892: <li>Switch the state to <span title="LOADED state">LOADED</span>; the
893: user agent <em class="ct">must</em> then synchronously dispatch a
894: <code>readystatechange</code> event on the object.</li>
895:
1.60 avankest 896: <li>
1.71 avankest 897: <p>Switch the state to <span title="UNSENT state">UNSENT</span>. (Don't
898: dispatch the <code>readystatechange</code> event.)</p>
1.60 avankest 899:
900: <p class="note">It's likely that a future version of the
901: <code>XMLHttpRequest</code> will dispatch an <code title="">abort</code>
902: event here.</p>
903: </li>
904: </ol>
1.5 avankest 905: </dd>
1.12 avankest 906:
1.14 avankest 907: <dt><dfn id="dfn-getallresponseheaders"><code>getAllResponseHeaders()</code></dfn>,
1.22 avankest 908: method</dt>
1.12 avankest 909:
1.5 avankest 910: <dd>
1.60 avankest 911: <p>When invoked, the user agent <em class="ct">must</em> run
1.58 avankest 912: the following steps:</p>
913:
914: <ol>
1.76 avankest 915: <li><p>If the state is not <span title="RECEIVING state">RECEIVING</span>
916: or <span title="LOADED state">LOADED</span> the user agent
1.58 avankest 917: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1.76 avankest 918: exception and abort these steps.</p></li>
1.58 avankest 919:
1.76 avankest 920: <li><p>The user agent <em class="ct">must</em> return all the HTTP
921: headers, as a single string, with each header line separated by a U+000D
922: CR U+000A LF pair excluding the status line.</p></li>
1.58 avankest 923: </ol>
1.24 avankest 924:
1.5 avankest 925: <div class="example">
1.58 avankest 926: <pre><code>// The following script:
1.5 avankest 927: var client = new XMLHttpRequest();
1.14 avankest 928: client.open("GET", "test.txt", true);
1.5 avankest 929: client.send();
1.12 avankest 930: client.onreadystatechange = function() {
1.13 avankest 931: if(this.readyState == 3) {
1.12 avankest 932: print(this.getAllResponseHeaders());
933: }
934: }
1.5 avankest 935:
936: // ...should output something similar to the following text:
937: Date: 2004年10月24日 04:58:38 GMT
938: Server: Apache/1.3.31 (Unix)
939: Keep-Alive: timeout=15, max=99
940: Connection: Keep-Alive
941: Transfer-Encoding: chunked
1.58 avankest 942: Content-Type: text/plain; charset=utf-8</code></pre>
1.5 avankest 943: </div>
944: </dd>
1.12 avankest 945:
1.18 avankest 946: <dt><dfn id="dfn-getresponseheader" title="getresponseheader"><code>getResponseHeader(<var>header</var>)</code></dfn>,
1.22 avankest 947: method</dt>
1.12 avankest 948:
1.1 avankest 949: <dd>
1.58 avankest 950: <p>When the method is invoked, the user agent <em class="ct">must</em> run
951: the following steps:</p>
1.14 avankest 952:
1.58 avankest 953: <ol>
1.76 avankest 954: <li><p>If the state is not <span title="RECEIVING state">RECEIVING</span>
955: or <span title="LOADED state">LOADED</span> the user agent
1.58 avankest 956: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1.76 avankest 957: exception and abort these steps.</p></li>
1.58 avankest 958:
1.76 avankest 959: <li><p>If the <var>header</var> argument doesn't match the
1.58 avankest 960: <span><code>field-name</code> production</span> the user agent
961: <em class="ct">must</em> raise a <code>SYNTAX_ERR</code> exception and
1.76 avankest 962: abort these steps.</p></li>
1.58 avankest 963:
1.76 avankest 964: <li><p>If the <var>header</var> argument case-insensitively matches
965: multiple HTTP headers for the last request sent the user agent
1.58 avankest 966: <em class="ct">must</em> return the values of these headers as a single
1.77 avankest 967: concatenated string separated from each other by an U+002C COMMA followed
1.76 avankest 968: by an U+0020 SPACE and abort these steps.</p></li>
1.58 avankest 969:
1.76 avankest 970: <li><p>If the <var>header</var> argument case-insensitively matches a
971: single HTTP header for the last request sent the user agent
1.58 avankest 972: <em class="ct">must</em> return the value of that header and abort these
1.76 avankest 973: steps.</p></li>
1.58 avankest 974:
1.76 avankest 975: <li><p>The method <em class="ct">must</em> return
976: <code>null</code>.</p></li>
1.58 avankest 977: </ol>
1.12 avankest 978:
1.1 avankest 979: <div class="example">
1.58 avankest 980: <pre><code>// The following script:
1.1 avankest 981: var client = new XMLHttpRequest();
1.14 avankest 982: client.open("GET", "test.txt", true);
1.5 avankest 983: client.send();
1.12 avankest 984: client.onreadystatechange = function() {
1.13 avankest 985: if(this.readyState == 3) {
1.14 avankest 986: print(client.getResponseHeader("Content-Type"));
1.12 avankest 987: }
988: }
1.1 avankest 989:
1.5 avankest 990: // ...should output something similar to the following text:
1.58 avankest 991: Content-Type: text/plain; charset=utf-8</code></pre>
1.1 avankest 992: </div>
1.5 avankest 993: </dd>
1.12 avankest 994:
1.5 avankest 995: <dt><dfn id="dfn-responsetext"><code>responseText</code></dfn> of type
1.22 avankest 996: <code>DOMString</code>, readonly</dt>
1.12 avankest 997:
1.5 avankest 998: <dd>
1.63 avankest 999: <p>If the state is not <span title="RECEIVING state">RECEIVING</span> or
1000: <span title="LOADED state">LOADED</span>, the user agent
1.40 avankest 1001: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1002: exception. Otherwise, if there's no <span>entity body</span> this
1003: attribute <em class="ct">must</em> be <code>null</code>. If there is, it
1004: <em class="ct">must</em> be the fragment of the <span>entity body</span>
1005: received so far (when the state is
1.63 avankest 1006: <span title="RECEIVING state">RECEIVING</span>) or the complete
1.40 avankest 1007: <span>entity body</span> (when the state is
1.63 avankest 1008: <span title="LOADED state">LOADED</span>), interpreted as a stream of
1.40 avankest 1009: characters.</p>
1.12 avankest 1010:
1.50 avankest 1011: <p>If the response includes a MIME type understood by the user agent the
1012: characters <em class="ct">must</em> be decoded following the relevant MIME
1013: type specification. If the user agent cannot derive a character stream in
1014: accord with the media type specification, <code>responseText</code>
1015: <em class="ct">must</em> be <code>null</code>.</p>
1.12 avankest 1016:
1.40 avankest 1017: <p>Its initial value <em class="ct">must</em> be the
1018: <code>null</code>.</p>
1.5 avankest 1019: </dd>
1.12 avankest 1020:
1.5 avankest 1021: <dt><dfn id="dfn-responsexml"><code>responseXML</code></dfn> of type
1.22 avankest 1022: <code>Document</code>, readonly</dt>
1.12 avankest 1023:
1.8 avankest 1024: <dd>
1.75 avankest 1025: <p>On getting, the user agent <em class="ct">must</em> run the following
1026: steps:</p>
1027:
1028: <ol>
1029: <li><p>If the state is not <span title="LOADED state">LOADED</span> the
1030: user agent <em class="ct">must</em> raise an
1031: <code>INVALID_STATE_ERR</code> exception and abort these steps.</p></li>
1032:
1033: <li><p>If there's no <span>entity body</span> the user agent
1034: <em class="ct">must</em> return <code>null</code> and abort these
1035: steps.</p></li>
1036:
1037: <li><p>If there is no <code>Content-Type</code> header the user agent
1038: <em class="ct">must</em> return <code>null</code> and abort these
1039: steps.</p></li>
1040:
1041: <li><p>If the <code>Content-Type</code> header does not contain a media
1042: type (ignoring any parameters) that is <code>text/xml</code>,
1043: <code>application/xml</code> or ends in <code title="">+xml</code> the
1044: user agent <em class="ct">must</em> return <code>null</code> and abort
1045: these steps.</p></li>
1046:
1047: <li><p>If the <span>entity body</span> can not be parsed into a namespace
1048: well-formed XML document the user agent <em class="ct">must</em> return
1.77 avankest 1049: <code>null</code> and abort these steps. [<cite><span>XML</span></cite>]
1050: [<cite><span>XMLNS</span></cite>]</p></li>
1.75 avankest 1051:
1052: <li><p>The user agent <em class="ct">must</em> return an object
1053: implementing the <code>Document</code> interface representing the parsed
1054: document.</p></li>
1055: </ol>
1.5 avankest 1056: </dd>
1.12 avankest 1057:
1.22 avankest 1058: <dt><dfn id="dfn-status"><code>status</code></dfn> of type <code>unsigned
1059: short</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 code sent by the server (typically <code>200</code> for a
1064: successful request). Otherwise, if not available, the user agent
1065: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1066: exception.</p>
1.12 avankest 1067: </dd>
1068:
1.5 avankest 1069: <dt><dfn id="dfn-statustext"><code>statusText</code></dfn> of type
1.22 avankest 1070: <code>DOMString</code>, readonly</dt>
1.12 avankest 1071:
1.5 avankest 1072: <dd>
1.72 avankest 1073: <p>On getting, if available, it <em class="ct">must</em> return the HTTP
1074: status text sent by the server (appears after the status code). Otherwise,
1075: if not available, the user agent <em class="ct">must</em> raise an
1076: <code>INVALID_STATE_ERR</code> exception.</p>
1.1 avankest 1077: </dd>
1078: </dl>
1.12 avankest 1079:
1.31 avankest 1080: <h3 id="events">Events for the <code title="">XMLHttpRequest</code>
1081: Object</h3>
1.12 avankest 1082:
1.1 avankest 1083: <p>These sections describe the various events that can be dispatched on the
1.22 avankest 1084: object implementing the <code>XMLHttpRequest</code> interface. For this
1085: version of the specification only one event is defined.</p>
1.12 avankest 1086:
1.1 avankest 1087: <dl>
1088: <dt><dfn id="dfn-readystatechange"><code>readystatechange</code></dfn></dt>
1.24 avankest 1089:
1.72 avankest 1090: <dd>When the user agent dispatches a <code title="">readystatechange</code>
1091: event (as indicated above) it <em class="ct">must not</em> bubble,
1092: <em class="ct">must not</em> be cancelable and <em class="ct">must</em>
1093: implement the <code>Event</code> interface. Its <code>namespaceURI</code>
1094: attribute <em class="ct">must</em> be <code>null</code>.
1095: [<cite><span>DOM3Events</span></cite>]</dd>
1.1 avankest 1096: </dl>
1.32 avankest 1097:
1.31 avankest 1098: <h3 id="exceptions">Exceptions for the <code title="">XMLHttpRequest</code>
1099: Object</h3>
1100:
1.32 avankest 1101: <pre class="idl">exception <dfn>XMLHttpRequestException</dfn> {
1.31 avankest 1102: unsigned short code;
1103: };
1104: const unsigned short <span>NETWORK_ERR</span> = 101;</pre>
1105:
1.33 avankest 1106: <p>The <dfn id="network-err"><code>NETWORK_ERR</code></dfn> exception is
1107: thrown when a network error occurs in synchronous requests. See the section
1108: on <code>send()</code> for more details.</p>
1.11 avankest 1109:
1.29 avankest 1110: <h2 class="no-num" id="notcovered">Not in this Specification</h2>
1111:
1112: <p><em>This section is non normative.</em></p>
1113:
1.72 avankest 1114: <p>This specification does not include the following features which are
1115: being considered for a future version of this specification:</p>
1.29 avankest 1116:
1117: <ul>
1118: <li><code>load</code> event and <code>onload</code> attribute;</li>
1119: <li><code>error</code> event and <code>onerror</code> attribute;</li>
1120: <li><code>progress</code> event and <code>onprogress</code> attribute;</li>
1121: <li><code title="">abort</code> event and <code>onabort</code> attribute;</li>
1122: <li>Timers have been suggested, perhaps an <code>ontimeout</code>
1123: attribute;</li>
1124: <li>Property to disable following redirects;</li>
1.30 avankest 1125: <li><code title="">responseXML</code> for <code>text/html</code>
1126: documents;</li>
1.40 avankest 1127: <li>Cross-site <code title="">XMLHttpRequest</code>;</li>
1128: <li>Deal with byte streams;</li>
1129: <li><code>getRequestHeader</code> and
1130: <code>removeRequestHeader</code>.</li>
1.29 avankest 1131: </ul>
1132:
1.1 avankest 1133: <h2 class="no-num" id="bibref">References</h2>
1.11 avankest 1134:
1.6 avankest 1135: <dl>
1.37 avankest 1136: <dt>[<dfn id="DOM3">DOM3Core</dfn>]</dt>
1.24 avankest 1137:
1.11 avankest 1138: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-3-Core">Document Object
1139: Model (DOM) Level 3 Core Specification</a></cite>, A. Le Hors, P. Le
1140: Hégaret, L. Wood, G. Nicol, J. Robie, M. Champion, S. Byrne, editors.
1141: World Wide Web Consortium, April 2004.</dd>
1142:
1.37 avankest 1143: <dt>[<dfn id="DOM3EV">DOM3Events</dfn>]</dt>
1.24 avankest 1144:
1.1 avankest 1145: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-3-Events/">Document Object
1.11 avankest 1146: Model (DOM) Level 3 Events Specification</a></cite>, Björn Höhrmann, editor.
1147: World Wide Web Consortium, April 2006.</dd>
1148:
1.37 avankest 1149: <dt>[<dfn id="ref-ecmascript">ECMAScript</dfn>]</dt>
1.24 avankest 1150:
1.14 avankest 1151: <dd><cite><a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript
1152: Language Specification</a></cite>, Third Edition. ECMA, December 1999.</dd>
1153:
1.37 avankest 1154: <dt>[<dfn id="ref-rfc2046">RFC2046</dfn>]</dt>
1.24 avankest 1155:
1.19 avankest 1156: <dd><cite><a href="http://ietf.org/rfc/rfc2046">Multipurpose Internet Mail
1157: Extensions (MIME) Part Two: Media Types</a></cite>, N. Freed, N. Borenstein,
1158: editors. IETF, November 1996.</dd>
1.14 avankest 1159:
1.37 avankest 1160: <dt>[<dfn id="RFC2119">RFC2119</dfn>]</dt>
1.24 avankest 1161:
1.11 avankest 1162: <dd><cite><a href="http://ietf.org/rfc/rfc2119">RFC 2119: Key words
1163: for use in RFCs to Indicate Requirement Levels</a></cite>, S. Bradner.
1164: IETF, March 1997.</dd>
1.12 avankest 1165:
1.37 avankest 1166: <dt>[<dfn id="RFC2616">RFC2616</dfn>]</dt>
1.24 avankest 1167:
1.11 avankest 1168: <dd><cite><a href="http://ietf.org/rfc/rfc2616">Hypertext Transfer Protocol
1169: -- HTTP/1.1</a></cite>, R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L.
1170: Masinter, P. Leach, T. Berners-Lee, editors. IETF, June 1999</dd>
1.12 avankest 1171:
1.37 avankest 1172: <dt>[<dfn id="ref-rfc2617">RFC2617</dfn>]</dt>
1.24 avankest 1173:
1.11 avankest 1174: <dd><cite><a href="http://ietf.org/rfc/rfc2617">HTTP Authentication: Basic
1.14 avankest 1175: and Digest Access Authentication</a></cite>, ...</dd>
1.12 avankest 1176:
1.37 avankest 1177: <dt>[<dfn id="ref-rfc2965">RFC2965</dfn>]</dt>
1.24 avankest 1178:
1.19 avankest 1179: <dd><cite><a href="http://ietf.org/rfc/rfc2965">HTTP State Management
1180: Mechanism</a></cite>, D. Kristol, L. Montulli, editors. IETF, October
1181: 2000.</dd>
1182:
1.37 avankest 1183: <dt>[<dfn id="ref-rfc3986">RFC3986</dfn>]</dt>
1.24 avankest 1184:
1.11 avankest 1185: <dd><cite><a href="http://ietf.org/rfc/rfc3986">Uniform Resource Identifier
1186: (URI): Generic Syntax</a></cite>, T. Berners-Lee, R. Fielding, L. Masinter,
1187: editors. IETF, January 2005.</dd>
1.28 avankest 1188:
1.37 avankest 1189: <dt>[<dfn id="ref-window">Window</dfn>]</dt>
1.28 avankest 1190:
1191: <dd><cite><a href="http://www.w3.org/TR/Window/">Window Object
1192: 1.0</a></cite>, I. Davis, M. Stachowiak, editors. W3C, April 2006.</dd>
1.41 avankest 1193:
1194: <dt>[<dfn id="ref-xml">XML</dfn>]</dt>
1195:
1196: <dd><cite><a href="http://www.w3.org/TR/xml/">Extensible
1197: Markup Language (XML) 1.0 (Fourth Edition)</a></cite>, T. Bray, J. Paoli,
1198: C. Sperberg-McQueen, E. Maler, F. Yergeau. W3C, September 2006.</dd>
1199:
1200: <dt>[<dfn id="ref-xmlns">XMLNS</dfn>]</dt>
1201:
1202: <dd><cite><a href="http://www.w3.org/TR/xml-names/">Namespaces in
1203: XML (Second Edition)</a></cite>, T. Bray, D. Hollander, A. Layman, R.
1204: Tobin. W3C, August 2006.</dd>
1.1 avankest 1205: </dl>
1.11 avankest 1206:
1.1 avankest 1207: <h2 class="no-num" id="acknowledgements">Acknowledgements</h2>
1.11 avankest 1208:
1.1 avankest 1209: <p><em>This section is non-normative</em></p>
1.12 avankest 1210:
1.7 avankest 1211: <p>The editor would like to thank to the following people who have contributed
1.33 avankest 1212: to this specification (ordered by first name):</p>
1.12 avankest 1213:
1.1 avankest 1214: <ul>
1.22 avankest 1215: <li>Alex Hopmann</li>
1.7 avankest 1216: <li>Alex Vincent</li>
1.15 avankest 1217: <li>Alexey Proskuryakov</li>
1.1 avankest 1218: <li>Asbjørn Ulsberg</li>
1219: <li>Boris Zbarsky</li>
1220: <li>Björn Höhrmann</li>
1221: <li>Cameron McCormack</li>
1222: <li>Christophe Jolif</li>
1223: <li>Charles McCathieNevile</li>
1.54 avankest 1224: <li>Dan Winship</li>
1.72 avankest 1225: <li>David Håsäther</li>
1.1 avankest 1226: <li>Dean Jackson</li>
1227: <li>Doug Schepers</li>
1228: <li>Douglas Livingstone</li>
1229: <li>Gorm Haug Eriksen</li>
1230: <li>Hallvord R. M. Steen</li>
1231: <li>Håkon Wium Lie</li>
1232: <li>Ian Davis</li>
1233: <li>Ian Hickson</li>
1234: <li>Ivan Herman</li>
1235: <li>Jens Lindström</li>
1236: <li>Jim Deegan</li>
1237: <li>Jim Ley</li>
1238: <li>Jonas Sicking</li>
1239: <li>Julian Reschke</li>
1240: <li>Karl Dubost</li>
1241: <li>Maciej Stachowiak</li>
1.7 avankest 1242: <li>Magnus Kristiansen</li>
1.1 avankest 1243: <li>Marc Hadley</li>
1.53 avankest 1244: <li>Marcos Caceres</li>
1.1 avankest 1245: <li>Mark Nottingham</li>
1246: <li>Pawel Glowacki</li>
1247: <li>Robin Berjon</li>
1248: <li>Ruud Steltenpool</li>
1.33 avankest 1249: <li>Simon Pieters</li>
1.1 avankest 1250: </ul>
1.12 avankest 1251:
1.1 avankest 1252: <p>Special thanks to the Microsoft employees who first implemented the
1.22 avankest 1253: <code>XMLHttpRequest</code> interface, which was first widely deployed by the
1254: Windows Internet Explorer browser.</p>
1.12 avankest 1255:
1.54 avankest 1256: <p>Special thanks also to the WHATWG for drafting an initial version of this
1.22 avankest 1257: specification in their Web Applications 1.0 document.</p>
1.12 avankest 1258:
1.1 avankest 1259: <p>Thanks also to all those who have helped to improve this specification by
1.22 avankest 1260: sending suggestions and corrections. (Please, keep bugging us with your
1261: issues!)</p>
1.1 avankest 1262: </body>
1263: </html>
Webmaster