org.springframework.test.web.client.match

Class MockRestRequestMatchers

  • java.lang.Object
    • org.springframework.test.web.client.match.MockRestRequestMatchers


  • public abstract class MockRestRequestMatchers
    extends java.lang.Object
    Static factory methods for RequestMatcher classes. Typically used to provide input for MockRestServiceServer.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, Sam Brannen
    • Method Summary

      All Methods Static Methods Concrete Methods 
      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.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MockRestRequestMatchers

        public MockRestRequestMatchers()
    • Method Detail

      • anything

        public static RequestMatcher anything()
        Match to any request.
      • method

        public static RequestMatcher method(HttpMethod method)
        Assert the HttpMethod of the request.
        Parameters:
        method - the HTTP method
        Returns:
        the request matcher
      • requestTo

        public static RequestMatcher requestTo(org.hamcrest.Matcher<java.lang.String> matcher)
        Assert the request URI string with the given Hamcrest matcher.
        Parameters:
        matcher - the String matcher for the expected URI
        Returns:
        the request matcher
      • requestTo

        public static RequestMatcher requestTo(java.lang.String expectedUri)
        Assert the request URI matches the given string.
        Parameters:
        expectedUri - the expected URI
        Returns:
        the request matcher
      • requestToUriTemplate

        public 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.
        Parameters:
        expectedUri - the expected URI template
        uriVars - zero or more URI variables to populate the expected URI
        Returns:
        the request matcher
      • requestTo

        public static RequestMatcher requestTo(java.net.URI uri)
        Expect a request to the given URI.
        Parameters:
        uri - the expected URI
        Returns:
        the request matcher
      • queryParam

        @SafeVarargs
        public 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).
      • queryParam

        public static RequestMatcher queryParam(java.lang.String name,
                                                java.lang.String... expectedValues)
        Assert request query parameter values.
      • header

        @SafeVarargs
        public 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).
      • header

        public static RequestMatcher header(java.lang.String name,
                                            java.lang.String... expectedValues)
        Assert request header values.
      • jsonPath

        public 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. The JSON path expression can be a parameterized string using formatting specifiers as defined in String.format(String, Object...).
        Parameters:
        expression - the JSON path optionally parameterized with arguments
        args - arguments to parameterize the JSON path expression with
      • jsonPath

        public 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.
        Parameters:
        expression - the JSON path expression
        matcher - a matcher for the value expected at the JSON path
      • xpath

        public static XpathRequestMatchers xpath(java.lang.String expression,
                                                 java.lang.Object... args)
                                          throws javax.xml.xpath.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 in String.format(String, Object...).
        Parameters:
        expression - the XPath optionally parameterized with arguments
        args - arguments to parameterize the XPath expression with
        Throws:
        javax.xml.xpath.XPathExpressionException
      • xpath

        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
        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 in String.format(String, Object...).
        Parameters:
        expression - the XPath optionally parameterized with arguments
        namespaces - namespaces referenced in the XPath expression
        args - arguments to parameterize the XPath expression with
        Throws:
        javax.xml.xpath.XPathExpressionException