org.springframework.boot.test.web.client

Class RootUriRequestExpectationManager

java.lang.Object

org.springframework.boot.test.web.client.RootUriRequestExpectationManager

All Implemented Interfaces:

RequestExpectationManager

public class RootUriRequestExpectationManager
extends Object
implements RequestExpectationManager

RequestExpectationManager that strips the specified root URI from the request before verification. Can be used to simply test declarations when all REST calls start the same way. For example:

 RestTemplate restTemplate = new RestTemplateBuilder().rootUri("https://example.com").build();
 MockRestServiceServer server = RootUriRequestExpectationManager.bindTo(restTemplate);
 server.expect(requestTo("/hello")).andRespond(withSuccess());
 restTemplate.getForEntity("/hello", String.class);
 

Since:

1.4.0

Author:

Phillip Webb

See Also:

RootUriTemplateHandler, bindTo(RestTemplate), forRestTemplate(RestTemplate, RequestExpectationManager)

Constructor Summary

Constructors

Constructor and Description
RootUriRequestExpectationManager(String rootUri, RequestExpectationManager expectationManager)

Method Summary

Modifier and Type	Method and Description
static MockRestServiceServer	bindTo(RestTemplate restTemplate) Return a bound MockRestServiceServer for the given RestTemplate, configured with RootUriRequestExpectationManager when possible.
static MockRestServiceServer	bindTo(RestTemplate restTemplate, RequestExpectationManager expectationManager) Return a bound MockRestServiceServer for the given RestTemplate, configured with RootUriRequestExpectationManager when possible.
ResponseActions	expectRequest(ExpectedCount count, RequestMatcher requestMatcher)
static RequestExpectationManager	forRestTemplate(RestTemplate restTemplate, RequestExpectationManager expectationManager) Return RequestExpectationManager to be used for binding with the specified RestTemplate.
void	reset()
ClientHttpResponse	validateRequest(ClientHttpRequest request)
void	verify()

Methods inherited from class java.lang.Object

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

Constructor Detail

RootUriRequestExpectationManager

public RootUriRequestExpectationManager(String rootUri,
                                        RequestExpectationManager expectationManager)

Method Detail

expectRequest

public ResponseActions expectRequest(ExpectedCount count,
                                     RequestMatcher requestMatcher)

Specified by:

expectRequest in interface RequestExpectationManager

validateRequest

public ClientHttpResponse validateRequest(ClientHttpRequest request)
                                   throws IOException

Specified by:

validateRequest in interface RequestExpectationManager

Throws:

IOException

verify

public void verify()

Specified by:

verify in interface RequestExpectationManager

reset

public void reset()

Specified by:

reset in interface RequestExpectationManager

bindTo

public static MockRestServiceServer bindTo(RestTemplate restTemplate)

Return a bound MockRestServiceServer for the given RestTemplate, configured with RootUriRequestExpectationManager when possible.

Parameters:

restTemplate - the source REST template

Returns:

a configured MockRestServiceServer

bindTo

public static MockRestServiceServer bindTo(RestTemplate restTemplate,
                                           RequestExpectationManager expectationManager)

Return a bound MockRestServiceServer for the given RestTemplate, configured with RootUriRequestExpectationManager when possible.

Parameters:

restTemplate - the source REST template

expectationManager - the source RequestExpectationManager

Returns:

a configured MockRestServiceServer

forRestTemplate

public static RequestExpectationManager forRestTemplate(RestTemplate restTemplate,
                                                        RequestExpectationManager expectationManager)

Return RequestExpectationManager to be used for binding with the specified RestTemplate. If the RestTemplate is using a RootUriTemplateHandler then a RootUriRequestExpectationManager is returned, otherwise the source manager is returned unchanged.

Parameters:

restTemplate - the source REST template

expectationManager - the source RequestExpectationManager

Returns:

a RequestExpectationManager to be bound to the template