com.nimbusds.jose.jwk.source

Interface JWKSetCache

All Known Implementing Classes:

DefaultJWKSetCache

public interface JWKSetCache

JSON Web Key (JWK) set cache. Implementations should be thread-safe.

Version:

2020-03-11

Author:

Vladimir Dzhuvinov, Sarvesh Sharma

Method Summary

Modifier and Type	Method and Description
JWKSet	get() Gets the cached JWK set.
void	put(JWKSet jwkSet) Puts the specified JWK set into the cache or clears the cache.
boolean	requiresRefresh() Returns true if the cached JWK set requires a refresh.

Method Detail

put

void put(JWKSet jwkSet)

Puts the specified JWK set into the cache or clears the cache.

Parameters:

jwkSet - The JWK set to cache, null to clear the cache.

get

JWKSet get()

Gets the cached JWK set.

Returns:

The cached JWK set, null if none or expired.

requiresRefresh

boolean requiresRefresh()

Returns true if the cached JWK set requires a refresh. This should typically occur some time before the cache has expired, to allow for transient retrieval exceptions before expiration.

Returns:

true if the cached JWK set requires a refresh.