com.google.gwt.xhr.client
Class XMLHttpRequest

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.google.gwt.xhr.client.XMLHttpRequest

public class XMLHttpRequest
extends JavaScriptObject

The native XMLHttpRequest object. Most applications should use the higher- level RequestBuilder class unless they need specific functionality provided by the XMLHttpRequest object.

See Also:

http://www.w3.org/TR/XMLHttpRequest/

Field Summary

static int	DONE The DONE state is the state of the object when either the data transfer has been completed or something went wrong during the transfer (infinite redirects for instance).
static int	HEADERS_RECEIVED The HEADERS_RECEIVED state is the state of the object when all response headers have been received.
static int	LOADING The LOADING state is the state of the object when the response entity body is being received.
static int	OPENED The OPENED state is the state of the object when the open() method has been successfully invoked.
static int	UNSENT When constructed, the XMLHttpRequest object must be in the UNSENT state.

Method Summary

void	abort() Aborts the current request.
void	clearOnReadyStateChange() Clears the ReadyStateChangeHandler.
static XMLHttpRequest	create() Creates an XMLHttpRequest object.
java.lang.String	getAllResponseHeaders() Gets all the HTTP response headers, as a single string.
int	getReadyState() Get's the current ready-state.
java.lang.String	getResponseHeader(java.lang.String header) Gets an HTTP response header.
java.lang.String	getResponseText() Gets the response text.
int	getStatus() Gets the status code.
java.lang.String	getStatusText() Gets the status text.
void	open(java.lang.String httpMethod, java.lang.String url) Opens an asynchronous connection.
void	open(java.lang.String httpMethod, java.lang.String url, java.lang.String user) Opens an asynchronous connection.
void	open(java.lang.String httpMethod, java.lang.String url, java.lang.String user, java.lang.String password) Opens an asynchronous connection.
void	send() Initiates a request with no request data.
void	send(java.lang.String requestData) Initiates a request with data.
void	setOnReadyStateChange(ReadyStateChangeHandler handler) Sets the ReadyStateChangeHandler to be notified when the object's ready-state changes.
void	setRequestHeader(java.lang.String header, java.lang.String value) Sets a request header.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNSENT

public static final int UNSENT

When constructed, the XMLHttpRequest object must be in the UNSENT state.

See Also:

Constant Field Values

OPENED

public static final int OPENED

The OPENED state is the state of the object when the open() method has been successfully invoked. During this state request headers can be set using setRequestHeader() and the request can be made using send().

See Also:

Constant Field Values

HEADERS_RECEIVED

public static final int HEADERS_RECEIVED

The HEADERS_RECEIVED state is the state of the object when all response headers have been received.

See Also:

Constant Field Values

LOADING

public static final int LOADING

The LOADING state is the state of the object when the response entity body is being received.

See Also:

Constant Field Values

DONE

public static final int DONE

The DONE state is the state of the object when either the data transfer has been completed or something went wrong during the transfer (infinite redirects for instance).

See Also:

Constant Field Values

Method Detail

create

public static XMLHttpRequest create()

Creates an XMLHttpRequest object.

Returns:

the created object

abort

public final void abort()

Aborts the current request.

See Also:

http://www.w3.org/TR/XMLHttpRequest/#abort

clearOnReadyStateChange

public final void clearOnReadyStateChange()

Clears the ReadyStateChangeHandler.

See Also:

clearOnReadyStateChange(), http://www.w3.org/TR/XMLHttpRequest/#onreadystatechange

getAllResponseHeaders

public final java.lang.String getAllResponseHeaders()

Gets all the HTTP response headers, as a single string.

Returns:

the response headers.

See Also:

http://www.w3.org/TR/XMLHttpRequest/#getallresponseheaders

getReadyState

public final int getReadyState()

Get's the current ready-state.

Returns:

the ready-state constant

See Also:

http://www.w3.org/TR/XMLHttpRequest/#readystate

getResponseHeader

public final java.lang.String getResponseHeader(java.lang.String header)

Gets an HTTP response header.

Parameters:

header - the response header to be retrieved

Returns:

the header value

See Also:

http://www.w3.org/TR/XMLHttpRequest/#getresponseheader

getResponseText

public final java.lang.String getResponseText()

Gets the response text.

Returns:

the response text

See Also:

http://www.w3.org/TR/XMLHttpRequest/#responsetext

getStatus

public final int getStatus()

Gets the status code.

Returns:

the status code

See Also:

http://www.w3.org/TR/XMLHttpRequest/#status

getStatusText

public final java.lang.String getStatusText()

Gets the status text.

Returns:

the status text

See Also:

http://www.w3.org/TR/XMLHttpRequest/#statustext

open

public final void open(java.lang.String httpMethod,
                       java.lang.String url)

Opens an asynchronous connection.

Parameters:

httpMethod - the HTTP method to use

url - the URL to be opened

See Also:

http://www.w3.org/TR/XMLHttpRequest/#open

open

public final void open(java.lang.String httpMethod,
                       java.lang.String url,
                       java.lang.String user)

Opens an asynchronous connection.

Parameters:

httpMethod - the HTTP method to use

url - the URL to be opened

user - user to use in the URL

See Also:

http://www.w3.org/TR/XMLHttpRequest/#open

open

public final void open(java.lang.String httpMethod,
                       java.lang.String url,
                       java.lang.String user,
                       java.lang.String password)

Opens an asynchronous connection.

Parameters:

httpMethod - the HTTP method to use

url - the URL to be opened

user - user to use in the URL

password - password to use in the URL

See Also:

http://www.w3.org/TR/XMLHttpRequest/#open

send

public final void send()

Initiates a request with no request data. This simply calls send(String) with null as an argument, because the no-argument send() method is unavailable on Firefox.

send

public final void send(java.lang.String requestData)

Initiates a request with data. If there is no data, specify null.

Parameters:

requestData - the data to be sent with the request

See Also:

http://www.w3.org/TR/XMLHttpRequest/#send

setOnReadyStateChange

public final void setOnReadyStateChange(ReadyStateChangeHandler handler)

Sets the ReadyStateChangeHandler to be notified when the object's ready-state changes.

Note: Applications must call clearOnReadyStateChange() when they no longer need this object, to ensure that it is cleaned up properly. Failure to do so will result in memory leaks on some browsers.

Parameters:

handler - the handler to be called when the ready state changes

See Also:

clearOnReadyStateChange(), http://www.w3.org/TR/XMLHttpRequest/#onreadystatechange

setRequestHeader

public final void setRequestHeader(java.lang.String header,
                                   java.lang.String value)

Sets a request header.

Parameters:

header - the header to be set

value - the header's value

See Also:

http://www.w3.org/TR/XMLHttpRequest/#setrequestheader