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, OidcClientCommonConfig, OidcCommonConfig
@Deprecated(since="3.18") public class OidcClientConfig extends OidcClientCommonConfig implements OidcClientConfig
Deprecated.
create OidcClientConfig with the OidcClientConfigBuilder for example, you can use the OidcClientConfig.builder() method.

  • Field Details

    • id

      public Optional<String> id
      Deprecated.
      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.
      If this client configuration is enabled.

    • scopes

      public Optional<List<String>> scopes
      Deprecated.
      List of access token scopes

    • refreshTokenTimeSkew

      public Optional<Duration> refreshTokenTimeSkew
      Deprecated.
      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.
      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.
      Access token expiry time skew that can be added to the calculated token expiry time.

    • absoluteExpiresIn

      public boolean absoluteExpiresIn
      Deprecated.
      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.

    • grantOptions

      public Map<String,Map<String,String>> grantOptions
      Deprecated.
      Grant options

    • earlyTokensAcquisition

      public boolean earlyTokensAcquisition
      Deprecated.
      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.
      Custom HTTP headers which have to be sent to the token endpoint

  • Constructor Details

    • OidcClientConfig

      public OidcClientConfig()
      Deprecated.

    • OidcClientConfig

      public OidcClientConfig(OidcClientConfig mapping)
      Deprecated.

  • Method Details

    • id

      public Optional<String> id()
      Deprecated.
      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.
      Description copied from interface: OidcClientConfig
      If this client configuration is enabled.
      Specified by:
      clientEnabled in interface OidcClientConfig

    • scopes

      public Optional<List<String>> scopes()
      Deprecated.
      Description copied from interface: OidcClientConfig
      List of access token scopes
      Specified by:
      scopes in interface OidcClientConfig

    • refreshTokenTimeSkew

      public Optional<Duration> refreshTokenTimeSkew()
      Deprecated.
      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.
      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.
      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.
      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.
      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.
      Description copied from interface: OidcClientConfig
      Grant options
      Specified by:
      grantOptions in interface OidcClientConfig

    • earlyTokensAcquisition

      public boolean earlyTokensAcquisition()
      Deprecated.
      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.
      Description copied from interface: OidcClientConfig
      Custom HTTP headers which have to be sent to the token endpoint
      Specified by:
      headers in interface OidcClientConfig

    • getId

      public Optional<String> getId()
      Deprecated.

    • setId

      public void setId(String id)
      Deprecated.

    • getGrantOptions

      public Map<String,Map<String,String>> getGrantOptions()
      Deprecated.

    • setGrantOptions

      public void setGrantOptions(Map<String,Map<String,String>> grantOptions)
      Deprecated.

    • isClientEnabled

      public boolean isClientEnabled()
      Deprecated.

    • setClientEnabled

      public void setClientEnabled(boolean clientEnabled)
      Deprecated.

    • getScopes

      public Optional<List<String>> getScopes()
      Deprecated.

    • setScopes

      public void setScopes(List<String> scopes)
      Deprecated.

    • getRefreshTokenTimeSkew

      public Optional<Duration> getRefreshTokenTimeSkew()
      Deprecated.

    • setRefreshTokenTimeSkew

      public void setRefreshTokenTimeSkew(Duration refreshTokenTimeSkew)
      Deprecated.

    • getHeaders

      public Map<String,String> getHeaders()
      Deprecated.

    • setHeaders

      public void setHeaders(Map<String,String> headers)
      Deprecated.

    • isAbsoluteExpiresIn

      public boolean isAbsoluteExpiresIn()
      Deprecated.

    • setAbsoluteExpiresIn

      public void setAbsoluteExpiresIn(boolean absoluteExpiresIn)
      Deprecated.

    • setGrant

      public void setGrant(OidcClientConfig.Grant grant)
      Deprecated.

    • getGrant

      public OidcClientConfig.Grant getGrant()
      Deprecated.