Package io.quarkus.oidc.runtime.builders

Class AuthenticationConfigBuilder

java.lang.Object

io.quarkus.oidc.runtime.builders.AuthenticationConfigBuilder

public final class AuthenticationConfigBuilder
extends Object

Builder for the OidcTenantConfig.Authentication config.

Constructor Summary

Constructors

Constructor	Description
AuthenticationConfigBuilder()
AuthenticationConfigBuilder(OidcTenantConfigBuilder builder)

Method Summary

Modifier and Type	Method	Description
AuthenticationConfigBuilder	addOpenidScope()	Sets OidcTenantConfig.Authentication.addOpenidScope() to true.
AuthenticationConfigBuilder	addOpenidScope(boolean addOpenidScope)
AuthenticationConfigBuilder	allowMultipleCodeFlows()	Sets OidcTenantConfig.Authentication.allowMultipleCodeFlows() to true.
AuthenticationConfigBuilder	allowMultipleCodeFlows(boolean allowMultipleCodeFlows)
OidcTenantConfig.Authentication	build()
AuthenticationConfigBuilder	cookieDomain(String cookieDomain)
AuthenticationConfigBuilder	cookieForceSecure()	Sets OidcTenantConfig.Authentication.cookieForceSecure() to true.
AuthenticationConfigBuilder	cookieForceSecure(boolean cookieForceSecure)
AuthenticationConfigBuilder	cookiePath(String cookiePath)
AuthenticationConfigBuilder	cookiePathHeader(String cookiePathHeader)
AuthenticationConfigBuilder	cookieSameSite(OidcTenantConfig.Authentication.CookieSameSite cookieSameSite)
AuthenticationConfigBuilder	cookieSuffix(String cookieSuffix)
OidcTenantConfigBuilder	end()
AuthenticationConfigBuilder	errorPath(String errorPath)
AuthenticationConfigBuilder	extraParam(String key, String value)
AuthenticationConfigBuilder	extraParams(Map<String,String> extraParams)
AuthenticationConfigBuilder	failOnMissingStateParam()	Sets OidcTenantConfig.Authentication.failOnMissingStateParam() to true.
AuthenticationConfigBuilder	failOnMissingStateParam(boolean failOnMissingStateParam)
AuthenticationConfigBuilder	failOnUnresolvedKid()	Sets Authentication#failOnUnreslvedKid() to true.
AuthenticationConfigBuilder	failOnUnresolvedKid(boolean failOnUnresolvedKid)
AuthenticationConfigBuilder	forceRedirectHttpsScheme()	Sets OidcTenantConfig.Authentication.forceRedirectHttpsScheme() to true.
AuthenticationConfigBuilder	forceRedirectHttpsScheme(boolean forceRedirectHttpsScheme)
AuthenticationConfigBuilder	forwardParams(String... forwardParams)
AuthenticationConfigBuilder	forwardParams(List<String> forwardParams)
AuthenticationConfigBuilder	idTokenRequired()	Sets OidcTenantConfig.Authentication.idTokenRequired() to true.
AuthenticationConfigBuilder	idTokenRequired(boolean idTokenRequired)
AuthenticationConfigBuilder	internalIdTokenLifespan(Duration internalIdTokenLifespan)
AuthenticationConfigBuilder	javaScriptAutoRedirect()	Sets OidcTenantConfig.Authentication.javaScriptAutoRedirect() to true.
AuthenticationConfigBuilder	javaScriptAutoRedirect(boolean javaScriptAutoRedirect)
AuthenticationConfigBuilder	nonceRequired()	Sets OidcTenantConfig.Authentication.nonceRequired() to true.
AuthenticationConfigBuilder	nonceRequired(boolean nonceRequired)
AuthenticationConfigBuilder	pkceRequired()	Sets OidcTenantConfig.Authentication.pkceRequired() to true.
AuthenticationConfigBuilder	pkceRequired(boolean pkceRequired)
AuthenticationConfigBuilder	redirectPath(String redirectPath)
AuthenticationConfigBuilder	removeRedirectParameters()	Sets OidcTenantConfig.Authentication.removeRedirectParameters() to true.
AuthenticationConfigBuilder	removeRedirectParameters(boolean removeRedirectParameters)
AuthenticationConfigBuilder	responseMode(OidcTenantConfig.Authentication.ResponseMode responseMode)
AuthenticationConfigBuilder	restorePathAfterRedirect()	Sets OidcTenantConfig.Authentication.restorePathAfterRedirect() to true.
AuthenticationConfigBuilder	restorePathAfterRedirect(boolean restorePathAfterRedirect)
AuthenticationConfigBuilder	scopes(String... scopes)
AuthenticationConfigBuilder	scopes(List<String> scopes)
AuthenticationConfigBuilder	scopeSeparator(String separator)
AuthenticationConfigBuilder	sessionAgeExtension(Duration sessionAgeExtension)
AuthenticationConfigBuilder	sessionExpiredPath(String sessionExpiredPath)
AuthenticationConfigBuilder	stateCookieAge(Duration stateCookieAge)
AuthenticationConfigBuilder	stateSecret(String stateSecret)
AuthenticationConfigBuilder	userInfoRequired()	Sets OidcTenantConfig.Authentication.userInfoRequired() to true.
AuthenticationConfigBuilder	userInfoRequired(boolean userInfoRequired)
AuthenticationConfigBuilder	verifyAccessToken()	Sets OidcTenantConfig.Authentication.verifyAccessToken() to true.
AuthenticationConfigBuilder	verifyAccessToken(boolean verifyAccessToken)

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationConfigBuilder

public AuthenticationConfigBuilder()

AuthenticationConfigBuilder

public AuthenticationConfigBuilder(OidcTenantConfigBuilder builder)

Method Details

responseMode

public AuthenticationConfigBuilder responseMode(OidcTenantConfig.Authentication.ResponseMode responseMode)

Parameters:

responseMode - OidcTenantConfig.Authentication.responseMode()

Returns:

this builder

redirectPath

public AuthenticationConfigBuilder redirectPath(String redirectPath)

Parameters:

redirectPath - OidcTenantConfig.Authentication.redirectPath()

Returns:

this builder

restorePathAfterRedirect

public AuthenticationConfigBuilder restorePathAfterRedirect()

Sets OidcTenantConfig.Authentication.restorePathAfterRedirect() to true.

Returns:

this builder

restorePathAfterRedirect

public AuthenticationConfigBuilder restorePathAfterRedirect(boolean restorePathAfterRedirect)

Parameters:

restorePathAfterRedirect - OidcTenantConfig.Authentication.restorePathAfterRedirect()

Returns:

this builder

removeRedirectParameters

public AuthenticationConfigBuilder removeRedirectParameters()

Sets OidcTenantConfig.Authentication.removeRedirectParameters() to true.

Returns:

this builder

removeRedirectParameters

public AuthenticationConfigBuilder removeRedirectParameters(boolean removeRedirectParameters)

Parameters:

removeRedirectParameters - OidcTenantConfig.Authentication.removeRedirectParameters()

Returns:

this builder

errorPath

public AuthenticationConfigBuilder errorPath(String errorPath)

Parameters:

errorPath - OidcTenantConfig.Authentication.errorPath()

Returns:

this builder

sessionExpiredPath

public AuthenticationConfigBuilder sessionExpiredPath(String sessionExpiredPath)

Parameters:

sessionExpiredPath - OidcTenantConfig.Authentication.sessionExpiredPath()

Returns:

this builder

verifyAccessToken

public AuthenticationConfigBuilder verifyAccessToken()

Sets OidcTenantConfig.Authentication.verifyAccessToken() to true.

Returns:

this builder

verifyAccessToken

public AuthenticationConfigBuilder verifyAccessToken(boolean verifyAccessToken)

Parameters:

verifyAccessToken - OidcTenantConfig.Authentication.verifyAccessToken()

Returns:

this builder

forceRedirectHttpsScheme

public AuthenticationConfigBuilder forceRedirectHttpsScheme()

Sets OidcTenantConfig.Authentication.forceRedirectHttpsScheme() to true.

Returns:

this builder

forceRedirectHttpsScheme

public AuthenticationConfigBuilder forceRedirectHttpsScheme(boolean forceRedirectHttpsScheme)

Parameters:

forceRedirectHttpsScheme - OidcTenantConfig.Authentication.forceRedirectHttpsScheme()

Returns:

this builder

scopes

public AuthenticationConfigBuilder scopes(List<String> scopes)

Parameters:

scopes - OidcTenantConfig.Authentication.scopes()

Returns:

this builder

scopes

public AuthenticationConfigBuilder scopes(String... scopes)

Parameters:

scopes - OidcTenantConfig.Authentication.scopes()

Returns:

this builder

scopeSeparator

public AuthenticationConfigBuilder scopeSeparator(String separator)

Parameters:

separator - OidcTenantConfig.Authentication.scopeSeparator()

Returns:

this builder

nonceRequired

public AuthenticationConfigBuilder nonceRequired()

Sets OidcTenantConfig.Authentication.nonceRequired() to true.

Returns:

this builder

nonceRequired

public AuthenticationConfigBuilder nonceRequired(boolean nonceRequired)

Parameters:

nonceRequired - OidcTenantConfig.Authentication.nonceRequired()

Returns:

this builder

addOpenidScope

public AuthenticationConfigBuilder addOpenidScope()

Sets OidcTenantConfig.Authentication.addOpenidScope() to true.

Returns:

this builder

addOpenidScope

public AuthenticationConfigBuilder addOpenidScope(boolean addOpenidScope)

Parameters:

addOpenidScope - OidcTenantConfig.Authentication.addOpenidScope()

Returns:

this builder

forwardParams

public AuthenticationConfigBuilder forwardParams(List<String> forwardParams)

Parameters:

forwardParams - OidcTenantConfig.Authentication.forwardParams()

Returns:

this builder

forwardParams

public AuthenticationConfigBuilder forwardParams(String... forwardParams)

Parameters:

forwardParams - OidcTenantConfig.Authentication.forwardParams()

Returns:

this builder

cookieForceSecure

public AuthenticationConfigBuilder cookieForceSecure()

Sets OidcTenantConfig.Authentication.cookieForceSecure() to true.

Returns:

this builder

cookieForceSecure

public AuthenticationConfigBuilder cookieForceSecure(boolean cookieForceSecure)

Parameters:

cookieForceSecure - OidcTenantConfig.Authentication.cookieForceSecure()

Returns:

this builder

cookieSuffix

public AuthenticationConfigBuilder cookieSuffix(String cookieSuffix)

Parameters:

cookieSuffix - OidcTenantConfig.Authentication.cookieSuffix()

Returns:

this builder

cookiePath

public AuthenticationConfigBuilder cookiePath(String cookiePath)

Parameters:

cookiePath - OidcTenantConfig.Authentication.cookiePath()

Returns:

this builder

cookiePathHeader

public AuthenticationConfigBuilder cookiePathHeader(String cookiePathHeader)

Parameters:

cookiePathHeader - OidcTenantConfig.Authentication.cookiePathHeader()

Returns:

this builder

cookieDomain

public AuthenticationConfigBuilder cookieDomain(String cookieDomain)

Parameters:

cookieDomain - OidcTenantConfig.Authentication.cookieDomain()

Returns:

this builder

cookieSameSite

public AuthenticationConfigBuilder cookieSameSite(OidcTenantConfig.Authentication.CookieSameSite cookieSameSite)

Parameters:

cookieSameSite - OidcTenantConfig.Authentication.cookieSameSite()

Returns:

this builder

allowMultipleCodeFlows

public AuthenticationConfigBuilder allowMultipleCodeFlows()

Sets OidcTenantConfig.Authentication.allowMultipleCodeFlows() to true.

Returns:

this builder

allowMultipleCodeFlows

public AuthenticationConfigBuilder allowMultipleCodeFlows(boolean allowMultipleCodeFlows)

Parameters:

allowMultipleCodeFlows - OidcTenantConfig.Authentication.allowMultipleCodeFlows()

Returns:

this builder

failOnMissingStateParam

public AuthenticationConfigBuilder failOnMissingStateParam()

Sets OidcTenantConfig.Authentication.failOnMissingStateParam() to true.

Returns:

this builder

failOnMissingStateParam

public AuthenticationConfigBuilder failOnMissingStateParam(boolean failOnMissingStateParam)

Parameters:

failOnMissingStateParam - OidcTenantConfig.Authentication.failOnMissingStateParam()

Returns:

this builder

failOnUnresolvedKid

public AuthenticationConfigBuilder failOnUnresolvedKid()

Sets Authentication#failOnUnreslvedKid() to true.

Returns:

this builder

failOnUnresolvedKid

public AuthenticationConfigBuilder failOnUnresolvedKid(boolean failOnUnresolvedKid)

Parameters:

failOnUnresolvedKid - Authentication#failOnUnreslvedKid()

Returns:

this builder

userInfoRequired

public AuthenticationConfigBuilder userInfoRequired()

Sets OidcTenantConfig.Authentication.userInfoRequired() to true.

Returns:

this builder

userInfoRequired

public AuthenticationConfigBuilder userInfoRequired(boolean userInfoRequired)

Parameters:

userInfoRequired - OidcTenantConfig.Authentication.userInfoRequired()

Returns:

this builder

sessionAgeExtension

public AuthenticationConfigBuilder sessionAgeExtension(Duration sessionAgeExtension)

Parameters:

sessionAgeExtension - OidcTenantConfig.Authentication.sessionAgeExtension()

Returns:

this builder

stateCookieAge

public AuthenticationConfigBuilder stateCookieAge(Duration stateCookieAge)

Parameters:

stateCookieAge - OidcTenantConfig.Authentication.stateCookieAge()

Returns:

this builder

javaScriptAutoRedirect

public AuthenticationConfigBuilder javaScriptAutoRedirect()

Sets OidcTenantConfig.Authentication.javaScriptAutoRedirect() to true.

Returns:

this builder

javaScriptAutoRedirect

public AuthenticationConfigBuilder javaScriptAutoRedirect(boolean javaScriptAutoRedirect)

Parameters:

javaScriptAutoRedirect - OidcTenantConfig.Authentication.javaScriptAutoRedirect()

Returns:

this builder

idTokenRequired

public AuthenticationConfigBuilder idTokenRequired()

Sets OidcTenantConfig.Authentication.idTokenRequired() to true.

Returns:

this builder

idTokenRequired

public AuthenticationConfigBuilder idTokenRequired(boolean idTokenRequired)

Parameters:

idTokenRequired - OidcTenantConfig.Authentication.idTokenRequired()

Returns:

this builder

internalIdTokenLifespan

public AuthenticationConfigBuilder internalIdTokenLifespan(Duration internalIdTokenLifespan)

Parameters:

internalIdTokenLifespan - OidcTenantConfig.Authentication.internalIdTokenLifespan()

Returns:

this builder

extraParams

public AuthenticationConfigBuilder extraParams(Map<String,String> extraParams)

Parameters:

extraParams - OidcTenantConfig.Authentication.extraParams()

Returns:

this builder

extraParam

public AuthenticationConfigBuilder extraParam(String key,
 String value)

Parameters:

key - OidcTenantConfig.Authentication.extraParams() key

value - OidcTenantConfig.Authentication.extraParams() value

Returns:

this builder

pkceRequired

public AuthenticationConfigBuilder pkceRequired()

Sets OidcTenantConfig.Authentication.pkceRequired() to true.

Returns:

this builder

pkceRequired

public AuthenticationConfigBuilder pkceRequired(boolean pkceRequired)

Parameters:

pkceRequired - OidcTenantConfig.Authentication.pkceRequired()

Returns:

this builder

stateSecret

public AuthenticationConfigBuilder stateSecret(String stateSecret)

Parameters:

stateSecret - OidcTenantConfig.Authentication.stateSecret()

Returns:

this builder

end

public OidcTenantConfigBuilder end()

Returns:

OidcTenantConfigBuilder with built OidcTenantConfig.Authentication

build

public OidcTenantConfig.Authentication build()

Returns:

builds OidcTenantConfig.Authentication