org.springframework.test.web.client

Class DefaultRequestExpectation

java.lang.Object

org.springframework.test.web.client.DefaultRequestExpectation

All Implemented Interfaces:

RequestExpectation, RequestMatcher, ResponseActions, ResponseCreator

public class DefaultRequestExpectation
extends java.lang.Object
implements RequestExpectation

Default implementation of RequestExpectation that simply delegates to the request matchers and the response creator it contains.

Since:

4.3

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultRequestExpectation.RequestCount Helper class that keeps track of actual vs expected request count.

Constructor Summary

Constructors

Constructor and Description
DefaultRequestExpectation(ExpectedCount expectedCount, RequestMatcher requestMatcher) Create a new request expectation that should be called a number of times as indicated by RequestCount.

Method Summary

Modifier and Type	Method and Description
ResponseActions	andExpect(RequestMatcher requestMatcher) Add a request expectation.
void	andRespond(ResponseCreator responseCreator) Define the response.
ClientHttpResponse	createResponse(ClientHttpRequest request) Note that as of 5.0.3, the creation of the response, which may block intentionally, is separated from request count tracking, and this method no longer increments the count transparently.
protected DefaultRequestExpectation.RequestCount	getRequestCount()
protected java.util.List<RequestMatcher>	getRequestMatchers()
protected ResponseCreator	getResponseCreator()
boolean	hasRemainingCount() Whether there is a remaining count of invocations for this expectation.
void	incrementAndValidate() Increase the matched request count and check we haven't passed the max count.
boolean	isSatisfied() Whether the requirements for this request expectation have been met.
void	match(ClientHttpRequest request) Match the given request against specific expectations.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRequestExpectation

public DefaultRequestExpectation(ExpectedCount expectedCount,
                                 RequestMatcher requestMatcher)

Create a new request expectation that should be called a number of times as indicated by RequestCount.

Parameters:

expectedCount - the expected request expectedCount

Method Detail

getRequestCount

protected DefaultRequestExpectation.RequestCount getRequestCount()

getRequestMatchers

protected java.util.List<RequestMatcher> getRequestMatchers()

getResponseCreator

@Nullable
protected ResponseCreator getResponseCreator()

andExpect

public ResponseActions andExpect(RequestMatcher requestMatcher)

Description copied from interface: ResponseActions

Add a request expectation.

Specified by:

andExpect in interface ResponseActions

Returns:

the expectation

andRespond

public void andRespond(ResponseCreator responseCreator)

Description copied from interface: ResponseActions

Define the response.

Specified by:

andRespond in interface ResponseActions

Parameters:

responseCreator - the creator of the response

match

public void match(ClientHttpRequest request)
           throws java.io.IOException

Description copied from interface: RequestMatcher

Match the given request against specific expectations.

Specified by:

match in interface RequestMatcher

Parameters:

request - the request to make assertions on

Throws:

java.io.IOException - in case of I/O errors

createResponse

public ClientHttpResponse createResponse(@Nullable
                                         ClientHttpRequest request)
                                  throws java.io.IOException

Note that as of 5.0.3, the creation of the response, which may block intentionally, is separated from request count tracking, and this method no longer increments the count transparently. Instead incrementAndValidate() must be invoked independently.

Specified by:

createResponse in interface ResponseCreator

Parameters:

request - the request

Throws:

java.io.IOException

hasRemainingCount

public boolean hasRemainingCount()

Description copied from interface: RequestExpectation

Whether there is a remaining count of invocations for this expectation.

Specified by:

hasRemainingCount in interface RequestExpectation

incrementAndValidate

public void incrementAndValidate()

Description copied from interface: RequestExpectation

Increase the matched request count and check we haven't passed the max count.

Specified by:

incrementAndValidate in interface RequestExpectation

isSatisfied

public boolean isSatisfied()

Description copied from interface: RequestExpectation

Whether the requirements for this request expectation have been met.

Specified by:

isSatisfied in interface RequestExpectation