io.jsonwebtoken.security

Interface JwkSet

All Superinterfaces:

Iterable<Jwk<?>>, Map<String,Object>

public interface JwkSet
extends Map<String,Object>, Iterable<Jwk<?>>

A JWK Set is an immutable JSON Object that represents a Set of Jwks as defined by RFC 7517 JWK Set Format. Per that specification, any number of name/value pairs may be present in a JwkSet, but only a non-empty keys set MUST be present.

Immutability

JWK Sets are immutable and cannot be changed after they are created. JwkSet extends the Map interface purely out of convenience: to allow easy marshalling to JSON as well as name/value pair access and key/value iteration, and other conveniences provided by the Map interface. Attempting to call any of the Map interface's mutation methods however (such as put, remove, clear, etc) will throw an UnsupportedOperationException.

Since:

0.12.0

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
Set<Jwk<?>>	getKeys() Returns the non-null, non-empty set of JWKs contained within the JwkSet.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getKeys

Set<Jwk<?>> getKeys()

Returns the non-null, non-empty set of JWKs contained within the JwkSet.

Returns:

the non-null, non-empty set of JWKs contained within the JwkSet.