程序包 cn.taketoday.framework.test.web.client

类 RootUriRequestExpectationManager

java.lang.Object

cn.taketoday.framework.test.web.client.RootUriRequestExpectationManager

所有已实现的接口:

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);
 

从以下版本开始:

4.0

作者:

Phillip Webb

另请参阅:

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

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static class	RootUriRequestExpectationManager.ReplaceUriClientHttpRequest	ClientHttpRequest wrapper to replace the request URI.

字段概要

字段

修饰符和类型	字段	说明
private final RequestExpectationManager	expectationManager
private final String	rootUri

构造器概要

构造器

构造器	说明
RootUriRequestExpectationManager(String rootUri, RequestExpectationManager expectationManager)

方法概要

修饰符和类型	方法	说明
static MockRestServiceServer	bindTo(cn.taketoday.web.client.RestTemplate restTemplate)	Return a bound MockRestServiceServer for the given RestTemplate, configured with RootUriRequestExpectationManager when possible.
static MockRestServiceServer	bindTo(cn.taketoday.web.client.RestTemplate restTemplate, RequestExpectationManager expectationManager)	Return a bound MockRestServiceServer for the given RestTemplate, configured with RootUriRequestExpectationManager when possible.
ResponseActions	expectRequest(ExpectedCount count, RequestMatcher requestMatcher)	Set up a new request expectation.
static RequestExpectationManager	forRestTemplate(cn.taketoday.web.client.RestTemplate restTemplate, RequestExpectationManager expectationManager)	Return RequestExpectationManager to be used for binding with the specified RestTemplate.
private cn.taketoday.http.client.ClientHttpRequest	replaceURI(cn.taketoday.http.client.ClientHttpRequest request, String replacementUri)
void	reset()	Reset the internal state removing all expectations and recorded requests.
cn.taketoday.http.client.ClientHttpResponse	validateRequest(cn.taketoday.http.client.ClientHttpRequest request)	Validate the given actual request against the declared expectations.
void	verify()	Verify that all expectations have been met.
void	verify(Duration timeout)	Variant of RequestExpectationManager.verify() that waits for up to the specified time for all expectations to be fulfilled.

从类继承的方法 java.lang.Object

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

字段详细资料

rootUri

private final String rootUri

expectationManager

private final RequestExpectationManager expectationManager

构造器详细资料

RootUriRequestExpectationManager

public RootUriRequestExpectationManager(String rootUri,
 RequestExpectationManager expectationManager)

方法详细资料

expectRequest

public ResponseActions expectRequest(ExpectedCount count,
 RequestMatcher requestMatcher)

从接口复制的说明: RequestExpectationManager

Set up a new request expectation. The returned ResponseActions is used to add more expectations and define a response.

This is a delegate for MockRestServiceServer.expect(ExpectedCount, RequestMatcher).

指定者:

expectRequest 在接口中 RequestExpectationManager

requestMatcher - a request expectation

返回:

for setting up further expectations and define a response

另请参阅:

• MockRestServiceServer.expect(RequestMatcher)
• MockRestServiceServer.expect(ExpectedCount, RequestMatcher)

validateRequest

public cn.taketoday.http.client.ClientHttpResponse validateRequest(cn.taketoday.http.client.ClientHttpRequest request)
                                                            throws IOException

从接口复制的说明: RequestExpectationManager

Validate the given actual request against the declared expectations. Is successful return the mock response to use or raise an error.

This is used in MockRestServiceServer against actual requests.

指定者:

validateRequest 在接口中 RequestExpectationManager

参数:

request - the request

返回:

the response to return if the request was validated.

抛出:

IOException - in case of any validation errors

replaceURI

private cn.taketoday.http.client.ClientHttpRequest replaceURI(cn.taketoday.http.client.ClientHttpRequest request,
 String replacementUri)

verify

public void verify()

从接口复制的说明: RequestExpectationManager

Verify that all expectations have been met.

This is a delegate for MockRestServiceServer.verify().

指定者:

verify 在接口中 RequestExpectationManager

另请参阅:

• MockRestServiceServer.verify()

verify

public void verify(Duration timeout)

从接口复制的说明: RequestExpectationManager

Variant of RequestExpectationManager.verify() that waits for up to the specified time for all expectations to be fulfilled. This can be useful for tests that involve asynchronous requests.

指定者:

verify 在接口中 RequestExpectationManager

参数:

timeout - how long to wait for all expecations to be met

reset

public void reset()

从接口复制的说明: RequestExpectationManager

Reset the internal state removing all expectations and recorded requests.

This is a delegate for MockRestServiceServer.reset().

指定者:

reset 在接口中 RequestExpectationManager

另请参阅:

• MockRestServiceServer.reset()

bindTo

public static MockRestServiceServer bindTo(cn.taketoday.web.client.RestTemplate restTemplate)

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

参数:

restTemplate - the source REST template

返回:

a configured MockRestServiceServer

bindTo

public static MockRestServiceServer bindTo(cn.taketoday.web.client.RestTemplate restTemplate,
 RequestExpectationManager expectationManager)

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

参数:

restTemplate - the source REST template

expectationManager - the source RequestExpectationManager

返回:

a configured MockRestServiceServer

forRestTemplate

public static RequestExpectationManager forRestTemplate(cn.taketoday.web.client.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.

参数:

restTemplate - the source REST template

expectationManager - the source RequestExpectationManager

返回:

a RequestExpectationManager to be bound to the template