public abstract class MockRestRequestMatchers
extends java.lang.Object
RequestMatcher
classes. Typically used to
provide input for MockRestServiceServer.expect(RequestMatcher)
.
Consider adding this class as a Java editor favorite. To navigate to this setting, open the Preferences and type "favorites".
Constructor and Description |
---|
MockRestRequestMatchers() |
Modifier and Type | Method and Description |
---|---|
static RequestMatcher |
anything()
Match to any request.
|
static ContentRequestMatchers |
content()
Access to request body matchers.
|
static RequestMatcher |
header(java.lang.String name,
org.hamcrest.Matcher<? super java.lang.String>... matchers)
Assert request header values with the given Hamcrest matcher(s).
|
static RequestMatcher |
header(java.lang.String name,
java.lang.String... expectedValues)
Assert request header values.
|
static <T> RequestMatcher |
jsonPath(java.lang.String expression,
org.hamcrest.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 JsonPathRequestMatchers |
jsonPath(java.lang.String expression,
java.lang.Object... args)
Access to request body matchers using a
JsonPath expression to
inspect a specific subset of the body.
|
static RequestMatcher |
method(HttpMethod method)
Assert the
HttpMethod of the request. |
static RequestMatcher |
queryParam(java.lang.String name,
org.hamcrest.Matcher<? super java.lang.String>... matchers)
Assert request query parameter values with the given Hamcrest matcher(s).
|
static RequestMatcher |
queryParam(java.lang.String name,
java.lang.String... expectedValues)
Assert request query parameter values.
|
static RequestMatcher |
requestTo(org.hamcrest.Matcher<java.lang.String> matcher)
Assert the request URI string with the given Hamcrest matcher.
|
static RequestMatcher |
requestTo(java.lang.String expectedUri)
Assert the request URI matches the given string.
|
static RequestMatcher |
requestTo(java.net.URI uri)
Expect a request to the given URI.
|
static RequestMatcher |
requestToUriTemplate(java.lang.String expectedUri,
java.lang.Object... uriVars)
Variant of
requestTo(URI) that prepares the URI from a URI
template plus optional variables via UriComponentsBuilder
including encoding. |
static XpathRequestMatchers |
xpath(java.lang.String expression,
java.util.Map<java.lang.String,java.lang.String> namespaces,
java.lang.Object... args)
Access to response body matchers using an XPath to inspect a specific
subset of the body.
|
static XpathRequestMatchers |
xpath(java.lang.String expression,
java.lang.Object... args)
Access to request body matchers using an XPath to inspect a specific
subset of the body.
|
public static RequestMatcher anything()
public static RequestMatcher method(HttpMethod method)
HttpMethod
of the request.method
- the HTTP methodpublic static RequestMatcher requestTo(org.hamcrest.Matcher<java.lang.String> matcher)
matcher
- String matcher for the expected URIpublic static RequestMatcher requestTo(java.lang.String expectedUri)
expectedUri
- the expected URIpublic static RequestMatcher requestToUriTemplate(java.lang.String expectedUri, java.lang.Object... uriVars)
requestTo(URI)
that prepares the URI from a URI
template plus optional variables via UriComponentsBuilder
including encoding.expectedUri
- the expected URI templateuriVars
- zero or more URI variables to populate the expected URIpublic static RequestMatcher requestTo(java.net.URI uri)
uri
- the expected URI@SafeVarargs public static RequestMatcher queryParam(java.lang.String name, org.hamcrest.Matcher<? super java.lang.String>... matchers)
public static RequestMatcher queryParam(java.lang.String name, java.lang.String... expectedValues)
@SafeVarargs public static RequestMatcher header(java.lang.String name, org.hamcrest.Matcher<? super java.lang.String>... matchers)
public static RequestMatcher header(java.lang.String name, java.lang.String... expectedValues)
public static ContentRequestMatchers content()
public static JsonPathRequestMatchers jsonPath(java.lang.String expression, java.lang.Object... args)
String.format(String, Object...)
.expression
- the JSON path optionally parameterized with argumentsargs
- arguments to parameterize the JSON path expression withpublic static <T> RequestMatcher jsonPath(java.lang.String expression, org.hamcrest.Matcher<T> matcher)
expression
- the JSON path expressionmatcher
- a matcher for the value expected at the JSON pathpublic static XpathRequestMatchers xpath(java.lang.String expression, java.lang.Object... args) throws javax.xml.xpath.XPathExpressionException
String.format(String, Object...)
.expression
- the XPath optionally parameterized with argumentsargs
- arguments to parameterize the XPath expression withjavax.xml.xpath.XPathExpressionException
public static XpathRequestMatchers xpath(java.lang.String expression, java.util.Map<java.lang.String,java.lang.String> namespaces, java.lang.Object... args) throws javax.xml.xpath.XPathExpressionException
String.format(String, Object...)
.expression
- the XPath optionally parameterized with argumentsnamespaces
- namespaces referenced in the XPath expressionargs
- arguments to parameterize the XPath expression withjavax.xml.xpath.XPathExpressionException