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

Class OidcIdToken.Builder

java.lang.Object

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

Enclosing class:

OidcIdToken

public static final class OidcIdToken.Builder
extends Object

A builder for OidcIdTokens

Since:

5.3

Method Summary

Modifier and Type	Method	Description
OidcIdToken.Builder	accessTokenHash(String accessTokenHash)	Use this access token hash in the resulting OidcIdToken
OidcIdToken.Builder	audience(Collection<String> audience)	Use this audience in the resulting OidcIdToken
OidcIdToken.Builder	authenticationContextClass(String authenticationContextClass)	Use this authentication context class reference in the resulting OidcIdToken
OidcIdToken.Builder	authenticationMethods(List<String> authenticationMethods)	Use these authentication methods in the resulting OidcIdToken
OidcIdToken.Builder	authorizationCodeHash(String authorizationCodeHash)	Use this authorization code hash in the resulting OidcIdToken
OidcIdToken.Builder	authorizedParty(String authorizedParty)	Use this authorized party in the resulting OidcIdToken
OidcIdToken.Builder	authTime(Instant authenticatedAt)	Use this authentication Instant in the resulting OidcIdToken
OidcIdToken	build()	Build the OidcIdToken
OidcIdToken.Builder	claim(String name, Object value)	Use this claim in the resulting OidcIdToken
OidcIdToken.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.
OidcIdToken.Builder	expiresAt(Instant expiresAt)	Use this expiration in the resulting OidcIdToken
OidcIdToken.Builder	issuedAt(Instant issuedAt)	Use this issued-at timestamp in the resulting OidcIdToken
OidcIdToken.Builder	issuer(String issuer)	Use this issuer in the resulting OidcIdToken
OidcIdToken.Builder	nonce(String nonce)	Use this nonce in the resulting OidcIdToken
OidcIdToken.Builder	subject(String subject)	Use this subject in the resulting OidcIdToken
OidcIdToken.Builder	tokenValue(String tokenValue)	Use this token value in the resulting OidcIdToken

Methods inherited from class java.lang.Object

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

Method Details

tokenValue

public OidcIdToken.Builder tokenValue(String tokenValue)

Use this token value in the resulting OidcIdToken

Parameters:

tokenValue - The token value to use

Returns:

the OidcIdToken.Builder for further configurations

claim

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

Use this claim in the resulting OidcIdToken

Parameters:

name - The claim name

value - The claim value

Returns:

the OidcIdToken.Builder for further configurations

claims

public OidcIdToken.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 OidcIdToken.Builder for further configurations

accessTokenHash

public OidcIdToken.Builder accessTokenHash(String accessTokenHash)

Use this access token hash in the resulting OidcIdToken

Parameters:

accessTokenHash - The access token hash to use

Returns:

the OidcIdToken.Builder for further configurations

audience

public OidcIdToken.Builder audience(Collection<String> audience)

Use this audience in the resulting OidcIdToken

Parameters:

audience - The audience(s) to use

Returns:

the OidcIdToken.Builder for further configurations

authTime

public OidcIdToken.Builder authTime(Instant authenticatedAt)

Use this authentication Instant in the resulting OidcIdToken

Parameters:

authenticatedAt - The authentication Instant to use

Returns:

the OidcIdToken.Builder for further configurations

authenticationContextClass

public OidcIdToken.Builder authenticationContextClass(String authenticationContextClass)

Use this authentication context class reference in the resulting OidcIdToken

Parameters:

authenticationContextClass - The authentication context class reference to use

Returns:

the OidcIdToken.Builder for further configurations

authenticationMethods

public OidcIdToken.Builder authenticationMethods(List<String> authenticationMethods)

Use these authentication methods in the resulting OidcIdToken

Parameters:

authenticationMethods - The authentication methods to use

Returns:

the OidcIdToken.Builder for further configurations

authorizationCodeHash

public OidcIdToken.Builder authorizationCodeHash(String authorizationCodeHash)

Use this authorization code hash in the resulting OidcIdToken

Parameters:

authorizationCodeHash - The authorization code hash to use

Returns:

the OidcIdToken.Builder for further configurations

authorizedParty

public OidcIdToken.Builder authorizedParty(String authorizedParty)

Use this authorized party in the resulting OidcIdToken

Parameters:

authorizedParty - The authorized party to use

Returns:

the OidcIdToken.Builder for further configurations

expiresAt

public OidcIdToken.Builder expiresAt(Instant expiresAt)

Use this expiration in the resulting OidcIdToken

Parameters:

expiresAt - The expiration to use

Returns:

the OidcIdToken.Builder for further configurations

issuedAt

public OidcIdToken.Builder issuedAt(Instant issuedAt)

Use this issued-at timestamp in the resulting OidcIdToken

Parameters:

issuedAt - The issued-at timestamp to use

Returns:

the OidcIdToken.Builder for further configurations

issuer

public OidcIdToken.Builder issuer(String issuer)

Use this issuer in the resulting OidcIdToken

Parameters:

issuer - The issuer to use

Returns:

the OidcIdToken.Builder for further configurations

nonce

public OidcIdToken.Builder nonce(String nonce)

Use this nonce in the resulting OidcIdToken

Parameters:

nonce - The nonce to use

Returns:

the OidcIdToken.Builder for further configurations

subject

public OidcIdToken.Builder subject(String subject)

Use this subject in the resulting OidcIdToken

Parameters:

subject - The subject to use

Returns:

the OidcIdToken.Builder for further configurations

build

public OidcIdToken build()

Build the OidcIdToken

Returns:

The constructed OidcIdToken