org.safs.net

Interface IHttpRequest

All Known Implementing Classes:

HttpRequest, WDLibrary.WD_XMLHttpRequest, XMLHttpRequest

public interface IHttpRequest

An interface for sending HTTP request and receiving response.
There are 2 implementations:
one is HttpRequest, implemented by HttpURLConnection.
the other is XMLHttpRequest, implemented by javascript AJAX.

Author:

Lei Wang

See Also:

HttpRequest, XMLHttpRequest

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IHttpRequest.HttpCommand The enumeration represents the HTTP request command, such as "GET", "POST", "PUT", "DELETE" etc. The enumeration has a method value(), which can return the string format.
static class	IHttpRequest.HttpHeader The enumeration represents subset of the HTTP header keys The enumeration has a method value(), which can return the string format.
static class	IHttpRequest.HttpResponseStatus The enumeration represents subset of the HTTP request Response Status Code, such as "200", "403", "404", "500" etc. The enumeration has a method value(), which can return the "HTTP status code" string format. The enumeration has a method text(), which can return the "HTTP status text" string format.
static class	IHttpRequest.Key The enumeration represents some of XMLHttpRequest Object Properties, such as "status", "statusText", "responseText" etc.

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) Send a HTTP Request and get the response from the server. Note: If this is performed by "AJAX XMLHttpRequest", it is probable not permitted to request an URL of domain other than the Application under test.
java.lang.String	getHttpStatus() After executing HTTP request, call this method to get the value of IHttpRequest.Key.RESPONSE_STATUS.
java.lang.String	getHttpStatusText() After executing HTTP request, call this method to get the value of IHttpRequest.Key.RESPONSE_STATUS_TEXT.
java.lang.Object	getResponseHeaders() After executing HTTP request, call this method to get the value of IHttpRequest.Key.RESPONSE_HEADERS.
java.lang.String	getResponseText() After executing HTTP request, call this method to get the value of IHttpRequest.Key.RESPONSE_TEXT.
java.lang.Object	getResponseXml() After executing HTTP request, call this method to get the value of IHttpRequest.Key.RESPONSE_XML.

Method Detail

execute

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 SAFSException

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

1. If this is performed by "AJAX XMLHttpRequest", it is probable not permitted to request an URL of domain other than the Application under test.

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()
       getHttpStatus()
       getHttpStatusText()
       getResponseText()
       getResponseXml()
       getResponseHeaders()
 

Throws:

SAFSException - when there are some error occurs.

See Also:

#getReadyState()}

getResponseHeaders

java.lang.Object getResponseHeaders()

After executing HTTP request, call this method to get the value of IHttpRequest.Key.RESPONSE_HEADERS. This is more useful for asynchronous execution; for synchronous execution the Map result contains this value.

Returns:

Object, the value of IHttpRequest.Key.RESPONSE_HEADERS.

See Also:

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

getResponseText

java.lang.String getResponseText()

After executing HTTP request, call this method to get the value of IHttpRequest.Key.RESPONSE_TEXT. This is more useful for asynchronous execution; for synchronous execution the Map result contains this value.

Returns:

String, the value of IHttpRequest.Key.RESPONSE_TEXT.

See Also:

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

getResponseXml

java.lang.Object getResponseXml()

After executing HTTP request, call this method to get the value of IHttpRequest.Key.RESPONSE_XML. This is more useful for asynchronous execution; for synchronous execution the Map result contains this value.

Returns:

Object, the value of IHttpRequest.Key.RESPONSE_XML.

See Also:

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

getHttpStatus

java.lang.String getHttpStatus()

After executing HTTP request, call this method to get the value of IHttpRequest.Key.RESPONSE_STATUS. This is more useful for asynchronous execution; for synchronous execution the Map result contains this value.

Returns:

String, the value of IHttpRequest.Key.RESPONSE_STATUS.

See Also:

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

getHttpStatusText

java.lang.String getHttpStatusText()

After executing HTTP request, call this method to get the value of IHttpRequest.Key.RESPONSE_STATUS_TEXT. This is more useful for asynchronous execution; for synchronous execution the Map result contains this value.

Returns:

String, the value of IHttpRequest.Key.RESPONSE_STATUS_TEXT.

See Also:

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