com.gargoylesoftware.htmlunit.javascript.host

Class XMLHttpRequest

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.XMLHttpRequest

All Implemented Interfaces:

Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class XMLHttpRequest
extends SimpleScriptable

A JavaScript object for a XMLHttpRequest.

Version:

$Revision: 2132 $

Author:

Daniel Gredler, Marc Guillemot, Ahmed Ashour

See Also:

Safari documentation, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATE_COMPLETED All the data has been received; the complete data is available in responseBody and responseText.
static int	STATE_INTERACTIVE Some data has been received.
static int	STATE_LOADED The send() method has been called, but the status and headers are not yet available.
static int	STATE_LOADING The object has been created, but the send() method has not been called.
static int	STATE_UNINITIALIZED The object has been created, but not initialized (the open() method has not been called).

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
XMLHttpRequest() Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	jsConstructor() Javascript constructor.
void	jsxFunction_abort() Cancels the current HTTP request.
String	jsxFunction_getAllResponseHeaders() Returns the labels and values of all the HTTP headers.
String	jsxFunction_getResponseHeader(String headerName) Retrieves the value of an HTTP header from the response body.
void	jsxFunction_open(String method, String url, boolean async, String user, String password) Assigns the destination URL, method and other optional attributes of a pending request.
void	jsxFunction_overrideMimeType(String mimeType) Override the mime type returned by the server (if any).
void	jsxFunction_send(Object content) Sends the specified content to the server in an HTTP request and receives the response.
void	jsxFunction_setRequestHeader(String name, String value) Sets the specified header to the specified value.
org.mozilla.javascript.Function	jsxGet_onreadystatechange() Returns the event handler that fires on every state change.
int	jsxGet_readyState() Returns the current state of the HTTP request.
String	jsxGet_responseText() Returns a string version of the data retrieved from the server.
Object	jsxGet_responseXML() Returns a DOM-compatible document object version of the data retrieved from the server.
int	jsxGet_status() Returns the numeric status returned by the server, such as 404 for "Not Found" or 200 for "OK".
String	jsxGet_statusText() Returns the string message accompanying the status code, such as "Not Found" or "OK".
void	jsxSet_onreadystatechange(org.mozilla.javascript.Function stateChangeHandler) Sets the event handler that fires on every state change.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

get, getBooleanArg, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getIntArg, getLog, getObjectArg, getPrototype, getScriptableFor, getStartingScope, getStringArg, getTransformerScriptableFor, getWindow, getWindow, getWithPreemption, makeScriptableFor, setDomNode, setDomNode, setHtmlElement

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, equivalentValues, get, getAllIds, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, has, has, hasInstance, hasProperty, hasProperty, isConst, isSealed, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STATE_UNINITIALIZED

public static final int STATE_UNINITIALIZED

The object has been created, but not initialized (the open() method has not been called).

See Also:

Constant Field Values

STATE_LOADING

public static final int STATE_LOADING

The object has been created, but the send() method has not been called.

See Also:

Constant Field Values

STATE_LOADED

public static final int STATE_LOADED

The send() method has been called, but the status and headers are not yet available.

See Also:

Constant Field Values

STATE_INTERACTIVE

public static final int STATE_INTERACTIVE

Some data has been received.

See Also:

Constant Field Values

STATE_COMPLETED

public static final int STATE_COMPLETED

All the data has been received; the complete data is available in responseBody and responseText.

See Also:

Constant Field Values

Constructor Detail

XMLHttpRequest

public XMLHttpRequest()

Creates a new instance. JavaScript objects must have a default constructor.

Method Detail

jsConstructor

public void jsConstructor()

Javascript constructor.

jsxGet_onreadystatechange

public org.mozilla.javascript.Function jsxGet_onreadystatechange()

Returns the event handler that fires on every state change.

Returns:

The event handler that fires on every state change.

jsxSet_onreadystatechange

public void jsxSet_onreadystatechange(org.mozilla.javascript.Function stateChangeHandler)

Sets the event handler that fires on every state change.

Parameters:

stateChangeHandler - The event handler that fires on every state change.

jsxGet_readyState

public int jsxGet_readyState()

Returns the current state of the HTTP request. The possible values are:

• 0 = uninitialized
• 1 = loading
• 2 = loaded
• 3 = interactive
• 4 = complete

Returns:

The current state of the HTTP request.

jsxGet_responseText

public String jsxGet_responseText()

Returns a string version of the data retrieved from the server.

Returns:

A string version of the data retrieved from the server.

jsxGet_responseXML

public Object jsxGet_responseXML()

Returns a DOM-compatible document object version of the data retrieved from the server.

Returns:

A DOM-compatible document object version of the data retrieved from the server.

jsxGet_status

public int jsxGet_status()

Returns the numeric status returned by the server, such as 404 for "Not Found" or 200 for "OK".

Returns:

The numeric status returned by the server.

jsxGet_statusText

public String jsxGet_statusText()

Returns the string message accompanying the status code, such as "Not Found" or "OK".

Returns:

The string message accompanying the status code.

jsxFunction_abort

public void jsxFunction_abort()

Cancels the current HTTP request.

jsxFunction_getAllResponseHeaders

public String jsxFunction_getAllResponseHeaders()

Returns the labels and values of all the HTTP headers.

Returns:

The labels and values of all the HTTP headers.

jsxFunction_getResponseHeader

public String jsxFunction_getResponseHeader(String headerName)

Retrieves the value of an HTTP header from the response body.

Parameters:

headerName - The (case-insensitive) name of the header to retrieve.

Returns:

The value of the specified HTTP header.

jsxFunction_open

public void jsxFunction_open(String method,
                    String url,
                    boolean async,
                    String user,
                    String password)

Assigns the destination URL, method and other optional attributes of a pending request.

Parameters:

method - The method to use to send the request to the server (GET, POST, etc).

url - The url to send the request to.

async - Whether or not to send the request to the server asynchronously.

user - If authentication is needed for the specified URL, the username to use to authenticate.

password - If authentication is needed for the specified URL, the password to use to authenticate.

jsxFunction_send

public void jsxFunction_send(Object content)

Sends the specified content to the server in an HTTP request and receives the response.

Parameters:

content - The body of the message being sent with the request.

jsxFunction_setRequestHeader

public void jsxFunction_setRequestHeader(String name,
                                String value)

Sets the specified header to the specified value. The open method must be called before this method, or an error will occur.

Parameters:

name - The name of the header being set.

value - The value of the header being set.

jsxFunction_overrideMimeType

public void jsxFunction_overrideMimeType(String mimeType)

Override the mime type returned by the server (if any). This may be used, for example, to force a stream to be treated and parsed as text/xml, even if the server does not report it as such. This must be done before the send method is invoked.

Parameters:

mimeType - the type used to override that returned by the server (if any)

See Also:

XUL Planet