Package io.quarkus.oidc.client.registration

Interface OidcClientRegistrationConfig

All Superinterfaces:

io.quarkus.oidc.common.runtime.config.OidcCommonConfig

public interface OidcClientRegistrationConfig
extends io.quarkus.oidc.common.runtime.config.OidcCommonConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OidcClientRegistrationConfig.Metadata	Client metadata

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

io.quarkus.oidc.common.runtime.config.OidcCommonConfig.Proxy, io.quarkus.oidc.common.runtime.config.OidcCommonConfig.Tls

Method Summary

Modifier and Type	Method	Description
static OidcClientRegistrationConfigBuilder	authServerUrl(String authServerUrl)	Creates OidcClientRegistrationConfig builder populated with documented default values.
static OidcClientRegistrationConfigBuilder	builder()	Creates OidcClientRegistrationConfig builder populated with documented default values.
static OidcClientRegistrationConfigBuilder	builder(OidcClientRegistrationConfig config)	Creates OidcClientRegistrationConfig builder populated with config values.
Optional<String>	id()	OIDC Client Registration id
Optional<String>	initialToken()	Initial access token
OidcClientRegistrationConfig.Metadata	metadata()	Client metadata
boolean	registerEarly()	If the client configured with metadata() must be registered at startup.
boolean	registrationEnabled()	If this client registration configuration is enabled.
static OidcClientRegistrationConfigBuilder	registrationPath(String registrationPath)	Creates OidcClientRegistrationConfig builder populated with documented default values.

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

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

Method Details

id

Optional<String> id()

OIDC Client Registration id

registrationEnabled

@WithDefault("true")
boolean registrationEnabled()

If this client registration configuration is enabled.

registerEarly

@WithDefault("true")
boolean registerEarly()

If the client configured with metadata() must be registered at startup.

initialToken

Optional<String> initialToken()

Initial access token

metadata

OidcClientRegistrationConfig.Metadata metadata()

Client metadata

builder

static OidcClientRegistrationConfigBuilder builder()

Creates OidcClientRegistrationConfig builder populated with documented default values.

Returns:

OidcClientRegistrationConfigBuilder builder

builder

static OidcClientRegistrationConfigBuilder builder(OidcClientRegistrationConfig config)

Creates OidcClientRegistrationConfig builder populated with config values.

Parameters:

config - client registration config; must not be null

Returns:

OidcClientRegistrationConfigBuilder

authServerUrl

static OidcClientRegistrationConfigBuilder authServerUrl(String authServerUrl)

Creates OidcClientRegistrationConfig builder populated with documented default values.

Parameters:

authServerUrl - OidcCommonConfig.authServerUrl()

Returns:

OidcClientRegistrationConfigBuilder builder

registrationPath

static OidcClientRegistrationConfigBuilder registrationPath(String registrationPath)

Creates OidcClientRegistrationConfig builder populated with documented default values.

Parameters:

registrationPath - OidcCommonConfig.registrationPath()

Returns:

OidcClientRegistrationConfigBuilder builder