org.gwtproject.xhr.client

Class XMLHttpRequest

java.lang.Object

org.gwtproject.xhr.client.XMLHttpRequest

@JsType(isNative=true,
        namespace="<global>")
public class XMLHttpRequest
extends Object

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XMLHttpRequest.Function A callback function to map the Javascript function
static class	XMLHttpRequest.ResponseType The type of response expected from the XHR.

Field Summary

Fields

Modifier and Type	Field and Description
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.
XMLHttpRequest.Function	onreadystatechange the onreadystatechange function of the request
static int	OPENED The OPENED state is the state of the object when the open() method has been successfully invoked.
Object	response the response object contains the body of the response
static int	UNSENT When constructed, the XMLHttpRequest object must be in the UNSENT state.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XMLHttpRequest()

Method Summary

Modifier and Type	Method and Description
void	abort() Aborts the current request.
void	clearOnReadyStateChange() Clears the ReadyStateChangeHandler.
static XMLHttpRequest	create() Creates an XMLHttpRequest object.
String	getAllResponseHeaders() Gets all the HTTP response headers, as a single string.
int	getReadyState() Get's the current ready-state.
org.gwtproject.typedarrays.shared.ArrayBuffer	getResponseArrayBuffer() Get the response as an ArrayBuffer.
String	getResponseHeader(String header) Gets an HTTP response header.
String	getResponseText() Gets the response text.
String	getResponseType() Gets the response type.
int	getStatus() Gets the status code.
String	getStatusText() Gets the status text.
void	open(String httpMethod, String url) Opens an asynchronous connection.
void	open(String httpMethod, String url, boolean async) Opens an asynchronous or a synchronous connection.
void	open(String httpMethod, String url, boolean async, String user) Opens an asynchronous or a synchronous connection.
void	open(String httpMethod, String url, boolean async, String user, String password) Opens an asynchronous or a synchronous connection.
void	open(String httpMethod, String url, String user) Opens an asynchronous connection.
void	open(String httpMethod, String url, String user, String password) Opens an asynchronous connection.
void	send() Initiates a request with no request data.
void	send(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(String header, String value) Sets a request header.
void	setResponseType(String responseType) Sets the response type.
void	setResponseType(XMLHttpRequest.ResponseType responseType) Sets the response type.
void	setWithCredentials(boolean withCredentials) Sets withCredentials attribute.

Methods inherited from class java.lang.Object

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

Field Detail

UNSENT

@JsOverlay
public static int UNSENT

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

OPENED

@JsOverlay
public static 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().

HEADERS_RECEIVED

@JsOverlay
public static int HEADERS_RECEIVED

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

LOADING

@JsOverlay
public static int LOADING

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

DONE

@JsOverlay
public 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).

onreadystatechange

public XMLHttpRequest.Function onreadystatechange

the onreadystatechange function of the request

response

public Object response

the response object contains the body of the response

Constructor Detail

XMLHttpRequest

protected XMLHttpRequest()

Method Detail

create

@JsOverlay
public static XMLHttpRequest create()

Creates an XMLHttpRequest object.

Returns:

the created object

abort

public void abort()

Aborts the current request.

See http://www.w3.org/TR/XMLHttpRequest/#the-abort-method.

clearOnReadyStateChange

@JsOverlay
public final void clearOnReadyStateChange()

Clears the ReadyStateChangeHandler.

See http://www.w3.org/TR/XMLHttpRequest/#handler-xhr-onreadystatechange.

See Also:

clearOnReadyStateChange()

getAllResponseHeaders

public final String getAllResponseHeaders()

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

See http://www.w3.org/TR/XMLHttpRequest/#the-getallresponseheaders-method.

Returns:

the response headers.

getReadyState

@JsProperty(name="readyState")
public final int getReadyState()

Get's the current ready-state.

See http://www.w3.org/TR/XMLHttpRequest/#dom-xmlhttprequest-state.

Returns:

the ready-state constant

getResponseArrayBuffer

@JsOverlay
public final org.gwtproject.typedarrays.shared.ArrayBuffer getResponseArrayBuffer()

Get the response as an ArrayBuffer.

Returns:

an ArrayBuffer containing the response, or null if the request is in progress or failed

getResponseHeader

public final String getResponseHeader(String header)

Gets an HTTP response header.

See http://www.w3.org/TR/XMLHttpRequest/#the-getresponseheader-method.

Parameters:

header - the response header to be retrieved

Returns:

the header value

getResponseText

@JsProperty(name="responseText")
public final String getResponseText()

Gets the response text.

See http://www.w3.org/TR/XMLHttpRequest/#the-responsetext-attribute.

Returns:

the response text

getResponseType

@JsProperty(name="responseType")
public final String getResponseType()

Gets the response type.

See http://www.w3.org/TR/XMLHttpRequest/#the-responsetype-attribute

Returns:

the response type

setResponseType

@JsOverlay
public final void setResponseType(XMLHttpRequest.ResponseType responseType)

Sets the response type.

See http://www.w3.org/TR/XMLHttpRequest/#the-responsetype-attribute

Parameters:

responseType - the type of response desired. See XMLHttpRequest.ResponseType for limitations on using the different values

setResponseType

@JsProperty(name="responseType")
public final void setResponseType(String responseType)

Sets the response type.

See http://www.w3.org/TR/XMLHttpRequest/#the-responsetype-attribute

Parameters:

responseType - the type of response desired. See XMLHttpRequest.ResponseType for limitations on using the different values

getStatus

@JsProperty(name="status")
public final int getStatus()

Gets the status code.

See http://www.w3.org/TR/XMLHttpRequest/#the-status-attribute.

Returns:

the status code

getStatusText

@JsProperty(name="statusText")
public final String getStatusText()

Gets the status text.

See http://www.w3.org/TR/XMLHttpRequest/#the-statustext-attribute.

Returns:

the status text

open

@JsOverlay
public final void open(String httpMethod,
                                  String url)

Opens an asynchronous connection.

See http://www.w3.org/TR/XMLHttpRequest/#the-open-method.

Parameters:

httpMethod - the HTTP method to use

url - the URL to be opened

open

@JsOverlay
public final void open(String httpMethod,
                                  String url,
                                  String user)

Opens an asynchronous connection.

See http://www.w3.org/TR/XMLHttpRequest/#the-open-method.

Parameters:

httpMethod - the HTTP method to use

url - the URL to be opened

user - user to use in the URL

open

@JsOverlay
public final void open(String httpMethod,
                                  String url,
                                  String user,
                                  String password)

Opens an asynchronous connection.

See http://www.w3.org/TR/XMLHttpRequest/#the-open-method.

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

open

public final void open(String httpMethod,
                       String url,
                       boolean async)

Opens an asynchronous or a synchronous connection.

See http://www.w3.org/TR/XMLHttpRequest/#the-open-method.

Parameters:

httpMethod - the HTTP method to use

url - the URL to be opened

async - connection is asynchronous when true, otherwise connection is synchronous

open

public final void open(String httpMethod,
                       String url,
                       boolean async,
                       String user)

Opens an asynchronous or a synchronous connection.

See http://www.w3.org/TR/XMLHttpRequest/#the-open-method.

Parameters:

httpMethod - the HTTP method to use

url - the URL to be opened

async - connection is asynchronous when true, otherwise connection is synchronous

user - user to use in the URL

open

public final void open(String httpMethod,
                       String url,
                       boolean async,
                       String user,
                       String password)

Opens an asynchronous or a synchronous connection.

See http://www.w3.org/TR/XMLHttpRequest/#the-open-method.

Parameters:

httpMethod - the HTTP method to use

url - the URL to be opened

async - connection is asynchronous when true, otherwise connection is synchronous

user - user to use in the URL

password - password to use in the URL

send

@JsOverlay
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(String requestData)

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

See http://www.w3.org/TR/XMLHttpRequest/#the-send-method.

Parameters:

requestData - the data to be sent with the request

setOnReadyStateChange

@JsOverlay
public final void setOnReadyStateChange(ReadyStateChangeHandler handler)

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

See http://www.w3.org/TR/XMLHttpRequest/#handler-xhr-onreadystatechange.

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()

setRequestHeader

public final void setRequestHeader(String header,
                                   String value)

Sets a request header.

See http://www.w3.org/TR/XMLHttpRequest/#the-setrequestheader-method.

Parameters:

header - the header to be set

value - the header's value

setWithCredentials

@JsProperty(name="withCredentials")
public final void setWithCredentials(boolean withCredentials)

Sets withCredentials attribute.

See http://www.w3.org/TR/XMLHttpRequest/#the-withcredentials-attribute.

Parameters:

withCredentials - whether to include credentials in XHR