Package org.mockserver.matchers

Class JwtMatcher

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.matchers.JwtMatcher

All Implemented Interfaces:

Matcher<String>

public class JwtMatcher
extends ObjectWithReflectiveEqualsHashCodeToString
implements Matcher<String>

Matches an expectation's Jwt criteria against the JSON Web Token carried in a request header.

The matcher reads the configured header from the request, strips the configured scheme prefix (default Bearer, case-insensitive), splits the token into its header.payload.signature segments and base64url-decodes the header and payload segments into JSON. Claim criteria are matched against the payload; the algorithm convenience criterion is matched against the JOSE header alg. See Jwt for the full description of the criteria and their NottableString (regex / negation) semantics.

No signature verification is performed — this is request matching for test routing only. A blank criterion matches every request; a non-blank criterion never matches a request whose header is absent or whose token is malformed (a clean non-match, never an exception).

Author:

jamesdbloom

Method Summary

Modifier and Type	Method	Description
String[]	fieldsExcludedFromEqualsAndHashCode()
String	getHeaderName()	The request header from which the JWT is read (default authorization).
boolean	isBlank()
boolean	matches(MatchDifference context, String headerValue)

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getHeaderName

public String getHeaderName()

The request header from which the JWT is read (default authorization). Exposed so the request matcher can extract the header value to match against.

isBlank

public boolean isBlank()

Specified by:

isBlank in interface Matcher<String>

matches

public boolean matches(MatchDifference context,
 String headerValue)

Specified by:

matches in interface Matcher<String>

fieldsExcludedFromEqualsAndHashCode

public String[] fieldsExcludedFromEqualsAndHashCode()

Overrides:

fieldsExcludedFromEqualsAndHashCode in class ObjectWithReflectiveEqualsHashCodeToString