Package org.mockserver.matchers

Class HttpResponseMatcher

java.lang.Object

org.mockserver.matchers.HttpResponseMatcher

public class HttpResponseMatcher
extends Object

Matches an actual HttpResponse against a template HttpResponse.

Each template field constrains the match only when it is set (non-null/non-blank). A null or empty template matches any response.

Body matching shares the exact dispatch used by request matching via BodyMatching, so a response body matcher has full parity with a request body matcher: XML/form actual bodies are converted to JSON for the JSON family of matchers, an optional template body matches an absent response body, multipart and binary (including original/compressed) bodies are handled, and an absent actual body against a JSON/XML matcher is a clean non-match rather than a swallowed NPE.

Cookie matching mirrors the request matcher: when the template declares structured cookies they are matched (sub-set semantics, extra response cookies allowed, notted values supported) via the same HashMapMatcher the request side uses.

Constructor Summary

Constructors

Constructor	Description
HttpResponseMatcher(Configuration configuration, MockServerLogger mockServerLogger, HttpResponse template)

Method Summary

Modifier and Type	Method	Description
boolean	matches(MatchDifference context, HttpResponse actual)	Returns true when the actual response matches the template, recording per-field differences into context when it is non-null.
boolean	matches(HttpResponse actual)	Returns true when the actual response matches the template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HttpResponseMatcher

public HttpResponseMatcher(Configuration configuration,
 MockServerLogger mockServerLogger,
 HttpResponse template)

Method Details

matches

public boolean matches(HttpResponse actual)

Returns true when the actual response matches the template. A null template matches everything.

matches

public boolean matches(MatchDifference context,
 HttpResponse actual)

Returns true when the actual response matches the template, recording per-field differences into context when it is non-null. The boolean result is identical to matches(HttpResponse).

Response fields are bucketed onto existing MatchDifference.Field constants rather than introducing new enum constants: Field is the shared field vocabulary established by the request matcher, and any code that enumerates Field.values() would observe a longer array if response-only constants were added. statusCode and reasonPhrase both record under MatchDifference.Field.OPERATION (a neutral bucket); headers, cookies and body use their natural MatchDifference.Field.HEADERS, MatchDifference.Field.COOKIES and MatchDifference.Field.BODY buckets.