Package com.auth0.jwk

Class GuavaCachedJwkProvider

java.lang.Object

com.auth0.jwk.GuavaCachedJwkProvider

All Implemented Interfaces:

JwkProvider

public class GuavaCachedJwkProvider
extends Object
implements JwkProvider

Jwk provider that caches previously obtained Jwk in memory using a Google Guava cache

Constructor Summary

Constructors

Constructor	Description
GuavaCachedJwkProvider(JwkProvider provider)	Creates a new provider that will cache up to 5 jwks for at most 10 minutes
GuavaCachedJwkProvider(JwkProvider provider, long size, long expiresIn, TimeUnit expiresUnit)	Creates a new cached provider specifying cache size and ttl
GuavaCachedJwkProvider(JwkProvider provider, long size, Duration expiresIn)	Creates a new cached provider specifying cache size and ttl

Method Summary

Modifier and Type	Method	Description
Jwk	get(String keyId)	Attempts to get a JWK using the Key ID value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GuavaCachedJwkProvider

public GuavaCachedJwkProvider(JwkProvider provider)

Creates a new provider that will cache up to 5 jwks for at most 10 minutes

Parameters:

provider - fallback provider to use when jwk is not cached

GuavaCachedJwkProvider

public GuavaCachedJwkProvider(JwkProvider provider,
 long size,
 long expiresIn,
 TimeUnit expiresUnit)

Creates a new cached provider specifying cache size and ttl

Parameters:

provider - fallback provider to use when jwk is not cached

size - number of jwk to cache

expiresIn - amount of time a jwk will live in the cache

expiresUnit - unit of the expiresIn parameter

GuavaCachedJwkProvider

public GuavaCachedJwkProvider(JwkProvider provider,
 long size,
 Duration expiresIn)

Creates a new cached provider specifying cache size and ttl

Parameters:

provider - fallback provider to use when jwk is not cached

size - number of jwt to cache

expiresIn - amount of time a jwk will live in the cache

Method Details

get

public Jwk get(String keyId)
        throws JwkException

Description copied from interface: JwkProvider

Attempts to get a JWK using the Key ID value. Note that implementations are synchronous (blocking).

Specified by:

get in interface JwkProvider

Parameters:

keyId - value of the kid found in a JWT

Returns:

a JWK

Throws:

SigningKeyNotFoundException - if no jwk can be found using the given kid

JwkException