ContentRequestMatchers (Spring Framework 5.3.24 API)

java.lang.Object
- org.springframework.test.web.client.match.ContentRequestMatchers

```
public class ContentRequestMatchers
extends Object
```
Factory for request content RequestMatcher's. An instance of this class is typically accessed via MockRestRequestMatchers.content().

Since:

3.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors
Modifier Constructor and Description

protected ContentRequestMatchers()
Class constructor, not for direct instantiation.

Constructors
Modifier	Constructor and Description
`protected`	`ContentRequestMatchers()` Class constructor, not for direct instantiation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RequestMatcher`	`bytes(byte[] expectedContent)` Compare the body of the request to the given byte array.
`RequestMatcher`	`contentType(MediaType expectedContentType)` Assert the request content type as a `MediaType`.
`RequestMatcher`	`contentType(String expectedContentType)` Assert the request content type as a String.
`RequestMatcher`	`contentTypeCompatibleWith(MediaType contentType)` Assert the request content type is compatible with the given content type as defined by `MediaType.isCompatibleWith(MediaType)`.
`RequestMatcher`	`contentTypeCompatibleWith(String contentType)` Assert the request content type is compatible with the given content type as defined by `MediaType.isCompatibleWith(MediaType)`.
`RequestMatcher`	`formData(MultiValueMap<String,String> expected)` Parse the body as form data and compare to the given `MultiValueMap`.
`RequestMatcher`	`formDataContains(Map<String,String> expected)` Variant of `formData(MultiValueMap)` that matches the given subset of expected form parameters.
`RequestMatcher`	`json(String expectedJsonContent)` Parse the expected and actual strings as JSON and assert the two are "similar" - i.e.
`RequestMatcher`	`json(String expectedJsonContent, boolean strict)` Parse the request body and the given string as JSON and assert the two are "similar" - i.e.
`RequestMatcher`	`multipartData(MultiValueMap<String,?> expectedMap)` Parse the body as multipart data and assert it contains exactly the values from the given `MultiValueMap`.
`RequestMatcher`	`multipartDataContains(Map<String,?> expectedMap)` Variant of `multipartData(MultiValueMap)` that does the same but only for a subset of the actual values.
`RequestMatcher`	`node(Matcher<? super Node> matcher)` Parse the request content as `Node` and apply the given `Matcher`.
`RequestMatcher`	`source(Matcher<? super Source> matcher)` Parse the request content as `DOMSource` and apply the given `Matcher`.
`RequestMatcher`	`string(Matcher<? super String> matcher)` Get the body of the request as a UTF-8 string and apply the given `Matcher`.
`RequestMatcher`	`string(String expectedContent)` Get the body of the request as a UTF-8 string and compare it to the given String.
`RequestMatcher`	`xml(String expectedXmlContent)` Parse the request body and the given String as XML and assert that the two are "similar" - i.e.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ContentRequestMatchers
```
protected ContentRequestMatchers()
```
    Class constructor, not for direct instantiation. Use MockRestRequestMatchers.content().
- Method Detail
  - contentType
```
public RequestMatcher contentType(String expectedContentType)
```
    Assert the request content type as a String.
  - contentType
```
public RequestMatcher contentType(MediaType expectedContentType)
```
    Assert the request content type as a MediaType.
  - contentTypeCompatibleWith
```
public RequestMatcher contentTypeCompatibleWith(String contentType)
```
    Assert the request content type is compatible with the given content type as defined by MediaType.isCompatibleWith(MediaType).
  - contentTypeCompatibleWith
```
public RequestMatcher contentTypeCompatibleWith(MediaType contentType)
```
    Assert the request content type is compatible with the given content type as defined by MediaType.isCompatibleWith(MediaType).
  - string
```
public RequestMatcher string(Matcher<? super String> matcher)
```
    Get the body of the request as a UTF-8 string and apply the given Matcher.
  - string
```
public RequestMatcher string(String expectedContent)
```
    Get the body of the request as a UTF-8 string and compare it to the given String.
  - bytes
```
public RequestMatcher bytes(byte[] expectedContent)
```
    Compare the body of the request to the given byte array.
  - formData
```
public RequestMatcher formData(MultiValueMap<String,String> expected)
```
    Parse the body as form data and compare to the given MultiValueMap.
    
    Since:
    
    4.3
  - formDataContains
```
public RequestMatcher formDataContains(Map<String,String> expected)
```
    Variant of formData(MultiValueMap) that matches the given subset of expected form parameters.
    
    Since:
    
    5.3
  - multipartData
```
public RequestMatcher multipartData(MultiValueMap<String,?> expectedMap)
```
    Parse the body as multipart data and assert it contains exactly the values from the given MultiValueMap. Values may be of type:
    - String - form field
    - Resource - content from a file
    - byte[] - other raw content
    Note: This method uses the Apache Commons FileUpload library to parse the multipart data and it must be on the test classpath.
    Parameters:
    
    expectedMap - the expected multipart values
    
    Since:
    
    5.3
  - multipartDataContains
```
public RequestMatcher multipartDataContains(Map<String,?> expectedMap)
```
    Variant of multipartData(MultiValueMap) that does the same but only for a subset of the actual values.
    
    Parameters:
    
    expectedMap - the expected multipart values
    
    Since:
    
    5.3
  - xml
```
public RequestMatcher xml(String expectedXmlContent)
```
    Parse the request body and the given String as XML and assert that the two are "similar" - i.e. they contain the same elements and attributes regardless of order.
    Use of this matcher assumes the XMLUnit library is available.
    
    Parameters:
    
    expectedXmlContent - the expected XML content
  - node
```
public RequestMatcher node(Matcher<? super Node> matcher)
```
    Parse the request content as Node and apply the given Matcher.
  - source
```
public RequestMatcher source(Matcher<? super Source> matcher)
```
    Parse the request content as DOMSource and apply the given Matcher.
    
    See Also:
    
    https://code.google.com/p/xml-matchers/
  - json
```
public RequestMatcher json(String expectedJsonContent)
```
    Parse the expected and actual strings as JSON and assert the two are "similar" - i.e. they contain the same attribute-value pairs regardless of formatting with a lenient checking (extensible, and non-strict array ordering).
    Use of this matcher requires the JSONassert library.
    
    Parameters:
    
    expectedJsonContent - the expected JSON content
    
    Since:
    
    5.0.5
  - json
```
public RequestMatcher json(String expectedJsonContent,
                           boolean strict)
```
    Parse the request body and the given string as JSON and assert the two are "similar" - i.e. they contain the same attribute-value pairs regardless of formatting.
    Can compare in two modes, depending on strict parameter value:
    - true: strict checking. Not extensible, and strict array ordering.
    - false: lenient checking. Extensible, and non-strict array ordering.
    Use of this matcher requires the JSONassert library.
    Parameters:
    
    expectedJsonContent - the expected JSON content
    
    strict - enables strict checking
    
    Since:
    
    5.0.5

Class ContentRequestMatchers

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContentRequestMatchers

Method Detail

contentType

contentType

contentTypeCompatibleWith

contentTypeCompatibleWith

string

string

bytes

formData

formDataContains

multipartData

multipartDataContains

xml

node

source

json

json