org.springframework.restdocs.util

Class DocumentableHttpServletRequest

java.lang.Object

org.springframework.restdocs.util.DocumentableHttpServletRequest

public class DocumentableHttpServletRequest
extends Object

An HttpServletRequest wrapper that provides a limited set of methods intended to help in the documentation of the request.

Author:

Andy Wilkinson, Jonathan Pearlin

Constructor Summary

Constructors

Constructor and Description
DocumentableHttpServletRequest(MockHttpServletRequest request) Creates a new DocumentableHttpServletRequest to document the given request.

Method Summary

Modifier and Type	Method and Description
String	getContentAsString() Returns a String of the request's content
long	getContentLength() Returns the length of the request's content
String	getContextPath() Returns the request's context path
HttpHeaders	getHeaders() Returns the request's headers.
String	getHost() Returns the name of the host to which the request was sent.
String	getMethod() Returns the request's method.
String	getParameterMapAsQueryString() Returns the request's parameter map formatted as a query string
int	getPort() Returns the port to which the request was sent.
String	getRequestUriWithQueryString() Returns the request's URI including its query string.
String	getScheme() Returns the request's scheme.
boolean	isGetRequest() Whether or not this request is a GET request.
boolean	isPostRequest() Whether or not this request is a POST request.
boolean	isPutRequest() Whether or not this request is a PUT request.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentableHttpServletRequest

public DocumentableHttpServletRequest(MockHttpServletRequest request)

Creates a new DocumentableHttpServletRequest to document the given request.

Parameters:

request - the request that is to be documented

Method Detail

isGetRequest

public boolean isGetRequest()

Whether or not this request is a GET request.

Returns:

true if it is a GET request, otherwise false

See Also:

HttpServletRequest.getMethod()

isPostRequest

public boolean isPostRequest()

Whether or not this request is a POST request.

Returns:

true if it is a POST request, otherwise false

See Also:

HttpServletRequest.getMethod()

isPutRequest

public boolean isPutRequest()

Whether or not this request is a PUT request.

Returns:

true if it is a PUT request, otherwise false

See Also:

HttpServletRequest.getMethod()

getHeaders

public HttpHeaders getHeaders()

Returns the request's headers. The headers are ordered based on the ordering of HttpServletRequest.getHeaderNames() and HttpServletRequest.getHeaders(String).

Returns:

the request's headers

See Also:

HttpServletRequest.getHeaderNames(), HttpServletRequest.getHeaders(String)

getScheme

public String getScheme()

Returns the request's scheme.

Returns:

the request's scheme

See Also:

ServletRequest.getScheme()

getHost

public String getHost()

Returns the name of the host to which the request was sent.

Returns:

the host's name

See Also:

ServletRequest.getServerName()

getPort

public int getPort()

Returns the port to which the request was sent.

Returns:

the port

See Also:

ServletRequest.getServerPort()

getMethod

public String getMethod()

Returns the request's method.

Returns:

the request's method

See Also:

HttpServletRequest.getMethod()

getContentLength

public long getContentLength()

Returns the length of the request's content

Returns:

the content length

See Also:

ServletRequest.getContentLength()

getContentAsString

public String getContentAsString()
                          throws IOException

Returns a String of the request's content

Returns:

the request's content

Throws:

IOException - if the content cannot be read

getRequestUriWithQueryString

public String getRequestUriWithQueryString()

Returns the request's URI including its query string. The query string is determined by calling HttpServletRequest.getQueryString(). If it's null and it is a GET request, the query string is then constructed from the request's ServletRequest.getParameterMap() parameter map.

Returns:

the URI of the request, including its query string

getParameterMapAsQueryString

public String getParameterMapAsQueryString()

Returns the request's parameter map formatted as a query string

Returns:

The query string derived from the request's parameter map

See Also:

ServletRequest.getParameterMap()

getContextPath

public String getContextPath()

Returns the request's context path

Returns:

The context path of the request

See Also:

HttpServletRequest.getContextPath()