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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classDeprecated.static classDeprecated.useOidcCommonConfigBuilderto create the TLS config -
Field Summary
FieldsModifier and TypeFieldDescriptionDeprecated.useauthServerUrl()method insteadDeprecated.useconnectionDelay()method insteadintDeprecated.useconnectionRetryCount()method insteadDeprecated.useconnectionTimeout()method insteadDeprecated.usediscoveryEnabled()method insteadbooleanDeprecated.usefollowRedirects()method insteadDeprecated.usemaxPoolSize()method insteadDeprecated.useproxy()method insteadDeprecated.useregistrationPath()method insteadDeprecated.usetls()method insteadbooleanDeprecated.useuseBlockingDnsLookup()method instead -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`.The duration to attempt the initial connection to an OIDC server.intThe number of times to retry re-establishing an existing OIDC connection if it is temporarily lost.The number of seconds after which the current OIDC connection request times out.Discovery of the OIDC endpoints.booleanFollow redirects automatically when WebClient gets HTTP 302.Deprecated.use theauthServerUrl()method insteadDeprecated.use theconnectionDelay()method insteadDeprecated.use theconnectionTimeout()method insteadDeprecated.use thediscoveryEnabled()method insteadDeprecated.use themaxPoolSize()method insteadgetProxy()Deprecated.use theproxy()method insteadDeprecated.use theregistrationPath()method insteadDeprecated.use thediscoveryEnabled()method insteadThe maximum size of the connection pool used by the WebClient.proxy()HTTP proxy configuration.The relative path or absolute URL of the OIDC dynamic client registration endpoint.voidsetAuthServerUrl(String authServerUrl) Deprecated.voidsetConnectionDelay(Duration connectionDelay) Deprecated.voidsetConnectionTimeout(Duration connectionTimeout) Deprecated.voidsetDiscoveryEnabled(boolean enabled) Deprecated.voidsetDiscoveryEnabled(Boolean discoveryEnabled) Deprecated.voidsetMaxPoolSize(int maxPoolSize) Deprecated.voidsetProxy(OidcCommonConfig.Proxy proxy) Deprecated.voidsetRegistrationPath(String registrationPath) Deprecated.tls()TLS configuration.booleanWhether DNS lookup should be performed on the worker thread.
-
Field Details
-
authServerUrl
Deprecated.useauthServerUrl()method insteadThe 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 (#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
Deprecated.usediscoveryEnabled()method insteadDiscovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. -
registrationPath
Deprecated.useregistrationPath()method insteadThe relative path or absolute URL of the OIDC dynamic client registration endpoint. Set ifdiscoveryEnabledis `false` or a discovered token endpoint path must be customized. -
connectionDelay
Deprecated.useconnectionDelay()method insteadThe 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.useconnectionRetryCount()method insteadThe 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.useconnectionTimeout()method insteadThe number of seconds after which the current OIDC connection request times out. -
useBlockingDnsLookup
Deprecated.useuseBlockingDnsLookup()method insteadWhether 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.usemaxPoolSize()method insteadThe maximum size of the connection pool used by the WebClient. -
followRedirects
Deprecated.usefollowRedirects()method insteadFollow 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.useproxy()method insteadOptions to configure the proxy the OIDC adapter uses to talk with the OIDC server. -
tls
Deprecated.usetls()method insteadTLS configurations
-
-
Constructor Details
-
OidcCommonConfig
public OidcCommonConfig() -
OidcCommonConfig
-
-
Method Details
-
authServerUrl
Description copied from interface:OidcCommonConfigThe 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 (#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.- Specified by:
authServerUrlin interfaceOidcCommonConfig
-
discoveryEnabled
Description copied from interface:OidcCommonConfigDiscovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually.- Specified by:
discoveryEnabledin interfaceOidcCommonConfig
-
registrationPath
Description copied from interface:OidcCommonConfigThe relative path or absolute URL of the OIDC dynamic client registration endpoint. Set ifOidcCommonConfig.discoveryEnabled()is `false` or a discovered token endpoint path must be customized.- Specified by:
registrationPathin interfaceOidcCommonConfig
-
connectionDelay
Description copied from interface:OidcCommonConfigThe 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.- Specified by:
connectionDelayin interfaceOidcCommonConfig
-
connectionRetryCount
public int connectionRetryCount()Description copied from interface:OidcCommonConfigThe 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.- Specified by:
connectionRetryCountin interfaceOidcCommonConfig
-
connectionTimeout
Description copied from interface:OidcCommonConfigThe number of seconds after which the current OIDC connection request times out.- Specified by:
connectionTimeoutin interfaceOidcCommonConfig
-
useBlockingDnsLookup
public boolean useBlockingDnsLookup()Description copied from interface:OidcCommonConfigWhether 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.- Specified by:
useBlockingDnsLookupin interfaceOidcCommonConfig
-
maxPoolSize
Description copied from interface:OidcCommonConfigThe maximum size of the connection pool used by the WebClient.- Specified by:
maxPoolSizein interfaceOidcCommonConfig
-
followRedirects
public boolean followRedirects()Description copied from interface:OidcCommonConfigFollow 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.- Specified by:
followRedirectsin interfaceOidcCommonConfig
-
proxy
Description copied from interface:OidcCommonConfigHTTP proxy configuration.- Specified by:
proxyin interfaceOidcCommonConfig
-
tls
Description copied from interface:OidcCommonConfigTLS configuration.- Specified by:
tlsin interfaceOidcCommonConfig
-
getConnectionDelay
Deprecated.use theconnectionDelay()method instead -
setConnectionDelay
Deprecated. -
getAuthServerUrl
Deprecated.use theauthServerUrl()method instead -
setAuthServerUrl
Deprecated. -
getRegistrationPath
Deprecated.use theregistrationPath()method instead -
setRegistrationPath
Deprecated. -
isDiscoveryEnabled
Deprecated.use thediscoveryEnabled()method instead -
setDiscoveryEnabled
Deprecated. -
getProxy
Deprecated.use theproxy()method instead -
setProxy
Deprecated. -
getConnectionTimeout
Deprecated.use theconnectionTimeout()method instead -
setConnectionTimeout
Deprecated. -
getMaxPoolSize
Deprecated.use themaxPoolSize()method instead -
setMaxPoolSize
Deprecated. -
getDiscoveryEnabled
Deprecated.use thediscoveryEnabled()method instead -
setDiscoveryEnabled
Deprecated.
-
OidcCommonConfigBuilderto create the Proxy config