Class MockServerRestTemplateCustomizer

java.lang.Object

org.springframework.boot.restclient.test.MockServerRestTemplateCustomizer

All Implemented Interfaces:

RestTemplateCustomizer

public class MockServerRestTemplateCustomizer
extends Object
implements RestTemplateCustomizer

RestTemplateCustomizer that can be applied to a RestTemplateBuilder instances to add MockRestServiceServer support.

Typically applied to an existing builder before it is used, for example:

MockServerRestTemplateCustomizer customizer = new MockServerRestTemplateCustomizer();
MyBean bean = new MyBean(new RestTemplateBuilder(customizer));
customizer.getServer().expect(requestTo("/hello")).andRespond(withSuccess());
bean.makeRestCall();

If the customizer is only used once, the getServer() method can be used to obtain the mock server. If the customizer has been used more than once the getServer(RestTemplate) or getServers() method must be used to access the related server.

If a mock server is used in more than one test case in a test class, it might be necessary to reset the expectations on the server between tests using getServer().reset() or getServer(restTemplate).reset().

Since:

4.0.0

Author:

Phillip Webb, Moritz Halbritter, Chinmoy Chakraborty

See Also:

• getServer()
• getServer(RestTemplate)

Constructor Summary

Constructors

Constructor	Description
MockServerRestTemplateCustomizer()
MockServerRestTemplateCustomizer(Class<? extends RequestExpectationManager> expectationManager)	Create a new MockServerRestTemplateCustomizer instance.
MockServerRestTemplateCustomizer(Supplier<? extends RequestExpectationManager> expectationManagerSupplier)	Create a new MockServerRestTemplateCustomizer instance.

Method Summary

Modifier and Type	Method	Description
protected RequestExpectationManager	createExpectationManager()
void	customize(RestTemplate restTemplate)	Callback to customize a RestTemplate instance.
Map<RestTemplate, RequestExpectationManager>	getExpectationManagers()
MockRestServiceServer	getServer()
@Nullable MockRestServiceServer	getServer(RestTemplate restTemplate)
Map<RestTemplate, MockRestServiceServer>	getServers()
void	setBufferContent(boolean bufferContent)	Set if the BufferingClientHttpRequestFactory wrapper should be used to buffer the input and output streams, and for example, allow multiple reads of the response body.
void	setDetectRootUri(boolean detectRootUri)	Set if root URIs from RootUriRequestExpectationManager should be detected and applied to the MockRestServiceServer.

Methods inherited from class Object

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

Constructor Details

MockServerRestTemplateCustomizer

public MockServerRestTemplateCustomizer()

MockServerRestTemplateCustomizer

public MockServerRestTemplateCustomizer(Class<? extends RequestExpectationManager> expectationManager)

Create a new MockServerRestTemplateCustomizer instance.

Parameters:

expectationManager - the expectation manager class to use

MockServerRestTemplateCustomizer

public MockServerRestTemplateCustomizer(Supplier<? extends RequestExpectationManager> expectationManagerSupplier)

Create a new MockServerRestTemplateCustomizer instance.

Parameters:

expectationManagerSupplier - a supplier that provides the RequestExpectationManager to use

Method Details

setDetectRootUri

public void setDetectRootUri(boolean detectRootUri)

Set if root URIs from RootUriRequestExpectationManager should be detected and applied to the MockRestServiceServer.

Parameters:

detectRootUri - if root URIs should be detected

setBufferContent

public void setBufferContent(boolean bufferContent)

Set if the BufferingClientHttpRequestFactory wrapper should be used to buffer the input and output streams, and for example, allow multiple reads of the response body.

Parameters:

bufferContent - if request and response content should be buffered

customize

public void customize(RestTemplate restTemplate)

Description copied from interface: RestTemplateCustomizer

Callback to customize a RestTemplate instance.

Specified by:

customize in interface RestTemplateCustomizer

Parameters:

restTemplate - the template to customize

createExpectationManager

protected RequestExpectationManager createExpectationManager()

getServer

public MockRestServiceServer getServer()

getExpectationManagers

public Map<RestTemplate, RequestExpectationManager> getExpectationManagers()

getServer

public @Nullable MockRestServiceServer getServer(RestTemplate restTemplate)

getServers

public Map<RestTemplate, MockRestServiceServer> getServers()