org.springframework.restdocs.operation

Interface OperationRequest

All Known Implementing Classes:

StandardOperationRequest

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 contents of the request.
HttpHeaders	getHeaders() Returns the headers that were included in the request.
HttpMethod	getMethod() Returns the HTTP method of the request
Parameters	getParameters() Returns the request's parameters.
Collection<OperationRequestPart>	getParts() Returns the request's parts, provided that it is a multipart request.
URI	getUri() Returns the request's URI.

Method Detail

getContent

byte[] getContent()

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

Returns:

the contents, never null

getHeaders

HttpHeaders getHeaders()

Returns the headers that were included in the request.

Returns:

the headers

getMethod

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

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

URI getUri()

Returns the request's URI.

Returns:

the URI