io.jsonwebtoken.security

Interface JwkSetParserBuilder

All Superinterfaces:

Builder<Parser<JwkSet>>, KeyOperationPolicied<JwkSetParserBuilder>, ParserBuilder<JwkSet,JwkSetParserBuilder>

public interface JwkSetParserBuilder
extends ParserBuilder<JwkSet,JwkSetParserBuilder>, KeyOperationPolicied<JwkSetParserBuilder>

A builder to construct a Parser that can parse JwkSets. Example usage:

 JwkSet jwkSet = Jwks.setParser()
         .provider(aJcaProvider)      // optional
         .json(deserializer)          // optional
         .operationPolicy(policy)     // optional
         .ignoreUnsupported(aBoolean) // optional
         .build()
         .parse(jwkSetString);

Since:

0.12.0

Method Summary

Methods

Modifier and Type	Method and Description
JwkSetParserBuilder	ignoreUnsupported(boolean ignore) Sets whether the parser should ignore any encountered JWK it does not support, either because the JWK has an unrecognized key type or the JWK was malformed (missing required parameters, etc).

Methods inherited from interface io.jsonwebtoken.io.ParserBuilder

json, provider

Methods inherited from interface io.jsonwebtoken.lang.Builder

build

Methods inherited from interface io.jsonwebtoken.security.KeyOperationPolicied

operationPolicy

Method Detail

ignoreUnsupported

JwkSetParserBuilder ignoreUnsupported(boolean ignore)

Sets whether the parser should ignore any encountered JWK it does not support, either because the JWK has an unrecognized key type or the JWK was malformed (missing required parameters, etc). The default value is true per RFC 7517, Section 5, last paragraph:

    Implementations SHOULD ignore JWKs within a JWK Set that use "kty"
    (key type) values that are not understood by them, that are missing
    required members, or for which values are out of the supported
    ranges.
 

This value may be set to false for applications that prefer stricter parsing constraints and wish to react to any MalformedKeyExceptions or UnsupportedKeyExceptions that could occur.

Parameters:

ignore - whether to ignore unsupported or malformed JWKs encountered during parsing.

Returns:

the builder for method chaining.