Package io.quarkus.oidc.common.runtime

Class OidcClientCommonConfig

java.lang.Object

io.quarkus.oidc.common.runtime.OidcCommonConfig

io.quarkus.oidc.common.runtime.OidcClientCommonConfig

All Implemented Interfaces:

OidcClientCommonConfig, OidcCommonConfig

public abstract class OidcClientCommonConfig
extends OidcCommonConfig
implements OidcClientCommonConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OidcClientCommonConfig.Credentials	Deprecated, for removal: This API element is subject to removal in a future version. use OidcClientCommonConfigBuilder.CredentialsBuilder

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

OidcCommonConfig.Proxy, OidcCommonConfig.Tls

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

OidcCommonConfig.Proxy, OidcCommonConfig.Tls

Field Summary

Fields

Modifier and Type	Field	Description
Optional<String>	clientId	Deprecated, for removal: This API element is subject to removal in a future version. use the clientId() method instead
Optional<String>	clientName	Deprecated, for removal: This API element is subject to removal in a future version. use the clientName() method instead
OidcClientCommonConfig.Credentials	credentials	Deprecated, for removal: This API element is subject to removal in a future version. use the credentials() method instead
Optional<String>	revokePath	Deprecated, for removal: This API element is subject to removal in a future version. use the revokePath() method instead
Optional<String>	tokenPath	Deprecated, for removal: This API element is subject to removal in a future version. use the tokenPath() method instead

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
protected	OidcClientCommonConfig()
protected	OidcClientCommonConfig(OidcClientCommonConfig mapping)

Method Summary

Modifier and Type	Method	Description
Optional<String>	clientId()	The client id of the application.
Optional<String>	clientName()	The client name of the application.
OidcClientCommonConfig.Credentials	credentials()	Different authentication options for OIDC client to access OIDC token and other secured endpoints.
Optional<String>	getClientId()	Deprecated, for removal: This API element is subject to removal in a future version. use the clientId() method instead
Optional<String>	getClientName()	Deprecated, for removal: This API element is subject to removal in a future version. use the clientName() method instead
OidcClientCommonConfig.Credentials	getCredentials()	Deprecated, for removal: This API element is subject to removal in a future version. use the credentials() method instead
Optional<String>	getRevokePath()	Deprecated, for removal: This API element is subject to removal in a future version. use the revokePath() method instead
Optional<String>	getTokenPath()	Deprecated, for removal: This API element is subject to removal in a future version. use the tokenPath() method instead
Optional<String>	revokePath()	The relative path or absolute URL of the OIDC token revocation endpoint.
void	setClientId(String clientId)	Deprecated, for removal: This API element is subject to removal in a future version. use OidcClientCommonConfigBuilder
void	setClientName(String clientName)	Deprecated, for removal: This API element is subject to removal in a future version. use OidcClientCommonConfigBuilder
void	setCredentials(OidcClientCommonConfig.Credentials credentials)	Deprecated, for removal: This API element is subject to removal in a future version. use OidcClientCommonConfigBuilder
void	setRevokePath(String revokePath)	Deprecated, for removal: This API element is subject to removal in a future version. use OidcClientCommonConfigBuilder
void	setTokenPath(String tokenPath)	Deprecated, for removal: This API element is subject to removal in a future version. use OidcClientCommonConfigBuilder
Optional<String>	tokenPath()	The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL.

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

authServerUrl, connectionDelay, connectionRetryCount, connectionTimeout, discoveryEnabled, followRedirects, getAuthServerUrl, getConnectionDelay, getConnectionTimeout, getDiscoveryEnabled, getMaxPoolSize, getProxy, getRegistrationPath, isDiscoveryEnabled, maxPoolSize, proxy, registrationPath, setAuthServerUrl, setConnectionDelay, setConnectionTimeout, setDiscoveryEnabled, setDiscoveryEnabled, setMaxPoolSize, setProxy, setRegistrationPath, tls, useBlockingDnsLookup

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkus.oidc.common.runtime.config.OidcCommonConfig

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

Field Details

tokenPath

@Deprecated(since="3.18",
            forRemoval=true)
public Optional<String> tokenPath

Deprecated, for removal: This API element is subject to removal in a future version.

use the tokenPath() method instead

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

@Deprecated(since="3.18",
            forRemoval=true)
public Optional<String> revokePath

Deprecated, for removal: This API element is subject to removal in a future version.

use the revokePath() method instead

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

clientId

@Deprecated(since="3.18",
            forRemoval=true)
public Optional<String> clientId

Deprecated, for removal: This API element is subject to removal in a future version.

use the clientId() method instead

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

invalid reference

#applicationType

is `service` and no token introspection is required.

clientName

@Deprecated(since="3.18",
            forRemoval=true)
public Optional<String> clientName

Deprecated, for removal: This API element is subject to removal in a future version.

use the clientName() method instead

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

@Deprecated(since="3.18",
            forRemoval=true)
public OidcClientCommonConfig.Credentials credentials

Deprecated, for removal: This API element is subject to removal in a future version.

use the credentials() method instead

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

Constructor Details

OidcClientCommonConfig

protected OidcClientCommonConfig()

OidcClientCommonConfig

protected OidcClientCommonConfig(OidcClientCommonConfig mapping)

Method Details

tokenPath

public Optional<String> tokenPath()

Description copied from interface: OidcClientCommonConfig

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.

Specified by:

tokenPath in interface OidcClientCommonConfig

revokePath

public Optional<String> revokePath()

Description copied from interface: OidcClientCommonConfig

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

Specified by:

revokePath in interface OidcClientCommonConfig

clientId

public Optional<String> clientId()

Description copied from interface: OidcClientCommonConfig

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

invalid reference

#applicationType

is `service` and no token introspection is required.

Specified by:

clientId in interface OidcClientCommonConfig

clientName

public Optional<String> clientName()

Description copied from interface: OidcClientCommonConfig

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.

Specified by:

clientName in interface OidcClientCommonConfig

credentials

public OidcClientCommonConfig.Credentials credentials()

Description copied from interface: OidcClientCommonConfig

Different authentication options for OIDC client to access OIDC token and other secured endpoints.

Specified by:

credentials in interface OidcClientCommonConfig

getTokenPath

@Deprecated(since="3.18",
            forRemoval=true)
public Optional<String> getTokenPath()

Deprecated, for removal: This API element is subject to removal in a future version.

use the tokenPath() method instead

setTokenPath

@Deprecated(since="3.18",
            forRemoval=true)
public void setTokenPath(String tokenPath)

Deprecated, for removal: This API element is subject to removal in a future version.

use OidcClientCommonConfigBuilder

getRevokePath

@Deprecated(since="3.18",
            forRemoval=true)
public Optional<String> getRevokePath()

Deprecated, for removal: This API element is subject to removal in a future version.

use the revokePath() method instead

setRevokePath

@Deprecated(since="3.18",
            forRemoval=true)
public void setRevokePath(String revokePath)

Deprecated, for removal: This API element is subject to removal in a future version.

use OidcClientCommonConfigBuilder

getClientId

@Deprecated(since="3.18",
            forRemoval=true)
public Optional<String> getClientId()

Deprecated, for removal: This API element is subject to removal in a future version.

use the clientId() method instead

setClientId

@Deprecated(since="3.18",
            forRemoval=true)
public void setClientId(String clientId)

Deprecated, for removal: This API element is subject to removal in a future version.

use OidcClientCommonConfigBuilder

getClientName

@Deprecated(since="3.18",
            forRemoval=true)
public Optional<String> getClientName()

Deprecated, for removal: This API element is subject to removal in a future version.

use the clientName() method instead

setClientName

@Deprecated(since="3.18",
            forRemoval=true)
public void setClientName(String clientName)

Deprecated, for removal: This API element is subject to removal in a future version.

use OidcClientCommonConfigBuilder

getCredentials

@Deprecated(since="3.18",
            forRemoval=true)
public OidcClientCommonConfig.Credentials getCredentials()

Deprecated, for removal: This API element is subject to removal in a future version.

use the credentials() method instead

setCredentials

@Deprecated(since="3.18",
            forRemoval=true)
public void setCredentials(OidcClientCommonConfig.Credentials credentials)

Deprecated, for removal: This API element is subject to removal in a future version.

use OidcClientCommonConfigBuilder