com.nimbusds.jose.jwk.source

Class RemoteJWKSet<C extends SecurityContext>

java.lang.Object

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

All Implemented Interfaces:

JWKSource<C>

@ThreadSafe
public class RemoteJWKSet<C extends SecurityContext>
extends Object
implements JWKSource<C>

Remote JSON Web Key (JWK) source specified by a JWK set URL. The retrieved JWK set is cached to minimise network calls. The cache is updated whenever the key selector tries to get a key with an unknown ID.

Version:

2016-04-10

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HTTP_CONNECT_TIMEOUT The default HTTP connect timeout for JWK set retrieval, in milliseconds.
static int	DEFAULT_HTTP_READ_TIMEOUT The default HTTP read timeout for JWK set retrieval, in milliseconds.
static int	DEFAULT_HTTP_SIZE_LIMIT The default HTTP entity size limit for JWK set retrieval, in bytes.

Constructor Summary

Constructors

Constructor and Description
RemoteJWKSet(URL jwkSetURL) Creates a new remote JWK set using the default HTTP resource retriever.
RemoteJWKSet(URL jwkSetURL, ResourceRetriever resourceRetriever) Creates a new remote JWK set.

Method Summary

Modifier and Type	Method and Description
List<JWK>	get(JWKSelector jwkSelector, C context) Retrieves a list of JWKs matching the specified selector.
protected static String	getFirstSpecifiedKeyID(JWKMatcher jwkMatcher) Returns the first specified key ID (kid) for a JWK matcher.
JWKSet	getJWKSet() Returns the cached JWK set.
URL	getJWKSetURL() Returns the JWK set URL.
ResourceRetriever	getResourceRetriever() Returns the HTTP resource retriever.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HTTP_CONNECT_TIMEOUT

public static final int DEFAULT_HTTP_CONNECT_TIMEOUT

The default HTTP connect timeout for JWK set retrieval, in milliseconds. Set to 250 milliseconds.

See Also:

Constant Field Values

DEFAULT_HTTP_READ_TIMEOUT

public static final int DEFAULT_HTTP_READ_TIMEOUT

The default HTTP read timeout for JWK set retrieval, in milliseconds. Set to 250 milliseconds.

See Also:

Constant Field Values

DEFAULT_HTTP_SIZE_LIMIT

public static final int DEFAULT_HTTP_SIZE_LIMIT

The default HTTP entity size limit for JWK set retrieval, in bytes. Set to 50 KBytes.

See Also:

Constant Field Values

Constructor Detail

RemoteJWKSet

public RemoteJWKSet(URL jwkSetURL)

Creates a new remote JWK set using the default HTTP resource retriever. Starts an asynchronous thread to fetch the JWK set from the specified URL. The JWK set is cached if successfully retrieved.

Parameters:

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

RemoteJWKSet

public RemoteJWKSet(URL jwkSetURL,
                    ResourceRetriever resourceRetriever)

Creates a new remote JWK set. Starts an asynchronous thread to fetch the JWK set from the specified URL. The JWK set is cached if successfully retrieved.

Parameters:

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

resourceRetriever - The HTTP resource retriever to use, null to use the default one.

Method Detail

getJWKSetURL

public URL getJWKSetURL()

Returns the JWK set URL.

Returns:

The JWK set URL.

getResourceRetriever

public ResourceRetriever getResourceRetriever()

Returns the HTTP resource retriever.

Returns:

The HTTP resource retriever.

getJWKSet

public JWKSet getJWKSet()

Returns the cached JWK set.

Returns:

The cached JWK set, null if none.

getFirstSpecifiedKeyID

protected static String getFirstSpecifiedKeyID(JWKMatcher jwkMatcher)

Returns the first specified key ID (kid) for a JWK matcher.

Parameters:

jwkMatcher - The JWK matcher. Must not be null.

Returns:

The first key ID, null if none.

get

public List<JWK> get(JWKSelector jwkSelector,
                     C context)

Retrieves a list of JWKs matching the specified selector. The security context is ignored.

Specified by:

get in interface JWKSource<C extends SecurityContext>

Parameters:

jwkSelector - A JWK selector. Must not be null.

context - Optional context, null if not required.

Returns:

The matching JWKs, empty list if no matches were found.