org.springframework.restdocs.operation

Class StandardOperationRequest

java.lang.Object

org.springframework.restdocs.operation.StandardOperationRequest

All Implemented Interfaces:

OperationRequest

public class StandardOperationRequest
extends Object
implements OperationRequest

Standard implementation of OperationRequest.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
StandardOperationRequest(URI uri, HttpMethod method, byte[] content, HttpHeaders headers, Parameters parameters, Collection<OperationRequestPart> parts) Creates a new request with the given uri and method.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardOperationRequest

public StandardOperationRequest(URI uri,
                                HttpMethod method,
                                byte[] content,
                                HttpHeaders headers,
                                Parameters parameters,
                                Collection<OperationRequestPart> parts)

Creates a new request with the given uri and method. The request will have the given headers, parameters, and parts.

Parameters:

uri - the uri

method - the method

content - the content

headers - the headers

parameters - the parameters

parts - the parts

Method Detail

getContent

public byte[] getContent()

Description copied from interface: OperationRequest

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

Specified by:

getContent in interface OperationRequest

Returns:

the contents, never null

getHeaders

public HttpHeaders getHeaders()

Description copied from interface: OperationRequest

Returns the headers that were included in the request.

Specified by:

getHeaders in interface OperationRequest

Returns:

the headers

getMethod

public HttpMethod getMethod()

Description copied from interface: OperationRequest

Returns the HTTP method of the request

Specified by:

getMethod in interface OperationRequest

Returns:

the HTTP method

getParameters

public Parameters getParameters()

Description copied from interface: OperationRequest

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.

Specified by:

getParameters in interface OperationRequest

Returns:

the parameters

getParts

public Collection<OperationRequestPart> getParts()

Description copied from interface: OperationRequest

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

Specified by:

getParts in interface OperationRequest

Returns:

the parts

getUri

public URI getUri()

Description copied from interface: OperationRequest

Returns the request's URI.

Specified by:

getUri in interface OperationRequest

Returns:

the URI