Package org.mockserver.model

Class Jwt

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.model.Jwt

public class Jwt
extends ObjectWithJsonToString

Expectation criteria for matching a JSON Web Token (JWT) carried in a request header.

The token is read from the header named by header (default authorization), the scheme prefix (default Bearer) is stripped, and the token's header.payload segments are decoded with base64url + JSON. No signature verification is performed — this is request matching for test routing, not authentication. Control-plane JWT authentication (the authentication/ stack) is a separate concern and is unaffected by this matcher.

A request is matched when every configured criterion matches the decoded token:

• claims — each entry asserts the value of a claim in the JWT payload. The value is a NottableString so exact, regex and ! negation forms are all supported (e.g. {"sub":"user-1","scope":".*admin.*"}). A positive criterion whose claim is absent from the token never matches; a negated criterion (e.g. !admin) against an absent claim matches vacuously — there is no value to contradict it. The same holds for the issuer, audience and algorithm convenience criteria.
• issuer — convenience criterion for the iss claim.
• audience — convenience criterion for the aud claim (which may be a single string or an array; a match against any array element is a match).
• algorithm — convenience criterion for the JOSE header alg field.

A malformed or absent token never matches a non-blank Jwt criterion (and never surfaces an exception to the caller).

Author:

jamesdbloom

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_HEADER
static final String	DEFAULT_SCHEME

Constructor Summary

Constructors

Constructor	Description
Jwt()

Method Summary

Modifier and Type	Method	Description
Jwt	clone()
boolean	equals(Object o)
NottableString	getAlgorithm()
NottableString	getAudience()
Map<String,NottableString>	getClaims()
String	getHeader()
NottableString	getIssuer()
String	getScheme()
int	hashCode()
static Jwt	jwt()
Jwt	withAlgorithm(String algorithm)
Jwt	withAlgorithm(NottableString algorithm)
Jwt	withAudience(String audience)
Jwt	withAudience(NottableString audience)
Jwt	withClaim(String name, String value)	Add a single claim-value criterion.
Jwt	withClaim(String name, NottableString value)
Jwt	withClaims(Map<String,NottableString> claims)
Jwt	withHeader(String header)	The name of the request header carrying the JWT (default authorization).
Jwt	withIssuer(String issuer)
Jwt	withIssuer(NottableString issuer)
Jwt	withScheme(String scheme)	The authentication scheme prefix stripped from the header value before decoding (default Bearer).

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

fieldsExcludedFromEqualsAndHashCode

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_HEADER

public static final String DEFAULT_HEADER

See Also:

• Constant Field Values

DEFAULT_SCHEME

public static final String DEFAULT_SCHEME

See Also:

• Constant Field Values

Constructor Details

Jwt

public Jwt()

Method Details

jwt

public static Jwt jwt()

getHeader

public String getHeader()

withHeader

public Jwt withHeader(String header)

The name of the request header carrying the JWT (default authorization).

getScheme

public String getScheme()

withScheme

public Jwt withScheme(String scheme)

The authentication scheme prefix stripped from the header value before decoding (default Bearer). Matched case-insensitively; a blank scheme means the header value is treated as the raw token.

getClaims

public Map<String,NottableString> getClaims()

withClaims

public Jwt withClaims(Map<String,NottableString> claims)

withClaim

public Jwt withClaim(String name,
 String value)

Add a single claim-value criterion. The value is parsed as a NottableString so a regex or !-negated form is honoured.

withClaim

public Jwt withClaim(String name,
 NottableString value)

getIssuer

public NottableString getIssuer()

withIssuer

public Jwt withIssuer(NottableString issuer)

withIssuer

public Jwt withIssuer(String issuer)

getAudience

public NottableString getAudience()

withAudience

public Jwt withAudience(NottableString audience)

withAudience

public Jwt withAudience(String audience)

getAlgorithm

public NottableString getAlgorithm()

withAlgorithm

public Jwt withAlgorithm(NottableString algorithm)

withAlgorithm

public Jwt withAlgorithm(String algorithm)

clone

public Jwt clone()

Overrides:

clone in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class ObjectWithReflectiveEqualsHashCodeToString

hashCode

public int hashCode()

Overrides:

hashCode in class ObjectWithReflectiveEqualsHashCodeToString