org.safs.net

Class XMLHttpRequest

java.lang.Object

org.safs.net.XMLHttpRequest

All Implemented Interfaces:

IHttpRequest

Direct Known Subclasses:

WDLibrary.WD_XMLHttpRequest

public abstract class XMLHttpRequest
extends java.lang.Object
implements IHttpRequest

Represents XMLHttpRequest Object, used to execute HTTP Request within web page through javascript.
NOTE: As this is performed by "AJAX XMLHttpRequest", it is probably
not permitted to request an URL of domain other than the Application under test.
AJAX Requests are only possible if port, protocol and domain of sender and receiver are equal.
This means, that the following requests generally won’t work:
Requesting https://foo.bar/target.php from http://foo.bar/source.php
Requesting http://sub.foo.bar from http://foo.bar
Requesting http://foo.bar:5000 from http://foo.bar
If we meet the "cross-domain" problem, we can call HttpRequest.execute(String, String, String, String...) to perform HTTP request.

Author:

Lei Wang

See Also:

HttpRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLHttpRequest.AjaxReadyState The enumeration represents Ajax Ready State Code, such as "0", "1", "2", "3" and "4". The enumeration has a method value(), which can return the "Ready State code" string format. The enumeration has a method text(), which can return the "Ready State text" string format.

Nested classes/interfaces inherited from interface org.safs.net.IHttpRequest

IHttpRequest.HttpCommand, IHttpRequest.HttpHeader, IHttpRequest.HttpResponseStatus, IHttpRequest.Key

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VARIABLE_READY_STATE 'XMLHttpRequest_readyState', used as a javascript global variable 'window.XMLHttpRequest_readyState' to store the ajax's 'readyState' value
static java.lang.String	VARIABLE_RESPONSE_HEADERS 'XMLHttpRequest_responseHeaders', used as a javascript global variable 'window.XMLHttpRequest_responseHeaders' to store the ajax's 'responseHeaders' value
static java.lang.String	VARIABLE_RESPONSE_TEXT 'XMLHttpRequest_responseText', used as a javascript global variable 'window.XMLHttpRequest_responseText' to store the ajax's 'responseText' value
static java.lang.String	VARIABLE_RESPONSE_XML 'XMLHttpRequest_responseXML', used as a javascript global variable 'window.XMLHttpRequest_responseXML' to store the ajax's 'responseXML' value
static java.lang.String	VARIABLE_STATUS 'XMLHttpRequest_status', used as a javascript global variable 'window.XMLHttpRequest_status' to store the ajax's 'status' value
static java.lang.String	VARIABLE_STATUS_TEXT 'XMLHttpRequest_statusText', used as a javascript global variable 'window.XMLHttpRequest_statusText' to store the ajax's 'statusText' value

Constructor Summary

Constructors

Constructor and Description
XMLHttpRequest()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	execute(IHttpRequest.HttpCommand command, java.lang.String url, boolean async) Send a HTTP Request and get the response from the server.
java.util.Map<java.lang.String,java.lang.Object>	execute(IHttpRequest.HttpCommand command, java.lang.String url, boolean async, java.util.Map<java.lang.String,java.lang.String> headers) Send a HTTP Request and get the response from the server.
java.util.Map<java.lang.String,java.lang.Object>	execute(IHttpRequest.HttpCommand command, java.lang.String url, boolean async, java.lang.String data) Send a HTTP Request and get the response from the server.
abstract java.lang.String	getReadyState() After AJAX executing HTTP request, call this method to get the value of Key#READY_STATE.
java.util.Map<java.lang.String,java.lang.Object>	getURL(java.lang.String url) Send a HTTP "GET" Request and get the response from the server synchronously.
java.util.Map<java.lang.String,java.lang.Object>	getURL(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> headers) Send a HTTP "GET" Request and get the response from the server synchronously.
java.util.Map<java.lang.String,java.lang.Object>	postURL(java.lang.String url, boolean async, java.util.Map<java.lang.String,java.lang.String> headers, java.lang.String data) Send a HTTP "POST" Request and get the response from the server.
java.util.Map<java.lang.String,java.lang.Object>	postURL(java.lang.String url, boolean async, java.lang.String data) Send a HTTP "POST" Request and get the response from the server.
java.util.Map<java.lang.String,java.lang.Object>	postURL(java.lang.String url, java.lang.String data) Send a HTTP "POST" Request and get the response from the server synchronously.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.safs.net.IHttpRequest

execute, getHttpStatus, getHttpStatusText, getResponseHeaders, getResponseText, getResponseXml

Field Detail

VARIABLE_READY_STATE

public static final java.lang.String VARIABLE_READY_STATE

'XMLHttpRequest_readyState', used as a javascript global variable 'window.XMLHttpRequest_readyState' to store the ajax's 'readyState' value

VARIABLE_RESPONSE_TEXT

public static final java.lang.String VARIABLE_RESPONSE_TEXT

'XMLHttpRequest_responseText', used as a javascript global variable 'window.XMLHttpRequest_responseText' to store the ajax's 'responseText' value

VARIABLE_RESPONSE_XML

public static final java.lang.String VARIABLE_RESPONSE_XML

'XMLHttpRequest_responseXML', used as a javascript global variable 'window.XMLHttpRequest_responseXML' to store the ajax's 'responseXML' value

VARIABLE_STATUS

public static final java.lang.String VARIABLE_STATUS

'XMLHttpRequest_status', used as a javascript global variable 'window.XMLHttpRequest_status' to store the ajax's 'status' value

VARIABLE_STATUS_TEXT

public static final java.lang.String VARIABLE_STATUS_TEXT

'XMLHttpRequest_statusText', used as a javascript global variable 'window.XMLHttpRequest_statusText' to store the ajax's 'statusText' value

VARIABLE_RESPONSE_HEADERS

public static final java.lang.String VARIABLE_RESPONSE_HEADERS

'XMLHttpRequest_responseHeaders', used as a javascript global variable 'window.XMLHttpRequest_responseHeaders' to store the ajax's 'responseHeaders' value

Constructor Detail

XMLHttpRequest

public XMLHttpRequest()

Method Detail

getURL

public java.util.Map<java.lang.String,java.lang.Object> getURL(java.lang.String url)
                                                        throws SAFSException

Send a HTTP "GET" Request and get the response from the server synchronously.

Parameters:

url - String, the URL to request

Returns:

Map response from the server. For detail, please refer to return result of IHttpRequest.execute(HttpCommand, String, boolean, Map, String)

Throws:

SAFSException

See Also:

#execute(HttpCommand, String, boolean, Map, String)}

getURL

public java.util.Map<java.lang.String,java.lang.Object> getURL(java.lang.String url,
                                                               java.util.Map<java.lang.String,java.lang.String> headers)
                                                        throws SAFSException

Send a HTTP "GET" Request and get the response from the server synchronously.

Parameters:

url - String, the URL to request

headers - Map, pairs of (key,value) to set the headers for the request.

Returns:

Map response from the server. For detail, please refer to return result of IHttpRequest.execute(HttpCommand, String, boolean, Map, String)

Throws:

SAFSException

See Also:

#execute(HttpCommand, String, boolean, Map, String)}

postURL

public java.util.Map<java.lang.String,java.lang.Object> postURL(java.lang.String url,
                                                                java.lang.String data)
                                                         throws SAFSException

Send a HTTP "POST" Request and get the response from the server synchronously.

Parameters:

url - String, the URL to request

data - String, the data to send with the request.

Returns:

Map response from the server. For detail, please refer to return result of IHttpRequest.execute(HttpCommand, String, boolean, Map, String)

Throws:

SAFSException

See Also:

#execute(HttpCommand, String, boolean, Map, String)}

postURL

public java.util.Map<java.lang.String,java.lang.Object> postURL(java.lang.String url,
                                                                boolean async,
                                                                java.lang.String data)
                                                         throws SAFSException

Send a HTTP "POST" Request and get the response from the server.

Parameters:

url - String, the URL to request

async - boolean, if the HTTP request will be executed asynchronously

data - String, the data to send with the request.

Returns:

Map response from the server. For detail, please refer to return result of IHttpRequest.execute(HttpCommand, String, boolean, Map, String)

Throws:

SAFSException

See Also:

#execute(HttpCommand, String, boolean, Map, String)}

postURL

public java.util.Map<java.lang.String,java.lang.Object> postURL(java.lang.String url,
                                                                boolean async,
                                                                java.util.Map<java.lang.String,java.lang.String> headers,
                                                                java.lang.String data)
                                                         throws SAFSException

Send a HTTP "POST" Request and get the response from the server.

Parameters:

url - String, the URL to request

async - boolean, if the HTTP request will be executed asynchronously

headers - Map, pairs of (key,value) to set the headers for the request.

data - String, the data to send with the request.

Returns:

Map response from the server. For detail, please refer to return result of IHttpRequest.execute(HttpCommand, String, boolean, Map, String)

Throws:

SAFSException

See Also:

#execute(HttpCommand, String, boolean, Map, String)}

execute

public java.util.Map<java.lang.String,java.lang.Object> execute(IHttpRequest.HttpCommand command,
                                                                java.lang.String url,
                                                                boolean async)
                                                         throws SAFSException

Send a HTTP Request and get the response from the server.

Parameters:

command - CommandHttp, the method to execute, such as 'GET', 'POST', 'PUT' etc.

url - String, the URL to request

async - boolean, if the HTTP request will be executed asynchronously

Returns:

Map response from the server. For detail, please refer to return result of IHttpRequest.execute(HttpCommand, String, boolean, Map, String)

Throws:

SAFSException

See Also:

#execute(HttpCommand, String, boolean, Map, String)}

execute

public java.util.Map<java.lang.String,java.lang.Object> execute(IHttpRequest.HttpCommand command,
                                                                java.lang.String url,
                                                                boolean async,
                                                                java.util.Map<java.lang.String,java.lang.String> headers)
                                                         throws SAFSException

Send a HTTP Request and get the response from the server.

Parameters:

command - CommandHttp, the method to execute, such as 'GET', 'POST', 'PUT' etc.

url - String, the URL to request

async - boolean, if the HTTP request will be executed asynchronously

headers - Map, pairs of (key,value) to set the headers for the request.

Returns:

Map response from the server. For detail, please refer to return result of IHttpRequest.execute(HttpCommand, String, boolean, Map, String)

Throws:

SAFSException

See Also:

#execute(HttpCommand, String, boolean, Map, String)}

execute

public java.util.Map<java.lang.String,java.lang.Object> execute(IHttpRequest.HttpCommand command,
                                                                java.lang.String url,
                                                                boolean async,
                                                                java.lang.String data)
                                                         throws SAFSException

Send a HTTP Request and get the response from the server.

Parameters:

command - CommandHttp, the method to execute, such as 'GET', 'POST', 'PUT' etc.

url - String, the URL to request

async - boolean, if the HTTP request will be executed asynchronously

data - String, the data to send with the request.

Returns:

Map response from the server. For detail, please refer to return result of IHttpRequest.execute(HttpCommand, String, boolean, Map, String)

Throws:

SAFSException

See Also:

#execute(HttpCommand, String, boolean, Map, String)}

getReadyState

public abstract java.lang.String getReadyState()

After AJAX executing HTTP request, call this method to get the value of Key#READY_STATE. This is more useful for asynchronous execution, as synchronous execution the Map result contains this value.

Returns:

String, the value of Key#READY_STATE.

See Also:

IHttpRequest.execute(HttpCommand, String, boolean, Map, String)