Class MockRestRequestMatchers
- java.lang.Object
- org.springframework.test.web.client.match.MockRestRequestMatchers
public abstract class MockRestRequestMatchers extends Object
Static factory methods forRequestMatcherclasses. Typically used to provide input forMockRestServiceServer.expect(RequestMatcher).Eclipse Users
Consider adding this class as a Java editor favorite. To navigate to this setting, open the Preferences and type "favorites".
- Since:
- 3.2
- Author:
- Craig Walls, Rossen Stoyanchev
Constructor Summary
Constructors Constructor Description MockRestRequestMatchers()
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static RequestMatcheranything()Match to any request.static ContentRequestMatcherscontent()Access to request body matchers.static RequestMatcherheader(String name, String... expectedValues)Assert request header values.static RequestMatcherheader(String name, Matcher<? super String>... matchers)Assert request header values with the given Hamcrest matcher.static JsonPathRequestMatchersjsonPath(String expression, Object... args)Access to request body matchers using a JsonPath expression to inspect a specific subset of the body.static <T> RequestMatcherjsonPath(String expression, Matcher<T> matcher)Access to request body matchers using a JsonPath expression to inspect a specific subset of the body and a Hamcrest match for asserting the value found at the JSON path.static RequestMatchermethod(HttpMethod method)Assert theHttpMethodof the request.static RequestMatcherqueryParam(String name, String... expectedValues)Assert request query parameter values.static RequestMatcherqueryParam(String name, Matcher<? super String>... matchers)Assert request query parameter values with the given Hamcrest matcher.static RequestMatcherrequestTo(String expectedUri)Assert the request URI string.static RequestMatcherrequestTo(URI uri)Expect a request to the given URI.static RequestMatcherrequestTo(Matcher<String> matcher)Assert the request URI string with the given matcher.static XpathRequestMatchersxpath(String expression, Object... args)Access to request body matchers using an XPath to inspect a specific subset of the body.static XpathRequestMatchersxpath(String expression, Map<String,String> namespaces, Object... args)Access to response body matchers using an XPath to inspect a specific subset of the body.
Constructor Detail
MockRestRequestMatchers
public MockRestRequestMatchers()
Method Detail
anything
public static RequestMatcher anything()
Match to any request.
method
public static RequestMatcher method(HttpMethod method)
Assert theHttpMethodof the request.- Parameters:
method- the HTTP method- Returns:
- the request matcher
requestTo
public static RequestMatcher requestTo(Matcher<String> matcher)
Assert the request URI string with the given matcher.- Parameters:
matcher- String matcher for the expected URI- Returns:
- the request matcher
requestTo
public static RequestMatcher requestTo(String expectedUri)
Assert the request URI string.- Parameters:
expectedUri- the expected URI- Returns:
- the request matcher
requestTo
public static RequestMatcher requestTo(URI uri)
Expect a request to the given URI.- Parameters:
uri- the expected URI- Returns:
- the request matcher
queryParam
@SafeVarargs public static RequestMatcher queryParam(String name, Matcher<? super String>... matchers)
Assert request query parameter values with the given Hamcrest matcher.
queryParam
public static RequestMatcher queryParam(String name, String... expectedValues)
Assert request query parameter values.
header
@SafeVarargs public static RequestMatcher header(String name, Matcher<? super String>... matchers)
Assert request header values with the given Hamcrest matcher.
header
public static RequestMatcher header(String name, String... expectedValues)
Assert request header values.
content
public static ContentRequestMatchers content()
Access to request body matchers.
jsonPath
public static JsonPathRequestMatchers jsonPath(String expression, Object... args)
Access to request body matchers using a JsonPath expression to inspect a specific subset of the body. The JSON path expression can be a parameterized string using formatting specifiers as defined inString.format(String, Object...).- Parameters:
expression- the JSON path optionally parameterized with argumentsargs- arguments to parameterize the JSON path expression with
jsonPath
public static <T> RequestMatcher jsonPath(String expression, Matcher<T> matcher)
Access to request body matchers using a JsonPath expression to inspect a specific subset of the body and a Hamcrest match for asserting the value found at the JSON path.- Parameters:
expression- the JSON path expressionmatcher- a matcher for the value expected at the JSON path
xpath
public static XpathRequestMatchers xpath(String expression, Object... args) throws XPathExpressionException
Access to request body matchers using an XPath to inspect a specific subset of the body. The XPath expression can be a parameterized string using formatting specifiers as defined inString.format(String, Object...).- Parameters:
expression- the XPath optionally parameterized with argumentsargs- arguments to parameterize the XPath expression with- Throws:
XPathExpressionException
xpath
public static XpathRequestMatchers xpath(String expression, Map<String,String> namespaces, Object... args) throws XPathExpressionException
Access to response body matchers using an XPath to inspect a specific subset of the body. The XPath expression can be a parameterized string using formatting specifiers as defined inString.format(String, Object...).- Parameters:
expression- the XPath optionally parameterized with argumentsnamespaces- namespaces referenced in the XPath expressionargs- arguments to parameterize the XPath expression with- Throws:
XPathExpressionException