Class DefaultResponseCreator

java.lang.Object

org.springframework.test.web.client.response.DefaultResponseCreator

All Implemented Interfaces:

ResponseCreator

public class DefaultResponseCreator
extends Object
implements ResponseCreator

A ResponseCreator with builder-style methods for adding response details.

Since:

3.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultResponseCreator(int statusCode)	Protected constructor.
protected	DefaultResponseCreator(HttpStatusCode statusCode)	Protected constructor.

Method Summary

Modifier and Type	Method	Description
DefaultResponseCreator	body(byte[] content)	Set the body as a byte array.
DefaultResponseCreator	body(String content)	Set the body as a UTF-8 String.
DefaultResponseCreator	body(String content, Charset charset)	Set the body from a string using the given character set.
DefaultResponseCreator	body(Resource resource)	Set the body from a Resource.
DefaultResponseCreator	contentType(MediaType mediaType)	Set the Content-Type header.
DefaultResponseCreator	cookies(ResponseCookie... cookies)	Add one or more cookies.
DefaultResponseCreator	cookies(MultiValueMap<String, ResponseCookie> multiValueMap)	Copy all cookies from the given MultiValueMap.
ClientHttpResponse	createResponse(@Nullable ClientHttpRequest request)	Create a response for the given request.
DefaultResponseCreator	header(String name, String... headerValues)	Add a response header with one or more values.
DefaultResponseCreator	headers(HttpHeaders headers)	Copy all given headers.
DefaultResponseCreator	location(URI location)	Set the Location header.

Methods inherited from class Object

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

Constructor Details

DefaultResponseCreator

protected DefaultResponseCreator(int statusCode)

Protected constructor. Use static factory methods in MockRestResponseCreators.

Since:

5.3.17

DefaultResponseCreator

protected DefaultResponseCreator(HttpStatusCode statusCode)

Protected constructor. Use static factory methods in MockRestResponseCreators.

Method Details

body

public DefaultResponseCreator body(String content)

Set the body as a UTF-8 String.

body

public DefaultResponseCreator body(String content,
 Charset charset)

Set the body from a string using the given character set.

Since:

6.0

body

public DefaultResponseCreator body(byte[] content)

Set the body as a byte array.

body

public DefaultResponseCreator body(Resource resource)

Set the body from a Resource.

contentType

public DefaultResponseCreator contentType(MediaType mediaType)

Set the Content-Type header.

location

public DefaultResponseCreator location(URI location)

Set the Location header.

header

public DefaultResponseCreator header(String name,
 String... headerValues)

Add a response header with one or more values.

Since:

6.0

headers

public DefaultResponseCreator headers(HttpHeaders headers)

Copy all given headers.

cookies

public DefaultResponseCreator cookies(ResponseCookie... cookies)

Add one or more cookies.

Since:

6.0

cookies

public DefaultResponseCreator cookies(MultiValueMap<String, ResponseCookie> multiValueMap)

Copy all cookies from the given MultiValueMap.

Since:

6.0

createResponse

public ClientHttpResponse createResponse(@Nullable ClientHttpRequest request)
                                  throws IOException

Description copied from interface: ResponseCreator

Create a response for the given request.

Specified by:

createResponse in interface ResponseCreator

Parameters:

request - the request

Throws:

IOException