Package com.nimbusds.jose.jwk.source

Class JWKSourceWithFailover<C extends SecurityContext>

java.lang.Object

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

All Implemented Interfaces:

JWKSource<C>, Closeable, AutoCloseable

@ThreadSafe
public class JWKSourceWithFailover<C extends SecurityContext>
extends Object
implements JWKSource<C>, Closeable

JWK source with optional failover.

Version:

2022-08-24

Author:

Thomas Rørvik Skjølberg, Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor	Description
JWKSourceWithFailover(JWKSource<C> jwkSource, JWKSource<C> failoverJWKSource)	Creates a new JWK source with optional failover.

Method Summary

Modifier and Type	Method	Description
void	close()
List<JWK>	get(JWKSelector jwkSelector, C context)	Retrieves a list of JWKs matching the specified selector.

Methods inherited from class java.lang.Object

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

Constructor Details

JWKSourceWithFailover

public JWKSourceWithFailover(JWKSource<C> jwkSource,
 JWKSource<C> failoverJWKSource)

Creates a new JWK source with optional failover.

Parameters:

jwkSource - The primary JWK source. Must not be null.

failoverJWKSource - Optional failover JWK source if retrieval from the primary JWK source fails, null if no failover.

Method Details

get

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

Description copied from interface: JWKSource

Retrieves a list of JWKs matching the specified selector.

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.

Throws:

KeySourceException - If key sourcing failed.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable