Package io.quarkus.oidc.client

Class OidcClientConfigBuilder

java.lang.Object

io.quarkus.oidc.common.runtime.config.OidcCommonConfigBuilder<OidcClientConfigBuilder>

io.quarkus.oidc.common.runtime.config.OidcClientCommonConfigBuilder<OidcClientConfigBuilder>

io.quarkus.oidc.client.OidcClientConfigBuilder

public final class OidcClientConfigBuilder
extends io.quarkus.oidc.common.runtime.config.OidcClientCommonConfigBuilder<OidcClientConfigBuilder>

Builder for the OidcClientConfig. This builder is not thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OidcClientConfigBuilder.GrantBuilder

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

io.quarkus.oidc.common.runtime.config.OidcClientCommonConfigBuilder.CredentialsBuilder<T>, io.quarkus.oidc.common.runtime.config.OidcClientCommonConfigBuilder.JwtBuilder<T>, io.quarkus.oidc.common.runtime.config.OidcClientCommonConfigBuilder.OidcClientCommonConfigImpl, io.quarkus.oidc.common.runtime.config.OidcClientCommonConfigBuilder.ProviderBuilder<T>, io.quarkus.oidc.common.runtime.config.OidcClientCommonConfigBuilder.SecretBuilder<T>

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

io.quarkus.oidc.common.runtime.config.OidcCommonConfigBuilder.OidcCommonConfigImpl

Constructor Summary

Constructors

Constructor	Description
OidcClientConfigBuilder()	Creates OidcClientConfigBuilder builder populated with documented default values.
OidcClientConfigBuilder(OidcClientConfig config)

Method Summary

Modifier and Type	Method	Description
OidcClientConfigBuilder	absoluteExpiresIn(boolean absoluteExpiresIn)
OidcClientConfigBuilder	accessTokenExpiresIn(Duration accessTokenExpiresIn)
OidcClientConfigBuilder	accessTokenExpirySkew(Duration accessTokenExpirySkew)
OidcClientConfigBuilder	audience(String... audience)	Adds scopes to the OidcClientConfig.audience().
OidcClientConfigBuilder	audience(List<String> audience)	Adds scopes to the OidcClientConfig.audience().
OidcClientConfig	build()
OidcClientConfigBuilder	clientEnabled(boolean clientEnabled)
OidcClientConfigBuilder	earlyTokensAcquisition(boolean earlyTokensAcquisition)
protected OidcClientConfigBuilder	getBuilder()
OidcClientConfigBuilder.GrantBuilder	grant()	Creates OidcClientConfig.grant() builder.
OidcClientConfigBuilder	grant(OidcClientConfig.Grant grant)
OidcClientConfigBuilder	grant(OidcClientConfig.Grant.Type type)
OidcClientConfigBuilder	grantOptions(String grantName, String key, String value)	Adds OidcClientConfig.grantOptions().
OidcClientConfigBuilder	grantOptions(String grantName, Map<String,String> options)	Adds OidcClientConfig.grantOptions().
OidcClientConfigBuilder	grantOptions(Map<String,Map<String,String>> grantOptions)
OidcClientConfigBuilder	headers(String headerName, String headerValue)	Adds new headers to the OidcClientConfig.headers() already set.
OidcClientConfigBuilder	headers(Map<String,String> headers)	Adds new headers to the headers already set.
OidcClientConfigBuilder	id(String id)
OidcClientConfigBuilder	refreshInterval(Duration refreshInterval)
OidcClientConfigBuilder	refreshTokenTimeSkew(Duration refreshTokenTimeSkew)
OidcClientConfigBuilder	scopes(String... scopes)	Adds scopes to the OidcClientConfig.scopes().
OidcClientConfigBuilder	scopes(List<String> scopes)	Adds scopes to the OidcClientConfig.scopes().

Methods inherited from class io.quarkus.oidc.common.runtime.config.OidcClientCommonConfigBuilder

clientId, clientName, credentials, credentials, credentials, credentials, credentials, revokePath, tokenPath

Methods inherited from class io.quarkus.oidc.common.runtime.config.OidcCommonConfigBuilder

authServerUrl, connectionDelay, connectionRetryCount, connectionTimeout, discoveryEnabled, followRedirects, maxPoolSize, proxy, proxy, proxyConfigurationName, registrationPath, tlsConfigurationName, useBlockingDnsLookup

Methods inherited from class java.lang.Object

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

Constructor Details

OidcClientConfigBuilder

public OidcClientConfigBuilder()

Creates OidcClientConfigBuilder builder populated with documented default values.

OidcClientConfigBuilder

public OidcClientConfigBuilder(OidcClientConfig config)

Parameters:

config - created either by this builder or SmallRye Config; config methods must never return null

Method Details

getBuilder

protected OidcClientConfigBuilder getBuilder()

Specified by:

getBuilder in class io.quarkus.oidc.common.runtime.config.OidcCommonConfigBuilder<OidcClientConfigBuilder>

headers

public OidcClientConfigBuilder headers(String headerName,
 String headerValue)

Adds new headers to the OidcClientConfig.headers() already set.

Parameters:

headerName - header name

headerValue - header value

Returns:

this builder

headers

public OidcClientConfigBuilder headers(Map<String,String> headers)

Adds new headers to the headers already set.

Parameters:

headers - OidcClientConfig.headers()

Returns:

this builder

earlyTokensAcquisition

public OidcClientConfigBuilder earlyTokensAcquisition(boolean earlyTokensAcquisition)

Parameters:

earlyTokensAcquisition - OidcClientConfig.earlyTokensAcquisition()

Returns:

this builder

grantOptions

public OidcClientConfigBuilder grantOptions(String grantName,
 Map<String,String> options)

Adds OidcClientConfig.grantOptions().

Returns:

this builder

grantOptions

public OidcClientConfigBuilder grantOptions(String grantName,
 String key,
 String value)

Adds OidcClientConfig.grantOptions().

Returns:

this builder

grantOptions

public OidcClientConfigBuilder grantOptions(Map<String,Map<String,String>> grantOptions)

Parameters:

grantOptions - OidcClientConfig.grantOptions()

Returns:

this builder

absoluteExpiresIn

public OidcClientConfigBuilder absoluteExpiresIn(boolean absoluteExpiresIn)

Parameters:

absoluteExpiresIn - OidcClientConfig.absoluteExpiresIn()

Returns:

this builder

accessTokenExpiresIn

public OidcClientConfigBuilder accessTokenExpiresIn(Duration accessTokenExpiresIn)

Parameters:

accessTokenExpiresIn - OidcClientConfig.accessTokenExpiresIn()

Returns:

this builder

accessTokenExpirySkew

public OidcClientConfigBuilder accessTokenExpirySkew(Duration accessTokenExpirySkew)

Parameters:

accessTokenExpirySkew - OidcClientConfig.accessTokenExpirySkew()

Returns:

this builder

refreshTokenTimeSkew

public OidcClientConfigBuilder refreshTokenTimeSkew(Duration refreshTokenTimeSkew)

Parameters:

refreshTokenTimeSkew - OidcClientConfig.refreshTokenTimeSkew()

Returns:

this builder

scopes

public OidcClientConfigBuilder scopes(List<String> scopes)

Adds scopes to the OidcClientConfig.scopes().

Parameters:

scopes - OidcClientConfig.scopes()

Returns:

this builder

scopes

public OidcClientConfigBuilder scopes(String... scopes)

Adds scopes to the OidcClientConfig.scopes().

Parameters:

scopes - OidcClientConfig.scopes()

Returns:

this builder

audience

public OidcClientConfigBuilder audience(List<String> audience)

Adds scopes to the OidcClientConfig.audience().

Parameters:

scopes - OidcClientConfig.audience()

Returns:

this builder

audience

public OidcClientConfigBuilder audience(String... audience)

Adds scopes to the OidcClientConfig.audience().

Parameters:

scopes - OidcClientConfig.audience()

Returns:

this builder

clientEnabled

public OidcClientConfigBuilder clientEnabled(boolean clientEnabled)

Parameters:

clientEnabled - OidcClientConfig.clientEnabled()

Returns:

this builder

id

public OidcClientConfigBuilder id(String id)

Parameters:

id - OidcClientConfig.id()

Returns:

this builder

grant

public OidcClientConfigBuilder grant(OidcClientConfig.Grant grant)

Parameters:

grant - OidcClientConfig.grant() created either with OidcClientConfigBuilder.GrantBuilder or SmallRye Config

Returns:

this builder

grant

public OidcClientConfigBuilder grant(OidcClientConfig.Grant.Type type)

Parameters:

type - OidcClientConfig.Grant.type()

Returns:

this builder

grant

public OidcClientConfigBuilder.GrantBuilder grant()

Creates OidcClientConfig.grant() builder.

Returns:

GrantBuilder

refreshInterval

public OidcClientConfigBuilder refreshInterval(Duration refreshInterval)

build

public OidcClientConfig build()

Returns:

OidcClientConfig