Package io.quarkus.oidc.common.runtime

Class OidcCommonConfig

java.lang.Object
io.quarkus.oidc.common.runtime.OidcCommonConfig
All Implemented Interfaces:
OidcCommonConfig
Direct Known Subclasses:
OidcClientCommonConfig
public abstract class OidcCommonConfig extends Object implements OidcCommonConfig

  • Field Details

    • authServerUrl

      @Deprecated(since="3.18", forRemoval=true) public Optional<String> authServerUrl
      Deprecated, for removal: This API element is subject to removal in a future version.
      use authServerUrl() method instead
      The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (
      invalid reference 
      #publicKey
      ) or certificate chain verification only (
      invalid reference 
      #certificateChain
      ) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/{realm}`, replacing `{realm}` with the Keycloak realm name.

    • discoveryEnabled

      @Deprecated(since="3.18", forRemoval=true) public Optional<Boolean> discoveryEnabled
      Deprecated, for removal: This API element is subject to removal in a future version.
      use discoveryEnabled() method instead
      Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually.

    • registrationPath

      @Deprecated(since="3.18", forRemoval=true) public Optional<String> registrationPath
      Deprecated, for removal: This API element is subject to removal in a future version.
      use registrationPath() method instead
      The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if discoveryEnabled is `false` or a discovered token endpoint path must be customized.

    • connectionDelay

      @Deprecated(since="3.18", forRemoval=true) public Optional<Duration> connectionDelay
      Deprecated, for removal: This API element is subject to removal in a future version.
      use connectionDelay() method instead
      The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead.

    • connectionRetryCount

      @Deprecated(since="3.18", forRemoval=true) public int connectionRetryCount
      Deprecated, for removal: This API element is subject to removal in a future version.
      use connectionRetryCount() method instead
      The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting.

    • connectionTimeout

      @Deprecated(since="3.18", forRemoval=true) public Duration connectionTimeout
      Deprecated, for removal: This API element is subject to removal in a future version.
      use connectionTimeout() method instead
      The number of seconds after which the current OIDC connection request times out.

    • useBlockingDnsLookup

      @Deprecated(since="3.18", forRemoval=true) public boolean useBlockingDnsLookup
      Deprecated, for removal: This API element is subject to removal in a future version.
      use useBlockingDnsLookup() method instead
      Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server.

    • maxPoolSize

      @Deprecated(since="3.18", forRemoval=true) public OptionalInt maxPoolSize
      Deprecated, for removal: This API element is subject to removal in a future version.
      use maxPoolSize() method instead
      The maximum size of the connection pool used by the WebClient.

    • followRedirects

      @Deprecated(since="3.18", forRemoval=true) public boolean followRedirects
      Deprecated, for removal: This API element is subject to removal in a future version.
      use followRedirects() method instead
      Follow redirects automatically when WebClient gets HTTP 302. When this property is disabled only a single redirect to exactly the same original URI is allowed but only if one or more cookies were set during the redirect request.

    • proxy

      @Deprecated(since="3.18", forRemoval=true) public OidcCommonConfig.Proxy proxy
      Deprecated, for removal: This API element is subject to removal in a future version.
      use proxy() method instead
      Options to configure the proxy the OIDC adapter uses to talk with the OIDC server.

    • tls

      @Deprecated(since="3.18", forRemoval=true) public OidcCommonConfig.Tls tls
      Deprecated, for removal: This API element is subject to removal in a future version.
      use tls() method instead
      TLS configurations

  • Constructor Details

    • OidcCommonConfig

      public OidcCommonConfig()

    • OidcCommonConfig

      protected OidcCommonConfig(OidcCommonConfig mapping)

  • Method Details