Package io.quarkus.oidc.common.runtime

Class OidcClientCommonConfig

java.lang.Object

io.quarkus.oidc.common.runtime.OidcCommonConfig

io.quarkus.oidc.common.runtime.OidcClientCommonConfig

public class OidcClientCommonConfig
extends OidcCommonConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OidcClientCommonConfig.Credentials

Nested classes/interfaces inherited from class io.quarkus.oidc.common.runtime.OidcCommonConfig

OidcCommonConfig.Proxy, OidcCommonConfig.Tls

Field Summary

Fields

Modifier and Type	Field	Description
Optional<String>	clientId	The client id of the application.
Optional<String>	clientName	The client name of the application.
OidcClientCommonConfig.Credentials	credentials	Credentials the OIDC adapter uses to authenticate to the OIDC server.
Optional<String>	revokePath	The relative path or absolute URL of the OIDC token revocation endpoint.
Optional<String>	tokenPath	The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL.

Fields inherited from class io.quarkus.oidc.common.runtime.OidcCommonConfig

authServerUrl, connectionDelay, connectionRetryCount, connectionTimeout, discoveryEnabled, followRedirects, maxPoolSize, proxy, registrationPath, tls, useBlockingDnsLookup

Constructor Summary

Constructors

Modifier	Constructor	Description
	OidcClientCommonConfig()
protected	OidcClientCommonConfig(OidcClientCommonConfig mapping)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getClientId()
Optional<String>	getClientName()
OidcClientCommonConfig.Credentials	getCredentials()
Optional<String>	getRevokePath()
Optional<String>	getTokenPath()
void	setClientId(String clientId)
void	setClientName(String clientName)
void	setCredentials(OidcClientCommonConfig.Credentials credentials)
void	setRevokePath(String revokePath)
void	setTokenPath(String tokenPath)

Methods inherited from class io.quarkus.oidc.common.runtime.OidcCommonConfig

getAuthServerUrl, getConnectionDelay, getConnectionTimeout, getDiscoveryEnabled, getMaxPoolSize, getProxy, getRegistrationPath, isDiscoveryEnabled, setAuthServerUrl, setConnectionDelay, setConnectionTimeout, setDiscoveryEnabled, setDiscoveryEnabled, setMaxPoolSize, setProxy, setRegistrationPath

Methods inherited from class java.lang.Object

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

Field Details

tokenPath

public Optional<String> tokenPath

The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if OidcCommonConfig.discoveryEnabled is `false` or a discovered token endpoint path must be customized.

revokePath

public Optional<String> revokePath

The relative path or absolute URL of the OIDC token revocation endpoint.

clientId

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

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.

credentials

public OidcClientCommonConfig.Credentials credentials

Credentials the OIDC adapter uses to authenticate to the OIDC server.

Constructor Details

OidcClientCommonConfig

public OidcClientCommonConfig()

OidcClientCommonConfig

protected OidcClientCommonConfig(OidcClientCommonConfig mapping)

Method Details

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 OidcClientCommonConfig.Credentials getCredentials()

setCredentials

public void setCredentials(OidcClientCommonConfig.Credentials credentials)