io.quarkus.oidc.common.runtime

Class OidcCommonConfig

java.lang.Object

io.quarkus.oidc.common.runtime.OidcCommonConfig

public class OidcCommonConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OidcCommonConfig.Credentials
static class	OidcCommonConfig.Proxy
static class	OidcCommonConfig.Tls

Field Summary

Fields

Modifier and Type	Field and Description
Optional<String>	authServerUrl The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`.
Optional<String>	clientId The client-id of the application.
Optional<Duration>	connectionDelay The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for.
Duration	connectionTimeout The amount of time after which the connection request to the currently unavailable OIDC server will time out.
OidcCommonConfig.Credentials	credentials Credentials which the OIDC adapter will use to authenticate to the OIDC server.
boolean	discoveryEnabled Enables OIDC discovery.
OidcCommonConfig.Proxy	proxy Options to configure a proxy that OIDC adapter will use for talking with OIDC server.
OidcCommonConfig.Tls	tls TLS configurations
Optional<String>	tokenPath Relative path of the OIDC token endpoint which issues access and refresh tokens using either 'client_credentials' or 'password' grants

Constructor Summary

Constructors

Constructor and Description
OidcCommonConfig()

Method Summary

Modifier and Type	Method and Description
Optional<String>	getAuthServerUrl()
Optional<String>	getClientId()
Optional<Duration>	getConnectionDelay()
Duration	getConnectionTimeout()
OidcCommonConfig.Credentials	getCredentials()
OidcCommonConfig.Proxy	getProxy()
Optional<String>	getTokenPath()
boolean	isDiscoveryEnabled()
void	setAuthServerUrl(String authServerUrl)
void	setClientId(String clientId)
void	setConnectionDelay(Duration connectionDelay)
void	setConnectionTimeout(Duration connectionTimeout)
void	setCredentials(OidcCommonConfig.Credentials credentials)
void	setDiscoveryEnabled(boolean enabled)
void	setProxy(OidcCommonConfig.Proxy proxy)
void	setTokenPath(String tokenPath)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 the `connection-timeout` property does not affect this amount of time.

connectionTimeout

@ConfigItem(defaultValue="10s")
public Duration connectionTimeout

The amount of time after which the connection request to the currently unavailable OIDC server will time out.

credentials

@ConfigItem
public OidcCommonConfig.Credentials credentials

Credentials which the OIDC adapter will use to authenticate to the OIDC server.

proxy

@ConfigItem
public OidcCommonConfig.Proxy proxy

Options to configure a proxy that OIDC adapter will use for talking with OIDC server.

tls

@ConfigItem
public OidcCommonConfig.Tls tls

TLS configurations

Constructor Detail

OidcCommonConfig

public OidcCommonConfig()

Method Detail

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)

getClientId

public Optional<String> getClientId()

setClientId

public void setClientId(String clientId)

getCredentials

public OidcCommonConfig.Credentials getCredentials()

setCredentials

public void setCredentials(OidcCommonConfig.Credentials credentials)

isDiscoveryEnabled

public 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)