org.doctester.testbrowser

Class Request

java.lang.Object

org.doctester.testbrowser.Request

public class Request
extends Object

This represents a Request we can pass then to the TestBrowser.

Author:

Raphael A. Bauer

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,File>	filesToUpload
boolean	followRedirects
Map<String,String>	formParameters
Map<String,String>	headers
String	httpRequestType
Object	payload
URI	uri

Method Summary

Methods

Modifier and Type	Method and Description
Request	addFileToUpload(String param, File fileToUpload) Add a file to be sent as multipart form post/put.
Request	addFormParameter(String key, String value) Add an arbitrary form parameter to this request.
Request	addHeader(String key, String value) Add an arbitrary header to this request.
Request	contentTypeApplicationJson() Set the Content-Type header to application/json; charset=utf-8.
Request	contentTypeApplicationXml() Set the Content-Type header to application/xml; charset=utf-8.
static Request	DELETE() Get a request to perform a Http DELETE request via the TestBrowser.
Request	followRedirects(boolean followRedirects) Follow redirects automatically.
Request	formParameters(Map<String,String> formParameters) Set form parameters for this request.
static Request	GET() Get a request to perform a Http GET request via the TestBrowser.
Request	headers(Map<String,String> headers) Set headers for this request.
Request	payload(Object payload) Set the payload for this request.
static Request	POST() Get a request to perform a Http POST request via the TestBrowser.
static Request	PUT() Get a request to perform a Http PUT request via the TestBrowser.
Request	url(URI uri) Set the Uri of this request.
Request	url(Url url) Set the Uri of this request.

Methods inherited from class java.lang.Object

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

Field Detail

httpRequestType

public String httpRequestType

uri

public URI uri

filesToUpload

public Map<String,File> filesToUpload

headers

public Map<String,String> headers

formParameters

public Map<String,String> formParameters

payload

public Object payload

followRedirects

public boolean followRedirects

Method Detail

GET

public static Request GET()

Get a request to perform a Http GET request via the TestBrowser.

Returns:

A request configured for a Http GET request.

POST

public static Request POST()

Get a request to perform a Http POST request via the TestBrowser.

Returns:

A request configured for a Http POST request.

PUT

public static Request PUT()

Get a request to perform a Http PUT request via the TestBrowser.

Returns:

A request configured for a Http PUT request.

DELETE

public static Request DELETE()

Get a request to perform a Http DELETE request via the TestBrowser.

Returns:

A request configured for a DELETE request.

contentTypeApplicationJson

public Request contentTypeApplicationJson()

Set the Content-Type header to application/json; charset=utf-8.

Returns:

This request for joining.

contentTypeApplicationXml

public Request contentTypeApplicationXml()

Set the Content-Type header to application/xml; charset=utf-8.

Returns:

This request for joining.

url

public Request url(Url url)

Set the Uri of this request. Usually you may want to use testServerUrl() from you Doctest and call toUri() at the end...

Parameters:

uri - The Uri of this request.

Returns:

This Request for chaining.

url

public Request url(URI uri)

Set the Uri of this request. Usually you may want to use testServerUrl() from you Doctest and call toUri() at the end...

Parameters:

uri - The Uri of this request.

Returns:

This Request for chaining.

addFileToUpload

public Request addFileToUpload(String param,
                      File fileToUpload)

Add a file to be sent as multipart form post/put. Only makes sense for POST and PUT Http requests.

Parameters:

param - The parameter for this file.

fileToUpload - The file to upload

Returns:

This request for chaining.

addHeader

public Request addHeader(String key,
                String value)

Add an arbitrary header to this request.

Parameters:

key - The header key.

value - The header value.

Returns:

This request for chaining.

headers

public Request headers(Map<String,String> headers)

Set headers for this request. This will wipe out all previously set headers.

Parameters:

headers - A map of header keys and header values to use.

Returns:

This request for chaining.

addFormParameter

public Request addFormParameter(String key,
                       String value)

Add an arbitrary form parameter to this request. Only makes sense for POST or PUT requests.

Parameters:

key - The header key.

value - The header value.

Returns:

This request for chaining.

formParameters

public Request formParameters(Map<String,String> formParameters)

Set form parameters for this request. Only makes sense for POST or PUT requests. Wipes out all previously set formParameters.

Parameters:

formParameters - Map of formParemter keys and values to use.

Returns:

This request for chaining.

payload

public Request payload(Object payload)

Set the payload for this request. String will be just sent as strings. If you set Content-Type json or xml this Object will converted into the appropriate representation. Calling this method multiple times will overwrite the payload.

Parameters:

payload - The payload to use.

Returns:

This request for chaining.

followRedirects

public Request followRedirects(boolean followRedirects)

Follow redirects automatically. Or simply do only one request and stop then.

Parameters:

followRedirects - Whether to follow redirects or no.

Returns:

This request for chaining.