org.springframework.test.web.servlet.result

Class RequestResultMatchers

java.lang.Object

org.springframework.test.web.servlet.result.RequestResultMatchers

public class RequestResultMatchers
extends Object

Factory for assertions on the request.

An instance of this class is typically accessed via MockMvcResultMatchers.request().

Since:

3.2

Author:

Rossen Stoyanchev, Sam Brannen

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestResultMatchers() Protected constructor.

Method Summary

Modifier and Type	Method and Description
ResultMatcher	asyncNotStarted() Assert that asynchronous processing was not started.
<T> ResultMatcher	asyncResult(Matcher<? super T> matcher) Assert the result from asynchronous processing with the given matcher.
ResultMatcher	asyncResult(Object expectedResult) Assert the result from asynchronous processing.
ResultMatcher	asyncStarted() Assert whether asynchronous processing started, usually as a result of a controller method returning Callable or DeferredResult.
<T> ResultMatcher	attribute(String name, Matcher<? super T> matcher) Assert a request attribute value with the given Hamcrest Matcher.
ResultMatcher	attribute(String name, Object expectedValue) Assert a request attribute value.
<T> ResultMatcher	sessionAttribute(String name, Matcher<? super T> matcher) Assert a session attribute value with the given Hamcrest Matcher.
ResultMatcher	sessionAttribute(String name, Object value) Assert a session attribute value.
ResultMatcher	sessionAttributeDoesNotExist(String... names) Assert the given session attributes do not exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestResultMatchers

protected RequestResultMatchers()

Protected constructor.

Use MockMvcResultMatchers.request().

Method Detail

asyncStarted

public ResultMatcher asyncStarted()

Assert whether asynchronous processing started, usually as a result of a controller method returning Callable or DeferredResult.

The test will await the completion of a Callable so that asyncResult(Matcher) or asyncResult(Object) can be used to assert the resulting value.

Neither a Callable nor a DeferredResult will complete processing all the way since a MockHttpServletRequest does not perform asynchronous dispatches.

See Also:

asyncNotStarted()

asyncNotStarted

public ResultMatcher asyncNotStarted()

Assert that asynchronous processing was not started.

See Also:

asyncStarted()

asyncResult

public <T> ResultMatcher asyncResult(Matcher<? super T> matcher)

Assert the result from asynchronous processing with the given matcher.

This method can be used when a controller method returns Callable or WebAsyncTask.

asyncResult

public ResultMatcher asyncResult(@Nullable
                                 Object expectedResult)

Assert the result from asynchronous processing.

This method can be used when a controller method returns Callable or WebAsyncTask. The value matched is the value returned from the Callable or the exception raised.

attribute

public <T> ResultMatcher attribute(String name,
                                   Matcher<? super T> matcher)

Assert a request attribute value with the given Hamcrest Matcher.

attribute

public ResultMatcher attribute(String name,
                               @Nullable
                               Object expectedValue)

Assert a request attribute value.

sessionAttribute

public <T> ResultMatcher sessionAttribute(String name,
                                          Matcher<? super T> matcher)

Assert a session attribute value with the given Hamcrest Matcher.

sessionAttribute

public ResultMatcher sessionAttribute(String name,
                                      @Nullable
                                      Object value)

Assert a session attribute value.

sessionAttributeDoesNotExist

public ResultMatcher sessionAttributeDoesNotExist(String... names)

Assert the given session attributes do not exist.

Since:

5.2.1