Class XMLHttpRequest

java.lang.Object

org.htmlunit.corejs.javascript.ScriptableObject

org.htmlunit.javascript.HtmlUnitScriptable

org.htmlunit.javascript.host.event.EventTarget

org.htmlunit.javascript.host.xml.XMLHttpRequestEventTarget

org.htmlunit.javascript.host.xml.XMLHttpRequest

All Implemented Interfaces:

Serializable, Cloneable, org.htmlunit.corejs.javascript.ConstProperties, org.htmlunit.corejs.javascript.debug.DebuggableObject, org.htmlunit.corejs.javascript.Scriptable, org.htmlunit.corejs.javascript.SymbolScriptable

public class XMLHttpRequest
extends XMLHttpRequestEventTarget

A JavaScript object for an XMLHttpRequest.

See Also:

• W3C XMLHttpRequest
• Safari documentation
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	XMLHttpRequest.NetworkErrorWebResponse
private static final class	XMLHttpRequest.NoPermittedHeaderException

Nested classes/interfaces inherited from class org.htmlunit.corejs.javascript.ScriptableObject

org.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	aborted_
private static final String[]	ALL_PROPERTIES_
private static final String	ALLOW_ORIGIN_ALL
private boolean	async_
private final boolean	caseSensitiveProperties_
static final int	DONE	All the data has been received; the complete data is available in responseBody and responseText.
static final int	HEADERS_RECEIVED	The send() method has been called, but the status and headers are not yet available.
private boolean	isSameOrigin_
private int	jobID_
static final int	LOADING	Some data has been received.
private static final org.apache.commons.logging.Log	LOG
static final int	OPENED	The object has been created, but the send() method has not been called.
private String	overriddenMimeType_
private static final HashSet<String>	PROHIBITED_HEADERS_
private static final String	RESPONSE_TYPE_ARRAYBUFFER
private static final String	RESPONSE_TYPE_BLOB
private static final String	RESPONSE_TYPE_DEFAULT
private static final String	RESPONSE_TYPE_DOCUMENT
private static final String	RESPONSE_TYPE_JSON
private static final String	RESPONSE_TYPE_TEXT
private String	responseType_
private int	state_
private int	timeout_
static final int	UNSENT	The object has been created, but not initialized (the open() method has not been called).
private WebRequest	webRequest_
private WebResponse	webResponse_
private boolean	withCredentials_

Fields inherited from class org.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
XMLHttpRequest()	Creates a new instance.
XMLHttpRequest(boolean caseSensitiveProperties)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	abort()	Cancels the current HTTP request.
(package private) void	doSend()	The real send job.
private void	fireJavascriptEvent(String eventName)
private void	fireJavascriptEventIgnoreAbort(String eventName)
Object	get(String name, org.htmlunit.corejs.javascript.Scriptable start)	Gets a named property from the object.
String	getAllResponseHeaders()	Returns the labels and values of all the HTTP headers.
org.htmlunit.corejs.javascript.Function	getOnreadystatechange()	Returns the event handler that fires on ready state change.
int	getReadyState()	Returns the current state of the HTTP request.
Object	getResponse()
String	getResponseHeader(String headerName)	Retrieves the value of an HTTP header from the response body.
String	getResponseText()	Returns a string version of the data retrieved from the server.
String	getResponseType()
Object	getResponseXML()	Returns a DOM-compatible document object version of the data retrieved from the server.
int	getStatus()	Returns the numeric status returned by the server, such as 404 for "Not Found" or 200 for "OK".
String	getStatusText()	Returns the string message accompanying the status code, such as "Not Found" or "OK".
int	getTimeout()
XMLHttpRequestUpload	getUpload()	Returns the upload property.
(package private) static boolean	isAuthorizedHeader(String name)	Not all request headers can be set from JavaScript.
private boolean	isPreflight()
private boolean	isPreflightAuthorized(WebResponse preflightResponse)
private static boolean	isPreflightHeader(String name, String value)
private static boolean	isSameOrigin(URL originUrl, URL newUrl)
boolean	isWithCredentials()	Returns the withCredentials property.
void	jsConstructor()	JavaScript constructor.
void	open(String method, Object urlParam, Object asyncParam, Object user, Object password)	Assigns the destination URL, method and other optional attributes of a pending request.
void	overrideMimeType(String mimeType)	Override the mime type returned by the server (if any).
private void	prepareRequestContent(Object content)	Prepares the WebRequest that will be sent.
void	put(String name, org.htmlunit.corejs.javascript.Scriptable start, Object value)
void	send(Object content)	Sends the specified content to the server in an HTTP request and receives the response.
void	setOnreadystatechange(org.htmlunit.corejs.javascript.Function readyStateChangeHandler)	Sets the event handler that fires on ready state change.
void	setRequestHeader(String name, String value)	Sets the specified header to the specified value.
void	setResponseType(String responseType)	Sets the responseType property.
private void	setState(int state)	Sets the state as specified and invokes the state change handler if one has been set.
void	setTimeout(int timeout)
void	setWithCredentials(boolean withCredentials)	Sets the withCredentials property.

Methods inherited from class XMLHttpRequestEventTarget

getOnabort, getOnerror, getOnload, getOnloadend, getOnloadstart, getOnprogress, getOntimeout, setOnabort, setOnerror, setOnload, setOnloadend, setOnloadstart, setOnprogress, setOntimeout

Methods inherited from class EventTarget

addEventListener, clearEventListenersContainer, dispatchEvent, executeEventLocally, fireEvent, getEventHandler, getEventListenersContainer, hasEventHandlers, isEventHandlerOnWindow, removeEventListener, setEventHandler

Methods inherited from class HtmlUnitScriptable

clone, equivalentValues, getBrowserVersion, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, makeScriptableFor, setClassName, setDomNode, setDomNode, setParentScope, setupPromise, setupRejectedPromise

Methods inherited from class org.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class Object

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

Field Details

LOG

private static final org.apache.commons.logging.Log LOG

UNSENT

public static final int UNSENT

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

See Also:

• Constant Field Values

OPENED

public static final int OPENED

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

See Also:

• Constant Field Values

HEADERS_RECEIVED

public static final int HEADERS_RECEIVED

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

See Also:

• Constant Field Values

LOADING

public static final int LOADING

Some data has been received.

See Also:

• Constant Field Values

DONE

public static final int DONE

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

See Also:

• Constant Field Values

RESPONSE_TYPE_DEFAULT

private static final String RESPONSE_TYPE_DEFAULT

See Also:

• Constant Field Values

RESPONSE_TYPE_ARRAYBUFFER

private static final String RESPONSE_TYPE_ARRAYBUFFER

See Also:

• Constant Field Values

RESPONSE_TYPE_BLOB

private static final String RESPONSE_TYPE_BLOB

See Also:

• Constant Field Values

RESPONSE_TYPE_DOCUMENT

private static final String RESPONSE_TYPE_DOCUMENT

See Also:

• Constant Field Values

RESPONSE_TYPE_JSON

private static final String RESPONSE_TYPE_JSON

See Also:

• Constant Field Values

RESPONSE_TYPE_TEXT

private static final String RESPONSE_TYPE_TEXT

See Also:

• Constant Field Values

ALLOW_ORIGIN_ALL

private static final String ALLOW_ORIGIN_ALL

See Also:

• Constant Field Values

ALL_PROPERTIES_

private static final String[] ALL_PROPERTIES_

PROHIBITED_HEADERS_

private static final HashSet<String> PROHIBITED_HEADERS_

state_

private int state_

webRequest_

private WebRequest webRequest_

async_

private boolean async_

jobID_

private int jobID_

webResponse_

private WebResponse webResponse_

overriddenMimeType_

private String overriddenMimeType_

caseSensitiveProperties_

private final boolean caseSensitiveProperties_

withCredentials_

private boolean withCredentials_

isSameOrigin_

private boolean isSameOrigin_

timeout_

private int timeout_

aborted_

private boolean aborted_

responseType_

private String responseType_

Constructor Details

XMLHttpRequest

public XMLHttpRequest()

Creates a new instance.

XMLHttpRequest

public XMLHttpRequest(boolean caseSensitiveProperties)

Creates a new instance.

Parameters:

caseSensitiveProperties - if properties and methods are case sensitive

Method Details

jsConstructor

public void jsConstructor()

JavaScript constructor.

Overrides:

jsConstructor in class XMLHttpRequestEventTarget

setState

private void setState(int state)

Sets the state as specified and invokes the state change handler if one has been set.

Parameters:

state - the new state

fireJavascriptEvent

private void fireJavascriptEvent(String eventName)

fireJavascriptEventIgnoreAbort

private void fireJavascriptEventIgnoreAbort(String eventName)

getReadyState

public int getReadyState()

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

• 0 = unsent
• 1 = opened
• 2 = headers_received
• 3 = loading
• 4 = done

Returns:

the current state of the HTTP request

getResponseType

public String getResponseType()

Returns:

the responseType property

setResponseType

public void setResponseType(String responseType)

Sets the responseType property.

Parameters:

responseType - the responseType property.

getResponse

public Object getResponse()

Returns:

returns the response's body content as an ArrayBuffer, Blob, Document, JavaScript Object, or DOMString, depending on the value of the request's responseType property.

getResponseText

public String getResponseText()

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

Returns:

a string version of the data retrieved from the server

getResponseXML

public Object getResponseXML()

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

getStatus

public int getStatus()

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

getStatusText

public String getStatusText()

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

Returns:

the string message accompanying the status code

abort

public void abort()

Cancels the current HTTP request.

getAllResponseHeaders

public String getAllResponseHeaders()

Returns the labels and values of all the HTTP headers.

Returns:

the labels and values of all the HTTP headers

getResponseHeader

public String 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

open

public void open(String method,
 Object urlParam,
 Object asyncParam,
 Object user,
 Object 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)

urlParam - the URL to send the request to

asyncParam - Whether or not to send the request to the server asynchronously, defaults to true

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

isSameOrigin

private static boolean isSameOrigin(URL originUrl,
 URL newUrl)

send

public void 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

prepareRequestContent

private void prepareRequestContent(Object content)

Prepares the WebRequest that will be sent.

Parameters:

content - the content to send

doSend

void doSend()

The real send job.

isPreflight

private boolean isPreflight()

isPreflightAuthorized

private boolean isPreflightAuthorized(WebResponse preflightResponse)

isPreflightHeader

private static boolean isPreflightHeader(String name,
 String value)

Parameters:

name - header name (MUST be lower-case for performance reasons)

value - header value

setRequestHeader

public void 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

isAuthorizedHeader

static boolean isAuthorizedHeader(String name)

Not all request headers can be set from JavaScript.

Parameters:

name - the header name

Returns:

true if the header can be set from JavaScript

See Also:

• W3C doc

overrideMimeType

public void 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

isWithCredentials

public boolean isWithCredentials()

Returns the withCredentials property.

Returns:

the withCredentials property

setWithCredentials

public void setWithCredentials(boolean withCredentials)

Sets the withCredentials property.

Parameters:

withCredentials - the withCredentials property.

get

public Object get(String name,
 org.htmlunit.corejs.javascript.Scriptable start)

Gets a named property from the object. Normally HtmlUnit objects don't need to overwrite this method as properties are defined on the prototypes from the XML configuration. In some cases where "content" of object has priority compared to the properties consider using utility HtmlUnitScriptable.getWithPreemption(String).

Specified by:

get in interface org.htmlunit.corejs.javascript.Scriptable

Overrides:

get in class HtmlUnitScriptable

put

public void put(String name,
 org.htmlunit.corejs.javascript.Scriptable start,
 Object value)

Specified by:

put in interface org.htmlunit.corejs.javascript.Scriptable

Overrides:

put in class HtmlUnitScriptable

getUpload

public XMLHttpRequestUpload getUpload()

Returns the upload property.

Returns:

the upload property

getOnreadystatechange

public org.htmlunit.corejs.javascript.Function getOnreadystatechange()

Returns the event handler that fires on ready state change.

Overrides:

getOnreadystatechange in class XMLHttpRequestEventTarget

Returns:

the event handler that fires on ready state change

setOnreadystatechange

public void setOnreadystatechange(org.htmlunit.corejs.javascript.Function readyStateChangeHandler)

Sets the event handler that fires on ready state change.

Overrides:

setOnreadystatechange in class XMLHttpRequestEventTarget

Parameters:

readyStateChangeHandler - the event handler that fires on ready state change

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)