Package io.quarkus.oidc

Class OidcTenantConfig.Jwks

java.lang.Object
io.quarkus.oidc.OidcTenantConfig.Jwks
All Implemented Interfaces:
OidcTenantConfig.Jwks
Enclosing class:
OidcTenantConfig
@Deprecated(since="3.18", forRemoval=true) public static class OidcTenantConfig.Jwks extends Object implements OidcTenantConfig.Jwks
Deprecated, for removal: This API element is subject to removal in a future version.
use the OidcTenantConfigBuilder.JwksBuilder builder

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    cacheSize
    Deprecated, for removal: This API element is subject to removal in a future version.
    Maximum number of JWK keys that can be cached.
    Duration
    cacheTimeToLive
    Deprecated, for removal: This API element is subject to removal in a future version.
    Number of minutes a JWK key can be cached for.
    Optional<Duration>
    cleanUpTimerInterval
    Deprecated, for removal: This API element is subject to removal in a future version.
    Cache timer interval.
    boolean
    resolveEarly
    Deprecated, for removal: This API element is subject to removal in a future version.
    If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.
    boolean
    tryAll
    Deprecated, for removal: This API element is subject to removal in a future version.
    In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t#S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Jwks()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    cacheSize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Maximum number of JWK keys that can be cached.
    Duration
    cacheTimeToLive()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Number of minutes a JWK key can be cached for.
    Optional<Duration>
    cleanUpTimerInterval()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Cache timer interval.
    int
    getCacheSize()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Duration
    getCacheTimeToLive()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Optional<Duration>
    getCleanUpTimerInterval()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isResolveEarly()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isTryAll()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    resolveEarly()
    Deprecated, for removal: This API element is subject to removal in a future version.
    If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.
    void
    setCacheSize(int cacheSize)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setCacheTimeToLive(Duration cacheTimeToLive)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setCleanUpTimerInterval(Duration cleanUpTimerInterval)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setResolveEarly(boolean resolveEarly)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTryAll(boolean fallbackToTryAll)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    tryAll()
    Deprecated, for removal: This API element is subject to removal in a future version.
    In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t#S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • resolveEarly

      public boolean resolveEarly
      Deprecated, for removal: This API element is subject to removal in a future version.
      If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.

      Disabling this property delays the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly.

    • cacheSize

      public int cacheSize
      Deprecated, for removal: This API element is subject to removal in a future version.
      Maximum number of JWK keys that can be cached. This property is ignored if the resolveEarly property is set to true.

    • cacheTimeToLive

      public Duration cacheTimeToLive
      Deprecated, for removal: This API element is subject to removal in a future version.
      Number of minutes a JWK key can be cached for. This property is ignored if the resolveEarly property is set to true.

    • cleanUpTimerInterval

      public Optional<Duration> cleanUpTimerInterval
      Deprecated, for removal: This API element is subject to removal in a future version.
      Cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. This property is ignored if the resolveEarly property is set to true.

    • tryAll

      public boolean tryAll
      Deprecated, for removal: This API element is subject to removal in a future version.
      In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t#S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value.

  • Constructor Details

    • Jwks

      public Jwks()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getCacheSize

      public int getCacheSize()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setCacheSize

      public void setCacheSize(int cacheSize)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getCacheTimeToLive

      public Duration getCacheTimeToLive()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setCacheTimeToLive

      public void setCacheTimeToLive(Duration cacheTimeToLive)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getCleanUpTimerInterval

      public Optional<Duration> getCleanUpTimerInterval()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setCleanUpTimerInterval

      public void setCleanUpTimerInterval(Duration cleanUpTimerInterval)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isResolveEarly

      public boolean isResolveEarly()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setResolveEarly

      public void setResolveEarly(boolean resolveEarly)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isTryAll

      public boolean isTryAll()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTryAll

      public void setTryAll(boolean fallbackToTryAll)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • resolveEarly

      public boolean resolveEarly()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcTenantConfig.Jwks
      If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.

      Disabling this property delays the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly.

      Specified by:
      resolveEarly in interface OidcTenantConfig.Jwks

    • cacheSize

      public int cacheSize()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcTenantConfig.Jwks
      Maximum number of JWK keys that can be cached. This property is ignored if the OidcTenantConfig.Jwks.resolveEarly() property is set to true.
      Specified by:
      cacheSize in interface OidcTenantConfig.Jwks

    • cacheTimeToLive

      public Duration cacheTimeToLive()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcTenantConfig.Jwks
      Number of minutes a JWK key can be cached for. This property is ignored if the OidcTenantConfig.Jwks.resolveEarly() property is set to true.
      Specified by:
      cacheTimeToLive in interface OidcTenantConfig.Jwks

    • cleanUpTimerInterval

      public Optional<Duration> cleanUpTimerInterval()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcTenantConfig.Jwks
      Cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. This property is ignored if the OidcTenantConfig.Jwks.resolveEarly() property is set to true.
      Specified by:
      cleanUpTimerInterval in interface OidcTenantConfig.Jwks

    • tryAll

      public boolean tryAll()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcTenantConfig.Jwks
      In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t#S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value.
      Specified by:
      tryAll in interface OidcTenantConfig.Jwks