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 ClassesModifier and TypeClassDescriptionstatic classDeprecated, for removal: This API element is subject to removal in a future version.Nested classes/interfaces inherited from class io.quarkus.oidc.common.runtime.OidcCommonConfig
OidcCommonConfig.Proxy, OidcCommonConfig.TlsNested classes/interfaces inherited from interface io.quarkus.oidc.common.runtime.config.OidcCommonConfig
OidcCommonConfig.Proxy, OidcCommonConfig.Tls -
Field Summary
FieldsModifier and TypeFieldDescriptionDeprecated, for removal: This API element is subject to removal in a future version.use theclientId()method insteadDeprecated, for removal: This API element is subject to removal in a future version.use theclientName()method insteadDeprecated, for removal: This API element is subject to removal in a future version.use thecredentials()method insteadDeprecated, for removal: This API element is subject to removal in a future version.use therevokePath()method insteadDeprecated, for removal: This API element is subject to removal in a future version.use thetokenPath()method insteadFields inherited from class io.quarkus.oidc.common.runtime.OidcCommonConfig
authServerUrl, connectionDelay, connectionRetryCount, connectionTimeout, discoveryEnabled, followRedirects, maxPoolSize, proxy, registrationPath, tls, useBlockingDnsLookup -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedprotected -
Method Summary
Modifier and TypeMethodDescriptionclientId()The client id of the application.The client name of the application.Different authentication options for OIDC client to access OIDC token and other secured endpoints.Deprecated, for removal: This API element is subject to removal in a future version.use theclientId()method insteadDeprecated, for removal: This API element is subject to removal in a future version.use theclientName()method insteadDeprecated, for removal: This API element is subject to removal in a future version.use thecredentials()method insteadDeprecated, for removal: This API element is subject to removal in a future version.use therevokePath()method insteadDeprecated, for removal: This API element is subject to removal in a future version.use thetokenPath()method insteadThe relative path or absolute URL of the OIDC token revocation endpoint.voidsetClientId(String clientId) Deprecated, for removal: This API element is subject to removal in a future version.voidsetClientName(String clientName) Deprecated, for removal: This API element is subject to removal in a future version.voidsetCredentials(OidcClientCommonConfig.Credentials credentials) Deprecated, for removal: This API element is subject to removal in a future version.voidsetRevokePath(String revokePath) Deprecated, for removal: This API element is subject to removal in a future version.voidsetTokenPath(String tokenPath) Deprecated, for removal: This API element is subject to removal in a future version.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, useBlockingDnsLookupMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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, for removal: This API element is subject to removal in a future version.use thetokenPath()method insteadThe OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set ifOidcCommonConfig.discoveryEnabledis `false` or a discovered token endpoint path must be customized. -
revokePath
Deprecated, for removal: This API element is subject to removal in a future version.use therevokePath()method insteadThe relative path or absolute URL of the OIDC token revocation endpoint. -
clientId
Deprecated, for removal: This API element is subject to removal in a future version.use theclientId()method insteadThe 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 ifis `service` and no token introspection is required.invalid reference
#applicationType -
clientName
Deprecated, for removal: This API element is subject to removal in a future version.use theclientName()method insteadThe 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, for removal: This API element is subject to removal in a future version.use thecredentials()method insteadCredentials the OIDC adapter uses to authenticate to the OIDC server.
-
-
Constructor Details
-
OidcClientCommonConfig
protected OidcClientCommonConfig() -
OidcClientCommonConfig
-
-
Method Details
-
tokenPath
Description copied from interface:OidcClientCommonConfigThe OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set ifOidcCommonConfig.discoveryEnabled()is `false` or a discovered token endpoint path must be customized.- Specified by:
tokenPathin interfaceOidcClientCommonConfig
-
revokePath
Description copied from interface:OidcClientCommonConfigThe relative path or absolute URL of the OIDC token revocation endpoint.- Specified by:
revokePathin interfaceOidcClientCommonConfig
-
clientId
Description copied from interface:OidcClientCommonConfigThe 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 ifis `service` and no token introspection is required.invalid reference
#applicationType- Specified by:
clientIdin interfaceOidcClientCommonConfig
-
clientName
Description copied from interface:OidcClientCommonConfigThe 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:
clientNamein interfaceOidcClientCommonConfig
-
credentials
Description copied from interface:OidcClientCommonConfigDifferent authentication options for OIDC client to access OIDC token and other secured endpoints.- Specified by:
credentialsin interfaceOidcClientCommonConfig
-
getTokenPath
Deprecated, for removal: This API element is subject to removal in a future version.use thetokenPath()method instead -
setTokenPath
Deprecated, for removal: This API element is subject to removal in a future version. -
getRevokePath
Deprecated, for removal: This API element is subject to removal in a future version.use therevokePath()method instead -
setRevokePath
Deprecated, for removal: This API element is subject to removal in a future version. -
getClientId
Deprecated, for removal: This API element is subject to removal in a future version.use theclientId()method instead -
setClientId
Deprecated, for removal: This API element is subject to removal in a future version. -
getClientName
Deprecated, for removal: This API element is subject to removal in a future version.use theclientName()method instead -
setClientName
Deprecated, for removal: This API element is subject to removal in a future version. -
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 thecredentials()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.
-
OidcClientCommonConfigBuilder.CredentialsBuilder