Package org.springframework.boot.test.web.client

Class MockServerRestClientCustomizer

java.lang.Object

org.springframework.boot.test.web.client.MockServerRestClientCustomizer

All Implemented Interfaces:

RestClientCustomizer

public class MockServerRestClientCustomizer
extends Object
implements RestClientCustomizer

RestClientCustomizer that can be applied to RestClient.Builder instances to add MockRestServiceServer support.

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

 MockServerRestClientCustomizer customizer = new MockServerRestClientCustomizer();
 RestClient.Builder builder = RestClient.builder();
 customizer.customize(builder);
 MyBean bean = new MyBean(client.build());
 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(RestClient.Builder) 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(restClientBuilder).reset().

Since:

3.2.0

Author:

Scott Frederick

See Also:

• getServer()
• getServer(RestClient.Builder)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected RequestExpectationManager	createExpectationManager()
void	customize(RestClient.Builder restClientBuilder)	Callback to customize a RestClient.Builder instance.
Map<RestClient.Builder,RequestExpectationManager>	getExpectationManagers()
MockRestServiceServer	getServer()
MockRestServiceServer	getServer(RestClient.Builder restClientBuilder)
Map<RestClient.Builder,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.

Methods inherited from class java.lang.Object

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

Constructor Details

MockServerRestClientCustomizer

public MockServerRestClientCustomizer()

MockServerRestClientCustomizer

public MockServerRestClientCustomizer(Class<? extends RequestExpectationManager> expectationManager)

Create a new MockServerRestClientCustomizer instance.

Parameters:

expectationManager - the expectation manager class to use

MockServerRestClientCustomizer

public MockServerRestClientCustomizer(Supplier<? extends RequestExpectationManager> expectationManagerSupplier)

Create a new MockServerRestClientCustomizer instance.

Parameters:

expectationManagerSupplier - a supplier that provides the RequestExpectationManager to use

Since:

3.0.0

Method Details

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

Since:

3.1.0

customize

public void customize(RestClient.Builder restClientBuilder)

Description copied from interface: RestClientCustomizer

Callback to customize a RestClient.Builder instance.

Specified by:

customize in interface RestClientCustomizer

Parameters:

restClientBuilder - the client builder to customize

createExpectationManager

protected RequestExpectationManager createExpectationManager()

getServer

public MockRestServiceServer getServer()

getExpectationManagers

public Map<RestClient.Builder,RequestExpectationManager> getExpectationManagers()

getServer

public MockRestServiceServer getServer(RestClient.Builder restClientBuilder)

getServers

public Map<RestClient.Builder,MockRestServiceServer> getServers()