Package com.nimbusds.jose.jwk.source

Interface JWKSource<C extends SecurityContext>

All Known Implementing Classes:
ImmutableJWKSet, ImmutableSecret, JWKSecurityContextJWKSet, JWKSetBasedJWKSource, JWKSourceWithFailover, RemoteJWKSet
public interface JWKSource<C extends SecurityContext>
JSON Web Key (JWK) source. Exposes a method for retrieving JWKs matching a specified selector. An optional context parameter is available to facilitate passing of additional data between the caller and the underlying JWK source (in both directions). Implementations must be thread-safe.
Version:
2016-06-21
Author:
Vladimir Dzhuvinov

  • Method Summary

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

  • Method Details

    • get

      List<JWK> get(JWKSelector jwkSelector, C context) throws KeySourceException
      Retrieves a list of JWKs matching the specified selector.
      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.