TestHttpResponse (Grails 7.0.10)

org.apache.grails.testing.http.client.TestHttpResponse

All Implemented Interfaces and Traits:

java.net.http.HttpResponse
```
class TestHttpResponse
extends java.lang.Object
implements java.net.http.HttpResponse
```
Fluent assertion wrapper around a JDK java.net.http.HttpResponse used by the HTTP client testing helpers.
This type keeps the underlying response accessible through the standard java.net.http.HttpResponse interface while adding convenience methods for the kinds of assertions common in integration and functional tests: status codes, headers, body text, structural JSON checks, XML parsing, and regex matching.
Assertion helpers are chainable and return this when successful, making it practical to express tests as:
```
 def response = http('/health')
 response.assertStatus(200)
         .assertContains('UP')
 
```
JSON helpers use structural comparison instead of raw string comparison, so object key ordering does not matter. Text and regex helpers work on the response body as a java.lang.String. Parsing helpers such as json, jsonList, and xml convert the body into richer representations when tests need to inspect structured content directly. XML parsing uses a secure default groovy.xml.XmlSlurper configuration and can be overridden per wrapper with withXmlSlurper.
When assertion methods accept a headers map, only the provided header entries are validated. Additional headers present on the response are ignored unless explicitly included in the expected map.
Assertion failures are reported as AssertionFailedError with expected/actual values when possible. Methods that parse JSON may also surface parsing exceptions if the response body is not valid for the configured parser settings.
Since:
7.0.10

Constructor Summary

Constructors
Constructor and description
`TestHttpResponse(java.net.http.HttpResponse<?> response)`
`TestHttpResponse(java.net.http.HttpResponse<?> response, SlurperConfig jsonSlurperConfig, SlurperConfig xmlSlurperConfig)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`TestHttpResponse`	`assertContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence body)` Asserts that the response body contains `body` as a substring.
	`TestHttpResponse`	`assertContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence body)` Asserts status and that the response body contains `body` as a substring.
	`TestHttpResponse`	`assertContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)` Asserts that the response body contains a regex match using java.util.regex.Matcher#find().
	`TestHttpResponse`	`assertContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)` Asserts status and that the response body contains a regex match using `find()`.
	`TestHttpResponse`	`assertEquals(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence body)` Asserts exact response body equality.
	`TestHttpResponse`	`assertEquals(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence body)` Asserts status and exact response body equality.
	`TestHttpResponse`	`assertHeaders(java.util.Map<java.lang.String, java.lang.String> expected)` Asserts exact values for the provided header names.
	`TestHttpResponse`	`assertHeaders(java.util.Map<java.lang.String, java.lang.String> expected, int status)` Asserts status and exact values for the provided header names.
	`TestHttpResponse`	`assertHeadersIgnoreCase(java.util.Map<java.lang.String, java.lang.String> expected)` Asserts case-insensitive header-name/value equality for all expected entries.
	`TestHttpResponse`	`assertHeadersIgnoreCase(java.util.Map<java.lang.String, java.lang.String> expected, int status)` Asserts status and case-insensitive header-name/value equality.
	`TestHttpResponse`	`assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.util.Map<java.lang.String, ?> json)` Asserts response JSON tree equality against a JSON object.
	`TestHttpResponse`	`assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.util.List<?> json)` Asserts response JSON tree equality against a JSON array.
	`TestHttpResponse`	`assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.Object json)` Asserts response JSON tree equality against a JSON-compatible object.
	`TestHttpResponse`	`assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence json)` Asserts response JSON tree equality against a JSON document string.
	`TestHttpResponse`	`assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.Map<java.lang.String, ?> json)` Asserts response status and JSON tree equality against a JSON object.
	`TestHttpResponse`	`assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.List<?> json)` Asserts response status and JSON tree equality against a JSON array.
	`TestHttpResponse`	`assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.Object json)` Asserts response status and JSON tree equality against a JSON-compatible object.
	`TestHttpResponse`	`assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence json)` Asserts response status and JSON tree equality against JSON text.
	`TestHttpResponse`	`assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.util.Map<java.lang.String, ?> json)` Asserts response JSON contains an expected object subset.
	`TestHttpResponse`	`assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.util.List<?> json)` Asserts response JSON contains an expected array subset.
	`TestHttpResponse`	`assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.Object json)` Asserts response JSON contains the expected subset.
	`TestHttpResponse`	`assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence json)` Asserts response JSON contains the expected subset expressed as JSON text.
	`TestHttpResponse`	`assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.Map<java.lang.String, ?> json)` Asserts response status and JSON tree contains an expected object subset.
	`TestHttpResponse`	`assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.List<?> json)` Asserts response status and JSON tree contains an expected array subset.
	`TestHttpResponse`	`assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.Object json)` Asserts response status and JSON tree contains an expected JSON-compatible subset.
	`TestHttpResponse`	`assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence json)` Asserts response status and JSON tree contains the expected subset expressed as JSON text.
	`TestHttpResponse`	`assertMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)` Asserts that the entire response body matches the regex using java.util.regex.Matcher#matches().
	`TestHttpResponse`	`assertMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)` Asserts status and that the entire response body matches the regex using `matches()`.
	`TestHttpResponse`	`assertNotContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence text)` Asserts that the response body does not contain `text` as a substring.
	`TestHttpResponse`	`assertNotContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence text)` Asserts status and that the response body does not contain `text` as a substring.
	`TestHttpResponse`	`assertNotContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)` Asserts that the response body does not contain a regex match using `find()`.
	`TestHttpResponse`	`assertNotContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)` Asserts status and that the response body does not contain a regex match using `find()`.
	`TestHttpResponse`	`assertNotEquals(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence body)` Asserts that the full response body does not equal `body`.
	`TestHttpResponse`	`assertNotEquals(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence body)` Asserts status and that the full response body does not equal `body`.
	`TestHttpResponse`	`assertNotHeaders(java.util.Map<java.lang.String, java.lang.String> headers)` Asserts that the provided header values are not present as exact first-value matches.
	`TestHttpResponse`	`assertNotMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)` Asserts that the response body does not fully match the regex using `matches()`.
	`TestHttpResponse`	`assertNotMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)` Asserts status and that the response body does not fully match the regex using `matches()`.
	`TestHttpResponse`	`assertNotStatus(int status)` Asserts that the response status is not equal to `status`.
	`TestHttpResponse`	`assertStatus(java.util.Map<java.lang.String, java.lang.String> headers, int status)` Asserts response status and optional exact header values.
	`java.lang.String`	`body()` Returns: delegated response body as a String
	`java.lang.String`	`getContentType()` Shortcut for the `Content-Type` header value.
	`boolean`	`hasHeader(java.lang.String name)` Indicates whether the response contains the named header.
	`boolean`	`hasHeaderValue(java.lang.String name, java.lang.String expected)` Indicates whether the named header exists and its first value equals `expected` exactly.
	`boolean`	`hasHeaderValueIgnoreCase(java.lang.String name, java.lang.String expected)` Indicates whether a matching header exists and any of its values equals `expected` ignoring case.
	`java.lang.String`	`headerValue(java.lang.String name)` Returns the first value for the given header, or `null` when missing.
	`long`	`headerValueAsLong(java.lang.String name)` Returns the first value for the given header as a long.
	`java.lang.String`	`headerValueIgnoreCase(java.lang.String name)` Returns the first header value for the given name using case-insensitive header-name matching.
	`HttpHeaders`	`headers()` Returns: delegated response headers
	`java.util.Map`	`json()` Parses the response body as a JSON object.
	`java.util.List`	`jsonList()` Parses the response body as a JSON array.
	`java.util.Optional<java.net.http.HttpResponse<?>>`	`previousResponse()` Returns the previous response, wrapped as TestHttpResponse when present.
	`java.net.http.HttpRequest`	`request()` Returns: delegated original request
	`java.util.Optional<javax.net.ssl.SSLSession>`	`sslSession()` Returns: delegated SSL session, if present
	`int`	`statusCode()` Returns: delegated HTTP status code
	`java.net.URI`	`uri()` Returns: delegated response URI
	`java.net.http.HttpClient$Version`	`version()`
	`TestHttpResponse`	`withJsonSlurper(SlurperConfig jsonSlurperConfig)` Returns a new response wrapper that uses the provided org.apache.grails.testing.http.client.utils.JsonUtils.SlurperConfig for JSON parsing and JSON assertion helpers.
	`TestHttpResponse`	`withXmlSlurper(SlurperConfig xmlSlurperConfig)` Returns a new response wrapper that uses the provided org.apache.grails.testing.http.client.utils.XmlUtils.SlurperConfig for XML parsing helpers.
	`static TestHttpResponse`	`wrap(java.net.http.HttpResponse<?> response)` Wraps a raw java.net.http.HttpResponse in TestHttpResponse unless it is already wrapped.
	`groovy.xml.slurpersupport.GPathResult`	`xml()` Parses the response body as XML.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Constructor Detail
  - TestHttpResponse(java.net.http.HttpResponse<?> response)
  - TestHttpResponse(java.net.http.HttpResponse<?> response, SlurperConfig jsonSlurperConfig, SlurperConfig xmlSlurperConfig)
- Method Detail
  - TestHttpResponse assertContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence body)
    
    Asserts that the response body contains body as a substring.
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    body - substring expected to be present in the response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence body)
    
    Asserts status and that the response body contains body as a substring.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    body - substring expected to be present in the response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)
    
    Asserts that the response body contains a regex match using java.util.regex.Matcher#find().
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    pattern - pattern that must be found somewhere in the response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)
    
    Asserts status and that the response body contains a regex match using find().
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    pattern - pattern that must be found somewhere in the response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertEquals(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence body)
    
    Asserts exact response body equality.
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    body - expected response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertEquals(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence body)
    
    Asserts status and exact response body equality.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    body - expected response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertHeaders(java.util.Map<java.lang.String, java.lang.String> expected)
    
    Asserts exact values for the provided header names.
    Parameters:
    expected - expected header values keyed by header name; only these entries are checked and extra response headers are ignored
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertHeaders(java.util.Map<java.lang.String, java.lang.String> expected, int status)
    
    Asserts status and exact values for the provided header names.
    Parameters:
    expected - expected header values keyed by header name; only these entries are checked and extra response headers are ignored
    status - expected HTTP status
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertHeadersIgnoreCase(java.util.Map<java.lang.String, java.lang.String> expected)
    
    Asserts case-insensitive header-name/value equality for all expected entries.
    Parameters:
    expected - expected headers to validate; only these entries are checked and extra response headers are ignored
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertHeadersIgnoreCase(java.util.Map<java.lang.String, java.lang.String> expected, int status)
    
    Asserts status and case-insensitive header-name/value equality.
    Parameters:
    expected - expected headers to validate; only these entries are checked and extra response headers are ignored
    status - expected HTTP status
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.util.Map<java.lang.String, ?> json)
    
    Asserts response JSON tree equality against a JSON object.
    Parameters:
    headers - expected headers; ignored when empty
    json - expected JSON object
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.util.List<?> json)
    
    Asserts response JSON tree equality against a JSON array.
    Parameters:
    headers - expected headers; ignored when empty
    json - expected JSON array
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.Object json)
    
    Asserts response JSON tree equality against a JSON-compatible object.
    Uses structural comparison (for example, object key order does not matter).
    
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    json - expected JSON-compatible object tree
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence json)
    
    Asserts response JSON tree equality against a JSON document string.
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    json - expected JSON document text
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.Map<java.lang.String, ?> json)
    
    Asserts response status and JSON tree equality against a JSON object.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    json - expected JSON object
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.List<?> json)
    
    Asserts response status and JSON tree equality against a JSON array.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    json - expected JSON array
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.Object json)
    
    Asserts response status and JSON tree equality against a JSON-compatible object.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    json - expected JSON-compatible object tree
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence json)
    
    Asserts response status and JSON tree equality against JSON text.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    json - expected JSON document text
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.util.Map<java.lang.String, ?> json)
    
    Asserts response JSON contains an expected object subset.
    Parameters:
    headers - expected headers; ignored when empty
    json - expected subset object
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.util.List<?> json)
    
    Asserts response JSON contains an expected array subset.
    Parameters:
    headers - expected headers; ignored when empty
    json - expected subset array
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.Object json)
    
    Asserts response JSON contains the expected subset.
    For objects, expected keys must exist; for arrays, expected elements are matched by index.
    
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    json - expected JSON-compatible subset
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence json)
    
    Asserts response JSON contains the expected subset expressed as JSON text.
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    json - expected subset encoded as JSON text
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.Map<java.lang.String, ?> json)
    
    Asserts response status and JSON tree contains an expected object subset.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    json - expected subset object
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.List<?> json)
    
    Asserts response status and JSON tree contains an expected array subset.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    json - expected subset array
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.Object json)
    
    Asserts response status and JSON tree contains an expected JSON-compatible subset.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    json - expected JSON-compatible subset
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence json)
    
    Asserts response status and JSON tree contains the expected subset expressed as JSON text.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    json - expected subset encoded as JSON text
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)
    
    Asserts that the entire response body matches the regex using java.util.regex.Matcher#matches().
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    pattern - pattern that must match the full response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)
    
    Asserts status and that the entire response body matches the regex using matches().
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    pattern - pattern that must match the full response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertNotContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence text)
    
    Asserts that the response body does not contain text as a substring.
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    text - unexpected substring
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertNotContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence text)
    
    Asserts status and that the response body does not contain text as a substring.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    text - unexpected substring
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertNotContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)
    
    Asserts that the response body does not contain a regex match using find().
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    pattern - pattern that must not be found anywhere in the response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertNotContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)
    
    Asserts status and that the response body does not contain a regex match using find().
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    pattern - pattern that must not be found anywhere in the response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertNotEquals(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence body)
    
    Asserts that the full response body does not equal body.
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    body - unexpected full response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertNotEquals(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence body)
    
    Asserts status and that the full response body does not equal body.
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    body - unexpected full response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertNotHeaders(java.util.Map<java.lang.String, java.lang.String> headers)
    
    Asserts that the provided header values are not present as exact first-value matches.
    Parameters:
    headers - header/value pairs that must not match the response
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertNotMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)
    
    Asserts that the response body does not fully match the regex using matches().
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    pattern - pattern that must not match the full response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertNotMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)
    
    Asserts status and that the response body does not fully match the regex using matches().
    Parameters:
    headers - expected headers; ignored when empty
    status - expected HTTP status
    pattern - pattern that must not match the full response body
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertNotStatus(int status)
    
    Asserts that the response status is not equal to status.
    Parameters:
    status - unexpected HTTP status
    Returns:
    same response for fluent chaining
  - TestHttpResponse assertStatus(java.util.Map<java.lang.String, java.lang.String> headers, int status)
    
    Asserts response status and optional exact header values.
    Parameters:
    headers - expected headers to validate; ignored when empty and treated as a subset match when provided, meaning additional response headers are ignored
    status - expected HTTP status
    Returns:
    same response for fluent chaining
  - @java.lang.Override
    java.lang.String body()
    
    Returns:
    delegated response body as a String
  - java.lang.String getContentType()
    
    Shortcut for the Content-Type header value.
    Returns:
    first matching value of the Content-Type header (ignoring case), or null when the header does not exist
  - boolean hasHeader(java.lang.String name)
    
    Indicates whether the response contains the named header.
    Parameters:
    name - header name to look up
    Returns:
    true if at least one matching header exists
  - boolean hasHeaderValue(java.lang.String name, java.lang.String expected)
    
    Indicates whether the named header exists and its first value equals expected exactly.
    Parameters:
    name - header name to look up
    expected - expected first header value
    Returns:
    true if the first value matches exactly
  - boolean hasHeaderValueIgnoreCase(java.lang.String name, java.lang.String expected)
    
    Indicates whether a matching header exists and any of its values equals expected ignoring case.
    Parameters:
    name - header name to look up case-insensitively
    expected - expected header value, compared ignoring case
    Returns:
    true if a matching value exists
  - java.lang.String headerValue(java.lang.String name)
    
    Returns the first value for the given header, or null when missing.
    Parameters:
    name - header name to look up
    Returns:
    first matching value, or null when no matching header exists
  - long headerValueAsLong(java.lang.String name)
    
    Returns the first value for the given header as a long.
    throws:
    NoSuchElementException if no header is found
    throws:
    NumberFormatException if a value is found, but does not parse as a Long
  - java.lang.String headerValueIgnoreCase(java.lang.String name)
    
    Returns the first header value for the given name using case-insensitive header-name matching.
    Parameters:
    name - header name to look up
    Returns:
    first matching value, or null when no matching header exists
  - @java.lang.Override
    HttpHeaders headers()
    
    Returns:
    delegated response headers
  - java.util.Map json()
    
    Parses the response body as a JSON object.
    throws:
    ClassCastException if the parsed body is not a JSON object
    
    Returns:
    parsed JSON object body as a java.util.Map
  - java.util.List jsonList()
    
    Parses the response body as a JSON array.
    throws:
    ClassCastException if the parsed body is not a JSON array
    
    Returns:
    parsed JSON array body as a java.util.List
  - @java.lang.Override
    java.util.Optional<java.net.http.HttpResponse<?>> previousResponse()
    
    Returns the previous response, wrapped as TestHttpResponse when present.
    Returns:
    optional previous response wrapper preserving this instance's JSON and XML parser configuration
  - @java.lang.Override
    java.net.http.HttpRequest request()
    
    Returns:
    delegated original request
  - @java.lang.Override
    java.util.Optional<javax.net.ssl.SSLSession> sslSession()
    
    Returns:
    delegated SSL session, if present
  - @java.lang.Override
    int statusCode()
    
    Returns:
    delegated HTTP status code
  - @java.lang.Override
    java.net.URI uri()
    
    Returns:
    delegated response URI
  - @java.lang.Override
    java.net.http.HttpClient$Version version()
  - @groovy.transform.NamedVariant
    TestHttpResponse withJsonSlurper(@groovy.transform.NamedDelegate
    SlurperConfig jsonSlurperConfig)
    
    Returns a new response wrapper that uses the provided org.apache.grails.testing.http.client.utils.JsonUtils.SlurperConfig for JSON parsing and JSON assertion helpers.
    This method does not mutate the current wrapper. Instead, it returns a new wrapper sharing the same underlying response while applying the supplied JsonUtils.SlurperConfig to methods such as json(), jsonList(), assertJson(CharSequence), and assertJsonContains(CharSequence).
    Parameters:
    jsonSlurperConfig - JSON parser configuration to use for the returned wrapper
    Returns:
    new response wrapper using the supplied JSON parser settings
  - @groovy.transform.NamedVariant
    TestHttpResponse withXmlSlurper(@groovy.transform.NamedDelegate
    SlurperConfig xmlSlurperConfig)
    
    Returns a new response wrapper that uses the provided org.apache.grails.testing.http.client.utils.XmlUtils.SlurperConfig for XML parsing helpers.
    This method does not mutate the current wrapper. Instead, it returns a new wrapper sharing the same underlying response while applying the supplied XML parser configuration to xml().
    Parameters:
    xmlSlurperConfig - XML parser configuration to use for the returned wrapper
    Returns:
    new response wrapper using the supplied XML parser settings
  - static TestHttpResponse wrap(java.net.http.HttpResponse<?> response)
    
    Wraps a raw java.net.http.HttpResponse in TestHttpResponse unless it is already wrapped.
    Parameters:
    response - raw or already wrapped response
    Returns:
    response unchanged when already a TestHttpResponse; otherwise a new wrapper
  - groovy.xml.slurpersupport.GPathResult xml()
    
    Parses the response body as XML. A secure groovy.xml.XmlSlurper configuration is used by default, disabling external entity expansion and external DTD loading while remaining namespace aware and non-validating. Override the parser with withXmlSlurper(XmlUtils.SlurperConfig) when a test needs custom XML parsing behavior.
    Returns:
    XML body parsed into a groovy.xml.slurpersupport.GPathResult for XML assertions

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Groovy] Class TestHttpResponse

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

TestHttpResponse(java.net.http.HttpResponse<?> response)

TestHttpResponse(java.net.http.HttpResponse<?> response, SlurperConfig jsonSlurperConfig, SlurperConfig xmlSlurperConfig)

Method Detail

TestHttpResponse assertContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence body)

TestHttpResponse assertContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence body)

TestHttpResponse assertContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)

TestHttpResponse assertContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)

TestHttpResponse assertEquals(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence body)

TestHttpResponse assertEquals(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence body)

TestHttpResponse assertHeaders(java.util.Map<java.lang.String, java.lang.String> expected)

TestHttpResponse assertHeaders(java.util.Map<java.lang.String, java.lang.String> expected, int status)

TestHttpResponse assertHeadersIgnoreCase(java.util.Map<java.lang.String, java.lang.String> expected)

TestHttpResponse assertHeadersIgnoreCase(java.util.Map<java.lang.String, java.lang.String> expected, int status)

TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.util.Map<java.lang.String, ?> json)

TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.util.List<?> json)

TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.Object json)

TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence json)

TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.Map<java.lang.String, ?> json)

TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.List<?> json)

TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.Object json)

TestHttpResponse assertJson(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence json)

TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.util.Map<java.lang.String, ?> json)

TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.util.List<?> json)

TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.Object json)

TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence json)

TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.Map<java.lang.String, ?> json)

TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.List<?> json)

TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.Object json)

TestHttpResponse assertJsonContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence json)

TestHttpResponse assertMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)

TestHttpResponse assertMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)

TestHttpResponse assertNotContains(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence text)

TestHttpResponse assertNotContains(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence text)

TestHttpResponse assertNotContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)

TestHttpResponse assertNotContainsMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)

TestHttpResponse assertNotEquals(java.util.Map<java.lang.String, java.lang.String> headers, java.lang.CharSequence body)

TestHttpResponse assertNotEquals(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.lang.CharSequence body)

TestHttpResponse assertNotHeaders(java.util.Map<java.lang.String, java.lang.String> headers)

TestHttpResponse assertNotMatches(java.util.Map<java.lang.String, java.lang.String> headers, java.util.regex.Pattern pattern)

TestHttpResponse assertNotMatches(java.util.Map<java.lang.String, java.lang.String> headers, int status, java.util.regex.Pattern pattern)

TestHttpResponse assertNotStatus(int status)

TestHttpResponse assertStatus(java.util.Map<java.lang.String, java.lang.String> headers, int status)

@java.lang.Overridejava.lang.String body()

java.lang.String getContentType()

boolean hasHeader(java.lang.String name)

boolean hasHeaderValue(java.lang.String name, java.lang.String expected)

boolean hasHeaderValueIgnoreCase(java.lang.String name, java.lang.String expected)

java.lang.String headerValue(java.lang.String name)

long headerValueAsLong(java.lang.String name)

java.lang.String headerValueIgnoreCase(java.lang.String name)

@java.lang.OverrideHttpHeaders headers()

java.util.Map json()

java.util.List jsonList()

@java.lang.Overridejava.util.Optional<java.net.http.HttpResponse<?>> previousResponse()

@java.lang.Overridejava.net.http.HttpRequest request()

@java.lang.Overridejava.util.Optional<javax.net.ssl.SSLSession> sslSession()

@java.lang.Overrideint statusCode()

@java.lang.Overridejava.net.URI uri()

@java.lang.Overridejava.net.http.HttpClient$Version version()

@groovy.transform.NamedVariantTestHttpResponse withJsonSlurper(@groovy.transform.NamedDelegateSlurperConfig jsonSlurperConfig)

@groovy.transform.NamedVariantTestHttpResponse withXmlSlurper(@groovy.transform.NamedDelegateSlurperConfig xmlSlurperConfig)

static TestHttpResponse wrap(java.net.http.HttpResponse<?> response)

groovy.xml.slurpersupport.GPathResult xml()

@java.lang.Override
java.lang.String body()

@java.lang.Override
HttpHeaders headers()

@java.lang.Override
java.util.Optional<java.net.http.HttpResponse<?>> previousResponse()

@java.lang.Override
java.net.http.HttpRequest request()

@java.lang.Override
java.util.Optional<javax.net.ssl.SSLSession> sslSession()

@java.lang.Override
int statusCode()

@java.lang.Override
java.net.URI uri()

@java.lang.Override
java.net.http.HttpClient$Version version()

@groovy.transform.NamedVariant
TestHttpResponse withJsonSlurper(@groovy.transform.NamedDelegate
SlurperConfig jsonSlurperConfig)

@groovy.transform.NamedVariant
TestHttpResponse withXmlSlurper(@groovy.transform.NamedDelegate
SlurperConfig xmlSlurperConfig)