Package io.quarkus.oidc.common.runtime

Class OidcCommonConfig

  • public class OidcCommonConfig
extends Object

    • Field Detail

      • authServerUrl

        @ConfigItem
public Optional<String> authServerUrl
        The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. OIDC discovery endpoint will be called by default by appending a '.well-known/openid-configuration' path to this URL. Note if you work with Keycloak OIDC server, make sure the base URL is in the following format: `https://host:port/auth/realms/{realm}` where `{realm}` has to be replaced by the name of the Keycloak realm.

      • discoveryEnabled

        @ConfigItem(defaultValue="true")
public boolean discoveryEnabled
        Enables OIDC discovery. If the discovery is disabled then the 'token-path' property must be configured.

      • tokenPath

        @ConfigItem
public Optional<String> tokenPath
        Relative path of the OIDC token endpoint which issues access and refresh tokens using either 'client_credentials' or 'password' grants

      • 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

      • connectionDelay

        @ConfigItem
public Optional<Duration> connectionDelay
        The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for. The number of times the connection request will be repeated is calculated by dividing the value of this property by 2. For example, setting it to `20S` will allow for requesting the connection up to 10 times with a 2 seconds delay between the retries. Note this property is only effective when the initial OIDC connection is created, for example, when requesting a well-known OIDC configuration. Use the 'connection-retry-count' property to support trying to re-establish an already available connection which may have been dropped.

      • connectionRetryCount

        @ConfigItem(defaultValue="3")
public int connectionRetryCount
        The number of times an attempt to re-establish an already available connection will be repeated for. Note this property is different to the `connection-delay` property which is only effective during the initial OIDC connection creation. This property is used to try to recover the existing connection which may have been temporarily lost. For example, if a request to the OIDC token endpoint fails due to a connection exception then the request will be retried for a number of times configured by this property.

      • connectionTimeout

        @ConfigItem(defaultValue="10s")
public Duration connectionTimeout
        The amount of time after which the current OIDC connection request will time out.

    • Constructor Detail

      • OidcCommonConfig

        public OidcCommonConfig()

    • Method Detail

      • setConnectionDelay

        public void setConnectionDelay​(Duration connectionDelay)

      • setAuthServerUrl

        public void setAuthServerUrl​(String authServerUrl)

      • setTokenPath

        public void setTokenPath​(String tokenPath)

      • setClientId

        public void setClientId​(String clientId)

      • isDiscoveryEnabled

        public boolean isDiscoveryEnabled()

      • setDiscoveryEnabled

        public void setDiscoveryEnabled​(boolean enabled)

      • getConnectionTimeout

        public Duration getConnectionTimeout()

      • setConnectionTimeout

        public void setConnectionTimeout​(Duration connectionTimeout)