org.springframework.restdocs.operation

Interface OperationRequest

public interface OperationRequest

The request that was sent as part of performing an operation on a RESTful service.

Author:

Andy Wilkinson

See Also:

Operation.getRequest()

Method Summary

Modifier and Type	Method and Description
byte[]	getContent() Returns the content of the request.
java.lang.String	getContentAsString() Returns the content of the request as a String.
java.util.Collection<RequestCookie>	getCookies() Returns the cookies sent with the request.
org.springframework.http.HttpHeaders	getHeaders() Returns the headers that were included in the request.
org.springframework.http.HttpMethod	getMethod() Returns the HTTP method of the request.
Parameters	getParameters() Returns the request's parameters.
java.util.Collection<OperationRequestPart>	getParts() Returns the request's parts, provided that it is a multipart request.
java.net.URI	getUri() Returns the request's URI.

Method Detail

getContent

byte[] getContent()

Returns the content of the request. If the request has no content an empty array is returned.

Returns:

the contents, never null

getContentAsString

java.lang.String getContentAsString()

Returns the content of the request as a String. If the request has no content an empty string is returned. If the request has a Content-Type header that specifies a charset then that charset will be used when converting the contents to a String.

Returns:

the contents as string, never null

getHeaders

org.springframework.http.HttpHeaders getHeaders()

Returns the headers that were included in the request.

Returns:

the headers

getMethod

org.springframework.http.HttpMethod getMethod()

Returns the HTTP method of the request.

Returns:

the HTTP method

getParameters

Parameters getParameters()

Returns the request's parameters. For a GET request, the parameters are derived from the query string. For a POST request, the parameters are derived form the request's body.

Returns:

the parameters

getParts

java.util.Collection<OperationRequestPart> getParts()

Returns the request's parts, provided that it is a multipart request. If not, then an empty Collection is returned.

Returns:

the parts

getUri

java.net.URI getUri()

Returns the request's URI.

Returns:

the URI

getCookies

java.util.Collection<RequestCookie> getCookies()

Returns the cookies sent with the request. If no cookies were sent an empty collection is returned.

Returns:

the cookies, never null

Since:

1.2.0