Package io.quarkus.oidc.client

Class OidcClientConfig

java.lang.Object
io.quarkus.oidc.common.runtime.OidcCommonConfig
io.quarkus.oidc.common.runtime.OidcClientCommonConfig
io.quarkus.oidc.client.OidcClientConfig
All Implemented Interfaces:
OidcClientConfig, io.quarkus.oidc.common.runtime.config.OidcClientCommonConfig, io.quarkus.oidc.common.runtime.config.OidcCommonConfig
@Deprecated(since="3.18", forRemoval=true) public class OidcClientConfig extends io.quarkus.oidc.common.runtime.OidcClientCommonConfig implements OidcClientConfig
Deprecated, for removal: This API element is subject to removal in a future version.
create OidcClientConfig with the OidcClientConfigBuilder for example, you can use the OidcClientConfig.builder() method.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    OidcClientConfig.Grant
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Nested classes/interfaces inherited from class io.quarkus.oidc.common.runtime.OidcClientCommonConfig

    io.quarkus.oidc.common.runtime.OidcClientCommonConfig.Credentials

    Nested classes/interfaces inherited from class io.quarkus.oidc.common.runtime.OidcCommonConfig

    io.quarkus.oidc.common.runtime.OidcCommonConfig.Proxy, io.quarkus.oidc.common.runtime.OidcCommonConfig.Tls

    Nested classes/interfaces inherited from interface io.quarkus.oidc.common.runtime.config.OidcClientCommonConfig

    io.quarkus.oidc.common.runtime.config.OidcClientCommonConfig.Credentials

    Nested classes/interfaces inherited from interface io.quarkus.oidc.common.runtime.config.OidcCommonConfig

    io.quarkus.oidc.common.runtime.config.OidcCommonConfig.Proxy, io.quarkus.oidc.common.runtime.config.OidcCommonConfig.Tls

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    boolean
    absoluteExpiresIn
    Deprecated, for removal: This API element is subject to removal in a future version.
    If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time.
    Optional<Duration>
    accessTokenExpiresIn
    Deprecated, for removal: This API element is subject to removal in a future version.
    Access token expiration period relative to the current time.
    Optional<Duration>
    accessTokenExpirySkew
    Deprecated, for removal: This API element is subject to removal in a future version.
    Access token expiry time skew that can be added to the calculated token expiry time.
    (package private) Optional<List<String>>
    audience
    Deprecated, for removal: This API element is subject to removal in a future version.
    List of access token audiences
    boolean
    clientEnabled
    Deprecated, for removal: This API element is subject to removal in a future version.
    If this client configuration is enabled.
    boolean
    earlyTokensAcquisition
    Deprecated, for removal: This API element is subject to removal in a future version.
    Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used.
    OidcClientConfig.Grant
    grant
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Map<String,Map<String,String>>
    grantOptions
    Deprecated, for removal: This API element is subject to removal in a future version.
    Grant options
    Map<String,String>
    headers
    Deprecated, for removal: This API element is subject to removal in a future version.
    Custom HTTP headers which have to be sent to the token endpoint
    Optional<String>
    id
    Deprecated, for removal: This API element is subject to removal in a future version.
    A unique OIDC client identifier.
    Optional<Duration>
    refreshTokenTimeSkew
    Deprecated, for removal: This API element is subject to removal in a future version.
    Refresh token time skew.
    Optional<List<String>>
    scopes
    Deprecated, for removal: This API element is subject to removal in a future version.
    List of access token scopes

    Fields inherited from class io.quarkus.oidc.common.runtime.OidcClientCommonConfig

    clientId, clientName, credentials, revokePath, tokenPath

    Fields inherited from class io.quarkus.oidc.common.runtime.OidcCommonConfig

    authServerUrl, connectionDelay, connectionRetryCount, connectionTimeout, discoveryEnabled, followRedirects, maxPoolSize, proxy, registrationPath, tls, useBlockingDnsLookup

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    absoluteExpiresIn()
    Deprecated, for removal: This API element is subject to removal in a future version.
    If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time.
    Optional<Duration>
    accessTokenExpiresIn()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Access token expiration period relative to the current time.
    Optional<Duration>
    accessTokenExpirySkew()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Access token expiry time skew that can be added to the calculated token expiry time.
    Optional<List<String>>
    audience()
    Deprecated, for removal: This API element is subject to removal in a future version.
    List of access token audiences
    boolean
    clientEnabled()
    Deprecated, for removal: This API element is subject to removal in a future version.
    If this client configuration is enabled.
    boolean
    earlyTokensAcquisition()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used.
    OidcClientConfig.Grant
    getGrant()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Map<String,Map<String,String>>
    getGrantOptions()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Map<String,String>
    getHeaders()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Optional<String>
    getId()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Optional<Duration>
    getRefreshTokenTimeSkew()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Optional<List<String>>
    getScopes()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    OidcClientConfig.Grant
    grant()
    Deprecated, for removal: This API element is subject to removal in a future version.
    OIDC Client grant config group.
    Map<String,Map<String,String>>
    grantOptions()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Grant options
    Map<String,String>
    headers()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Custom HTTP headers which have to be sent to the token endpoint
    Optional<String>
    id()
    Deprecated, for removal: This API element is subject to removal in a future version.
    A unique OIDC client identifier.
    boolean
    isAbsoluteExpiresIn()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isClientEnabled()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Optional<Duration>
    refreshInterval()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Token refresh interval.
    Optional<Duration>
    refreshTokenTimeSkew()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Refresh token time skew.
    Optional<List<String>>
    scopes()
    Deprecated, for removal: This API element is subject to removal in a future version.
    List of access token scopes
    void
    setAbsoluteExpiresIn(boolean absoluteExpiresIn)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setClientEnabled(boolean clientEnabled)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setGrant(OidcClientConfig.Grant grant)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setGrantOptions(Map<String,Map<String,String>> grantOptions)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setHeaders(Map<String,String> headers)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setId(String id)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setRefreshTokenTimeSkew(Duration refreshTokenTimeSkew)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setScopes(List<String> scopes)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class io.quarkus.oidc.common.runtime.OidcClientCommonConfig

    clientId, clientName, credentials, getClientId, getClientName, getCredentials, getRevokePath, getTokenPath, revokePath, setClientId, setClientName, setCredentials, setRevokePath, setTokenPath, tokenPath

    Methods inherited from class io.quarkus.oidc.common.runtime.OidcCommonConfig

    authServerUrl, connectionDelay, connectionRetryCount, connectionTimeout, discoveryEnabled, followRedirects, getAuthServerUrl, getConnectionDelay, getConnectionTimeout, getDiscoveryEnabled, getMaxPoolSize, getProxy, getRegistrationPath, isDiscoveryEnabled, maxPoolSize, proxy, registrationPath, setAuthServerUrl, setConnectionDelay, setConnectionTimeout, setDiscoveryEnabled, setDiscoveryEnabled, setMaxPoolSize, setProxy, setRegistrationPath, tls, useBlockingDnsLookup

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface io.quarkus.oidc.common.runtime.config.OidcClientCommonConfig

    clientId, clientName, credentials, revokePath, tokenPath

    Methods inherited from interface io.quarkus.oidc.common.runtime.config.OidcCommonConfig

    authServerUrl, connectionDelay, connectionRetryCount, connectionTimeout, discoveryEnabled, followRedirects, maxPoolSize, proxy, registrationPath, tls, useBlockingDnsLookup

  • Field Details

    • id

      public Optional<String> id
      Deprecated, for removal: This API element is subject to removal in a future version.
      A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases.

    • clientEnabled

      public boolean clientEnabled
      Deprecated, for removal: This API element is subject to removal in a future version.
      If this client configuration is enabled.

    • scopes

      public Optional<List<String>> scopes
      Deprecated, for removal: This API element is subject to removal in a future version.
      List of access token scopes

    • audience

      Optional<List<String>> audience
      Deprecated, for removal: This API element is subject to removal in a future version.
      List of access token audiences

    • refreshTokenTimeSkew

      public Optional<Duration> refreshTokenTimeSkew
      Deprecated, for removal: This API element is subject to removal in a future version.
      Refresh token time skew. If this property is enabled then the configured duration is converted to seconds and is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen.

    • accessTokenExpiresIn

      public Optional<Duration> accessTokenExpiresIn
      Deprecated, for removal: This API element is subject to removal in a future version.
      Access token expiration period relative to the current time. This property is only checked when an access token grant response does not include an access token expiration property.

    • accessTokenExpirySkew

      public Optional<Duration> accessTokenExpirySkew
      Deprecated, for removal: This API element is subject to removal in a future version.
      Access token expiry time skew that can be added to the calculated token expiry time.

    • absoluteExpiresIn

      public boolean absoluteExpiresIn
      Deprecated, for removal: This API element is subject to removal in a future version.
      If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time.

    • grant

      public OidcClientConfig.Grant grant
      Deprecated, for removal: This API element is subject to removal in a future version.

    • grantOptions

      public Map<String,Map<String,String>> grantOptions
      Deprecated, for removal: This API element is subject to removal in a future version.
      Grant options

    • earlyTokensAcquisition

      public boolean earlyTokensAcquisition
      Deprecated, for removal: This API element is subject to removal in a future version.
      Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used. This property should be disabled if the access token may expire before it is used for the first time and no refresh token is available.

    • headers

      public Map<String,String> headers
      Deprecated, for removal: This API element is subject to removal in a future version.
      Custom HTTP headers which have to be sent to the token endpoint

  • Constructor Details

    • OidcClientConfig

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

    • OidcClientConfig

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

  • Method Details

    • id

      public Optional<String> id()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases.
      Specified by:
      id in interface OidcClientConfig

    • clientEnabled

      public boolean clientEnabled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      If this client configuration is enabled.
      Specified by:
      clientEnabled in interface OidcClientConfig

    • scopes

      public Optional<List<String>> scopes()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      List of access token scopes
      Specified by:
      scopes in interface OidcClientConfig

    • audience

      public Optional<List<String>> audience()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      List of access token audiences
      Specified by:
      audience in interface OidcClientConfig

    • refreshTokenTimeSkew

      public Optional<Duration> refreshTokenTimeSkew()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      Refresh token time skew. If this property is enabled then the configured duration is converted to seconds and is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen.
      Specified by:
      refreshTokenTimeSkew in interface OidcClientConfig

    • accessTokenExpiresIn

      public Optional<Duration> accessTokenExpiresIn()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      Access token expiration period relative to the current time. This property is only checked when an access token grant response does not include an access token expiration property.
      Specified by:
      accessTokenExpiresIn in interface OidcClientConfig

    • accessTokenExpirySkew

      public Optional<Duration> accessTokenExpirySkew()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      Access token expiry time skew that can be added to the calculated token expiry time.
      Specified by:
      accessTokenExpirySkew in interface OidcClientConfig

    • absoluteExpiresIn

      public boolean absoluteExpiresIn()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time.
      Specified by:
      absoluteExpiresIn in interface OidcClientConfig

    • grant

      public OidcClientConfig.Grant grant()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      OIDC Client grant config group.
      Specified by:
      grant in interface OidcClientConfig

    • grantOptions

      public Map<String,Map<String,String>> grantOptions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      Grant options
      Specified by:
      grantOptions in interface OidcClientConfig

    • earlyTokensAcquisition

      public boolean earlyTokensAcquisition()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used. This property should be disabled if the access token may expire before it is used for the first time and no refresh token is available.
      Specified by:
      earlyTokensAcquisition in interface OidcClientConfig

    • headers

      public Map<String,String> headers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      Custom HTTP headers which have to be sent to the token endpoint
      Specified by:
      headers in interface OidcClientConfig

    • refreshInterval

      public Optional<Duration> refreshInterval()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcClientConfig
      Token refresh interval. By default, OIDC client refreshes the token during the current request, when it detects that it has expired, or nearly expired if the OidcClientConfig.refreshTokenTimeSkew() is configured. But, when this property is configured, OIDC client can refresh the token asynchronously in the configured interval. This property is only effective with OIDC client filters and other AbstractTokensProducer extensions, but not when you use the OidcClient.getTokens() API directly.
      Specified by:
      refreshInterval in interface OidcClientConfig

    • getId

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

    • setId

      public void setId(String id)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getGrantOptions

      public Map<String,Map<String,String>> getGrantOptions()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setGrantOptions

      public void setGrantOptions(Map<String,Map<String,String>> grantOptions)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isClientEnabled

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

    • setClientEnabled

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

    • getScopes

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

    • setScopes

      public void setScopes(List<String> scopes)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRefreshTokenTimeSkew

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

    • setRefreshTokenTimeSkew

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

    • getHeaders

      public Map<String,String> getHeaders()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setHeaders

      public void setHeaders(Map<String,String> headers)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isAbsoluteExpiresIn

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

    • setAbsoluteExpiresIn

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

    • setGrant

      public void setGrant(OidcClientConfig.Grant grant)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getGrant

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