com.auth0.jwk

Class JwkProviderBuilder

java.lang.Object

com.auth0.jwk.JwkProviderBuilder

public class JwkProviderBuilder
extends java.lang.Object

JwkProvider builder

Constructor Summary

Constructors

Constructor and Description
JwkProviderBuilder(java.lang.String domain) Creates a new Builder with a domain where to look for the jwks.
JwkProviderBuilder(java.net.URL url) Creates a new Builder with the given URL where to load the jwks from.

Method Summary

Modifier and Type	Method and Description
JwkProvider	build() Creates a JwkProvider
JwkProviderBuilder	cached(boolean cached) Toggle the cache of Jwk.
JwkProviderBuilder	cached(long cacheSize, long expiresIn, java.util.concurrent.TimeUnit unit) Enable the cache specifying size and expire time.
JwkProviderBuilder	rateLimited(boolean rateLimited) Toggle the rate limit of Jwk.
JwkProviderBuilder	rateLimited(long bucketSize, long refillRate, java.util.concurrent.TimeUnit unit) Enable the cache specifying size and expire time.

Methods inherited from class java.lang.Object

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

Constructor Detail

JwkProviderBuilder

public JwkProviderBuilder(java.net.URL url)

Creates a new Builder with the given URL where to load the jwks from.

Parameters:

url - to load the jwks

Throws:

java.lang.IllegalStateException - if url is null

JwkProviderBuilder

public JwkProviderBuilder(java.lang.String domain)

Creates a new Builder with a domain where to look for the jwks.

It can be a url link 'https://samples.auth0.com' or just a domain 'samples.auth0.com'. If the protocol (http or https) is not provided then https is used by default. The default jwks path "/.well-known/jwks.json" is appended to the given string domain.

For example, when the domain is "samples.auth0.com" the jwks url that will be used is "https://samples.auth0.com/.well-known/jwks.json"

Use JwkProviderBuilder(URL) if you need to pass a full URL.

Parameters:

domain - where jwks is published

Throws:

java.lang.IllegalStateException - if domain is null

See Also:

UrlJwkProvider.UrlJwkProvider(String)

Method Detail

cached

public JwkProviderBuilder cached(boolean cached)

Toggle the cache of Jwk. By default the provider will use cache.

Parameters:

cached - if the provider should cache jwks

Returns:

the builder

cached

public JwkProviderBuilder cached(long cacheSize,
                                 long expiresIn,
                                 java.util.concurrent.TimeUnit unit)

Enable the cache specifying size and expire time.

Parameters:

cacheSize - number of jwk to cache

expiresIn - amount of time the jwk will be cached

unit - unit of time for the expire of jwk

Returns:

the builder

rateLimited

public JwkProviderBuilder rateLimited(boolean rateLimited)

Toggle the rate limit of Jwk. By default the Provider will use rate limit.

Parameters:

rateLimited - if the provider should rate limit jwks

Returns:

the builder

rateLimited

public JwkProviderBuilder rateLimited(long bucketSize,
                                      long refillRate,
                                      java.util.concurrent.TimeUnit unit)

Enable the cache specifying size and expire time.

Parameters:

bucketSize - max number of jwks to deliver in the given rate.

refillRate - amount of time to wait before a jwk can the jwk will be cached

unit - unit of time for the expire of jwk

Returns:

the builder

build

public JwkProvider build()

Creates a JwkProvider

Returns:

a newly created JwkProvider