org.springframework.test.web.client

Interface RequestExpectationManager

All Known Implementing Classes:

AbstractRequestExpectationManager, SimpleRequestExpectationManager, UnorderedRequestExpectationManager

public interface RequestExpectationManager

Abstraction for creating HTTP request expectations, applying them to actual requests (in strict or random order), and verifying whether expectations have been met.

Since:

4.3

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
ResponseActions	expectRequest(ExpectedCount count, RequestMatcher requestMatcher) Set up a new request expectation.
void	reset() Reset the internal state removing all expectations and recorded requests.
ClientHttpResponse	validateRequest(ClientHttpRequest request) Validate the given actual request against the declared expectations.
void	verify() Verify that all expectations have been met.

Method Detail

expectRequest

ResponseActions expectRequest(ExpectedCount count,
                              RequestMatcher requestMatcher)

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

Parameters:

requestMatcher - a request expectation

Returns:

for setting up further expectations and define a response

validateRequest

ClientHttpResponse validateRequest(ClientHttpRequest request)
                            throws java.io.IOException

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

Parameters:

request - the request

Returns:

the response to return if the request was validated.

Throws:

java.lang.AssertionError - when some expectations were not met

java.io.IOException - in case of any validation errors

verify

void verify()

Verify that all expectations have been met.

Throws:

java.lang.AssertionError - when some expectations were not met

reset

void reset()

Reset the internal state removing all expectations and recorded requests.