Package com.nimbusds.jose.jwk.source

Class URLBasedJWKSetSource<C extends SecurityContext>

java.lang.Object

com.nimbusds.jose.jwk.source.URLBasedJWKSetSource<C>

All Implemented Interfaces:

JWKSetSource<C>, Closeable, AutoCloseable

@ThreadSafe
public class URLBasedJWKSetSource<C extends SecurityContext>
extends Object
implements JWKSetSource<C>

JWK set source that loads the keys from a URL, without health status reporting.

Version:

2022-11-22

Author:

Thomas Rørvik Skjølberg, Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor	Description
URLBasedJWKSetSource(URL url, ResourceRetriever resourceRetriever)	Creates a new URL based JWK set source.

Method Summary

Modifier and Type	Method	Description
void	close()
JWKSet	getJWKSet(JWKSetCacheRefreshEvaluator refreshEvaluator, long currentTime, C context)	Gets the JWK set.

Methods inherited from class java.lang.Object

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

Constructor Detail

URLBasedJWKSetSource

public URLBasedJWKSetSource(URL url,
                            ResourceRetriever resourceRetriever)

Creates a new URL based JWK set source.

Parameters:

url - The JWK set URL. Must not be null.

resourceRetriever - The resource retriever to use. Must not be null.

Method Detail

getJWKSet

public JWKSet getJWKSet(JWKSetCacheRefreshEvaluator refreshEvaluator,
                        long currentTime,
                        C context)
                 throws KeySourceException

Description copied from interface: JWKSetSource

Gets the JWK set.

Specified by:

getJWKSet in interface JWKSetSource<C extends SecurityContext>

Parameters:

refreshEvaluator - Controls whether refresh of the JWK set cache (if utilised by the source) is required.

currentTime - The current time, in milliseconds since the Unix epoch.

context - Optional context, null if not required.

Returns:

The JWK set.

Throws:

KeySourceException - If JWK set retrieval failed.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException