OidcUserInfo.Builder (spring-security-docs-manual 5.4.7 API)

java.lang.Object
- org.springframework.security.oauth2.core.oidc.OidcUserInfo.Builder

Enclosing class:: OidcUserInfo

public static final class OidcUserInfo.Builder
extends java.lang.Object

A builder for OidcUserInfos

Since:: 5.3

Method Summary

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

Class OidcUserInfo.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

claim

claims

address

birthdate

email

emailVerified

familyName

gender

givenName

locale

middleName

name

nickname

picture

phoneNumber

phoneNumberVerified

preferredUsername

profile

subject

updatedAt

website

zoneinfo

build