org.safs.selenium.webdriver.lib

Class WDLibrary.WD_XMLHttpRequest

java.lang.Object

org.safs.net.XMLHttpRequest

org.safs.selenium.webdriver.lib.WDLibrary.WD_XMLHttpRequest

All Implemented Interfaces:

IHttpRequest

Enclosing class:

WDLibrary

public static class WDLibrary.WD_XMLHttpRequest
extends XMLHttpRequest

Implements XMLHttpRequest, through WDLibrary to execute javascript JavaScriptFunctions.sendHttpRequest(Map) to handle HTTP Request. If the execution is asynchronous, some value of IHttpRequest.Key will be stored in javascript global variables, and they can be retrieved later.

See Also:

XMLHttpRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.net.XMLHttpRequest

XMLHttpRequest.AjaxReadyState

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

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

Field Summary

Fields inherited from class org.safs.net.XMLHttpRequest

VARIABLE_READY_STATE, VARIABLE_RESPONSE_HEADERS, VARIABLE_RESPONSE_TEXT, VARIABLE_RESPONSE_XML, VARIABLE_STATUS, VARIABLE_STATUS_TEXT

Constructor Summary

Constructors

Constructor and Description
WD_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, java.util.Map<java.lang.String,java.lang.String> headers, java.lang.String data) Implementation: through WDLibrary, execute JavaScriptFunctions.sendHttpRequest(Map). For synchronous execution, all results will be stored in the returned Map result with one value of IHttpRequest.Key; For asynchronous execution, except IHttpRequest.Key.READY_STATE, the other values will not be in the returned Map result, they will be stored in javascript global variables:
java.lang.String	getHttpStatus() Get javascript global variable XMLHttpRequest.VARIABLE_STATUS.
java.lang.String	getHttpStatusText() Get javascript global variable XMLHttpRequest.VARIABLE_STATUS_TEXT.
java.lang.String	getReadyState() Get javascript global variable XMLHttpRequest.VARIABLE_READY_STATE.
java.lang.Object	getResponseHeaders() Get javascript global variable XMLHttpRequest.VARIABLE_RESPONSE_HEADERS.
java.lang.String	getResponseText() Get javascript global variable XMLHttpRequest.VARIABLE_RESPONSE_TEXT.
java.lang.Object	getResponseXml() Get javascript global variable XMLHttpRequest.VARIABLE_RESPONSE_XML.

Methods inherited from class org.safs.net.XMLHttpRequest

execute, execute, execute, getURL, getURL, postURL, postURL, postURL

Methods inherited from class java.lang.Object

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

Constructor Detail

WD_XMLHttpRequest

public WD_XMLHttpRequest()

Method Detail

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,
                                                                java.lang.String data)
                                                         throws SeleniumPlusException

Implementation: through WDLibrary, execute JavaScriptFunctions.sendHttpRequest(Map).
For synchronous execution, all results will be stored in the returned Map result with one value of IHttpRequest.Key;
For asynchronous execution, except IHttpRequest.Key.READY_STATE, the other values will not be in the returned Map result, they will be stored in javascript global variables:

   XMLHttpRequest.VARIABLE_STATUS:            HTTP response status number
   XMLHttpRequest.VARIABLE_STATUS_TEXT:       HTTP response status text
   XMLHttpRequest.VARIABLE_RESPONSE_HEADERS:  HTTP response headers
   XMLHttpRequest.VARIABLE_RESPONSE_TEXT:     HTTP response as string
   XMLHttpRequest.VARIABLE_RESPONSE_XML:      HTTP response as XML data
 

Parameters:

command - HttpCommand, 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.

• false, the request execution is synchronous;
  
• true, the request execution is asynchronous, the returned Map may contain nothing.

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
If the execution is synchronous, it may contains key as:

• IHttpRequest.Key.READY_STATE: ready state, changes from 0 to 4, ONLY for AJAX XMLHttpRequest execution.
• IHttpRequest.Key.RESPONSE_STATUS: HTTP response status number
• IHttpRequest.Key.RESPONSE_STATUS_TEXT: HTTP response status text
• IHttpRequest.Key.RESPONSE_HEADERS: HTTP response headers
• IHttpRequest.Key.RESPONSE_TEXT: HTTP response as string
• IHttpRequest.Key.RESPONSE_XML: HTTP response as XML data

If the execution is asynchronous, it contains key as:

   IHttpRequest.Key.READY_STATE: ready state, changes from 0 to 4, ONLY for AJAX XMLHttpRequest execution.
   for other values, they are not in the Map result, we can get them from following methods:
       #getReadyState()
       IHttpRequest.getHttpStatus()
       IHttpRequest.getHttpStatusText()
       IHttpRequest.getResponseText()
       IHttpRequest.getResponseXml()
       IHttpRequest.getResponseHeaders()
 

Throws:

SeleniumPlusException

See Also:

#getReadyState()}

getReadyState

public java.lang.String getReadyState()

Get javascript global variable XMLHttpRequest.VARIABLE_READY_STATE.

Specified by:

getReadyState in class XMLHttpRequest

Returns:

String, the value of Key#READY_STATE.

See Also:

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

getResponseHeaders

public java.lang.Object getResponseHeaders()

Get javascript global variable XMLHttpRequest.VARIABLE_RESPONSE_HEADERS.

Returns:

Object, the value of IHttpRequest.Key.RESPONSE_HEADERS.

See Also:

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

getResponseText

public java.lang.String getResponseText()

Get javascript global variable XMLHttpRequest.VARIABLE_RESPONSE_TEXT.

Returns:

String, the value of IHttpRequest.Key.RESPONSE_TEXT.

See Also:

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

getResponseXml

public java.lang.Object getResponseXml()

Get javascript global variable XMLHttpRequest.VARIABLE_RESPONSE_XML.

Returns:

Object, the value of IHttpRequest.Key.RESPONSE_XML.

See Also:

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

getHttpStatus

public java.lang.String getHttpStatus()

Get javascript global variable XMLHttpRequest.VARIABLE_STATUS.

Returns:

String, the value of IHttpRequest.Key.RESPONSE_STATUS.

See Also:

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

getHttpStatusText

public java.lang.String getHttpStatusText()

Get javascript global variable XMLHttpRequest.VARIABLE_STATUS_TEXT.

Returns:

String, the value of IHttpRequest.Key.RESPONSE_STATUS_TEXT.

See Also:

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