Package org.springframework.security.oauth2.core.oidc

Class OidcUserInfo.Builder

java.lang.Object

org.springframework.security.oauth2.core.oidc.OidcUserInfo.Builder

Enclosing class:

OidcUserInfo

public static final class OidcUserInfo.Builder
extends Object

A builder for OidcUserInfos.

Since:

5.3

Method Summary

Modifier and Type	Method	Description
OidcUserInfo.Builder	address(String address)	Use this address in the resulting OidcUserInfo.
OidcUserInfo.Builder	birthdate(String birthdate)	Use this birthdate in the resulting OidcUserInfo.
OidcUserInfo	build()	Build the OidcUserInfo.
OidcUserInfo.Builder	claim(String name, Object value)	Use this claim in the resulting OidcUserInfo.
OidcUserInfo.Builder	claims(Consumer<Map<String,Object>> claimsConsumer)	Provides access to every claim(String, Object) declared so far with the possibility to add, replace, or remove.
OidcUserInfo.Builder	email(String email)	Use this email in the resulting OidcUserInfo.
OidcUserInfo.Builder	emailVerified(Boolean emailVerified)	Use this verified-email indicator in the resulting OidcUserInfo.
OidcUserInfo.Builder	familyName(String familyName)	Use this family name in the resulting OidcUserInfo.
OidcUserInfo.Builder	gender(String gender)	Use this gender in the resulting OidcUserInfo.
OidcUserInfo.Builder	givenName(String givenName)	Use this given name in the resulting OidcUserInfo.
OidcUserInfo.Builder	locale(String locale)	Use this locale in the resulting OidcUserInfo.
OidcUserInfo.Builder	middleName(String middleName)	Use this middle name in the resulting OidcUserInfo.
OidcUserInfo.Builder	name(String name)	Use this name in the resulting OidcUserInfo.
OidcUserInfo.Builder	nickname(String nickname)	Use this nickname in the resulting OidcUserInfo.
OidcUserInfo.Builder	phoneNumber(String phoneNumber)	Use this phone number in the resulting OidcUserInfo.
OidcUserInfo.Builder	phoneNumberVerified(Boolean phoneNumberVerified)	Use this verified-phone-number indicator in the resulting OidcUserInfo.
OidcUserInfo.Builder	picture(String picture)	Use this picture in the resulting OidcUserInfo.
OidcUserInfo.Builder	preferredUsername(String preferredUsername)	Use this preferred username in the resulting OidcUserInfo.
OidcUserInfo.Builder	profile(String profile)	Use this profile in the resulting OidcUserInfo.
OidcUserInfo.Builder	subject(String subject)	Use this subject in the resulting OidcUserInfo.
OidcUserInfo.Builder	updatedAt(String updatedAt)	Use this updated-at Instant in the resulting OidcUserInfo.
OidcUserInfo.Builder	website(String website)	Use this website in the resulting OidcUserInfo.
OidcUserInfo.Builder	zoneinfo(String zoneinfo)	Use this zoneinfo in the resulting OidcUserInfo.

Methods inherited from class java.lang.Object

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

Method Details

claim

public OidcUserInfo.Builder claim(String name,
 Object value)

Use this claim in the resulting OidcUserInfo.

Parameters:

name - The claim name

value - The claim value

Returns:

the OidcUserInfo.Builder for further configurations

claims

public OidcUserInfo.Builder claims(Consumer<Map<String,Object>> claimsConsumer)

Provides access to every claim(String, Object) declared so far with the possibility to add, replace, or remove.

Parameters:

claimsConsumer - the consumer

Returns:

the OidcUserInfo.Builder for further configurations

address

public OidcUserInfo.Builder address(String address)

Use this address in the resulting OidcUserInfo.

Parameters:

address - The address to use

Returns:

the OidcUserInfo.Builder for further configurations

birthdate

public OidcUserInfo.Builder birthdate(String birthdate)

Use this birthdate in the resulting OidcUserInfo.

Parameters:

birthdate - The birthdate to use

Returns:

the OidcUserInfo.Builder for further configurations

email

public OidcUserInfo.Builder email(String email)

Use this email in the resulting OidcUserInfo.

Parameters:

email - The email to use

Returns:

the OidcUserInfo.Builder for further configurations

emailVerified

public OidcUserInfo.Builder emailVerified(Boolean emailVerified)

Use this verified-email indicator in the resulting OidcUserInfo.

Parameters:

emailVerified - The verified-email indicator to use

Returns:

the OidcUserInfo.Builder for further configurations

familyName

public OidcUserInfo.Builder familyName(String familyName)

Use this family name in the resulting OidcUserInfo.

Parameters:

familyName - The family name to use

Returns:

the OidcUserInfo.Builder for further configurations

gender

public OidcUserInfo.Builder gender(String gender)

Use this gender in the resulting OidcUserInfo.

Parameters:

gender - The gender to use

Returns:

the OidcUserInfo.Builder for further configurations

givenName

public OidcUserInfo.Builder givenName(String givenName)

Use this given name in the resulting OidcUserInfo.

Parameters:

givenName - The given name to use

Returns:

the OidcUserInfo.Builder for further configurations

locale

public OidcUserInfo.Builder locale(String locale)

Use this locale in the resulting OidcUserInfo.

Parameters:

locale - The locale to use

Returns:

the OidcUserInfo.Builder for further configurations

middleName

public OidcUserInfo.Builder middleName(String middleName)

Use this middle name in the resulting OidcUserInfo.

Parameters:

middleName - The middle name to use

Returns:

the OidcUserInfo.Builder for further configurations

name

public OidcUserInfo.Builder name(String name)

Use this name in the resulting OidcUserInfo.

Parameters:

name - The name to use

Returns:

the OidcUserInfo.Builder for further configurations

nickname

public OidcUserInfo.Builder nickname(String nickname)

Use this nickname in the resulting OidcUserInfo.

Parameters:

nickname - The nickname to use

Returns:

the OidcUserInfo.Builder for further configurations

picture

public OidcUserInfo.Builder picture(String picture)

Use this picture in the resulting OidcUserInfo.

Parameters:

picture - The picture to use

Returns:

the OidcUserInfo.Builder for further configurations

phoneNumber

public OidcUserInfo.Builder phoneNumber(String phoneNumber)

Use this phone number in the resulting OidcUserInfo.

Parameters:

phoneNumber - The phone number to use

Returns:

the OidcUserInfo.Builder for further configurations

phoneNumberVerified

public OidcUserInfo.Builder phoneNumberVerified(Boolean phoneNumberVerified)

Use this verified-phone-number indicator in the resulting OidcUserInfo.

Parameters:

phoneNumberVerified - The verified-phone-number indicator to use

Returns:

the OidcUserInfo.Builder for further configurations

Since:

5.8

preferredUsername

public OidcUserInfo.Builder preferredUsername(String preferredUsername)

Use this preferred username in the resulting OidcUserInfo.

Parameters:

preferredUsername - The preferred username to use

Returns:

the OidcUserInfo.Builder for further configurations

profile

public OidcUserInfo.Builder profile(String profile)

Use this profile in the resulting OidcUserInfo.

Parameters:

profile - The profile to use

Returns:

the OidcUserInfo.Builder for further configurations

subject

public OidcUserInfo.Builder subject(String subject)

Use this subject in the resulting OidcUserInfo.

Parameters:

subject - The subject to use

Returns:

the OidcUserInfo.Builder for further configurations

updatedAt

public OidcUserInfo.Builder updatedAt(String updatedAt)

Use this updated-at Instant in the resulting OidcUserInfo.

Parameters:

updatedAt - The updated-at Instant to use

Returns:

the OidcUserInfo.Builder for further configurations

website

public OidcUserInfo.Builder website(String website)

Use this website in the resulting OidcUserInfo.

Parameters:

website - The website to use

Returns:

the OidcUserInfo.Builder for further configurations

zoneinfo

public OidcUserInfo.Builder zoneinfo(String zoneinfo)

Use this zoneinfo in the resulting OidcUserInfo.

Parameters:

zoneinfo - The zoneinfo to use

Returns:

the OidcUserInfo.Builder for further configurations

build

public OidcUserInfo build()

Build the OidcUserInfo.

Returns:

The constructed OidcUserInfo