Package io.quarkus.oidc.common.runtime

Class OidcCommonConfig

java.lang.Object
io.quarkus.oidc.common.runtime.OidcCommonConfig
public class OidcCommonConfig extends Object

  • Field Details

    • authServerUrl

      @ConfigItem public Optional<String> authServerUrl
      The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if the public key verification (#publicKey) or certificate chain verification only (#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

      @ConfigItem(defaultValueDocumentation="true") public Optional<Boolean> discoveryEnabled
      Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually.

    • tokenPath

      @ConfigItem public Optional<String> tokenPath
      The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if discoveryEnabled is `false` or a discovered token endpoint path must be customized.

    • revokePath

      @ConfigItem public Optional<String> revokePath
      The relative path or absolute URL of the OIDC token revocation endpoint.

    • clientId

      @ConfigItem public Optional<String> clientId
      The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if #applicationType is `service` and no token introspection is required.

    • clientName

      @ConfigItem public Optional<String> clientName
      The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client.

    • connectionDelay

      @ConfigItem public Optional<Duration> connectionDelay
      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

      @ConfigItem(defaultValue="3") public int connectionRetryCount
      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

      @ConfigItem(defaultValue="10s") public Duration connectionTimeout
      The number of seconds after which the current OIDC connection request times out.

    • useBlockingDnsLookup

      @ConfigItem(defaultValue="false") public boolean useBlockingDnsLookup
      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

      @ConfigItem public OptionalInt maxPoolSize
      The maximum size of the connection pool used by the WebClient.

    • credentials

      @ConfigItem public OidcCommonConfig.Credentials credentials
      Credentials the OIDC adapter uses to authenticate to the OIDC server.

    • proxy

      @ConfigItem public OidcCommonConfig.Proxy proxy
      Options to configure the proxy the OIDC adapter uses to talk with the OIDC server.

    • tls

      @ConfigItem public OidcCommonConfig.Tls tls
      TLS configurations

  • Constructor Details

    • OidcCommonConfig

      public OidcCommonConfig()

  • Method Details

    • getConnectionDelay

      public Optional<Duration> getConnectionDelay()

    • setConnectionDelay

      public void setConnectionDelay(Duration connectionDelay)

    • getAuthServerUrl

      public Optional<String> getAuthServerUrl()

    • setAuthServerUrl

      public void setAuthServerUrl(String authServerUrl)

    • getTokenPath

      public Optional<String> getTokenPath()

    • setTokenPath

      public void setTokenPath(String tokenPath)

    • getRevokePath

      public Optional<String> getRevokePath()

    • setRevokePath

      public void setRevokePath(String revokePath)

    • getClientId

      public Optional<String> getClientId()

    • setClientId

      public void setClientId(String clientId)

    • getClientName

      public Optional<String> getClientName()

    • setClientName

      public void setClientName(String clientName)

    • getCredentials

      public OidcCommonConfig.Credentials getCredentials()

    • setCredentials

      public void setCredentials(OidcCommonConfig.Credentials credentials)

    • isDiscoveryEnabled

      public Optional<Boolean> isDiscoveryEnabled()

    • setDiscoveryEnabled

      public void setDiscoveryEnabled(boolean enabled)

    • getProxy

      public OidcCommonConfig.Proxy getProxy()

    • setProxy

      public void setProxy(OidcCommonConfig.Proxy proxy)

    • getConnectionTimeout

      public Duration getConnectionTimeout()

    • setConnectionTimeout

      public void setConnectionTimeout(Duration connectionTimeout)

    • getMaxPoolSize

      public OptionalInt getMaxPoolSize()

    • setMaxPoolSize

      public void setMaxPoolSize(int maxPoolSize)