Package org.springframework.security.oauth2.client.oidc.authentication.logout

Class OidcLogoutToken.Builder

java.lang.Object

org.springframework.security.oauth2.client.oidc.authentication.logout.OidcLogoutToken.Builder

Enclosing class:

OidcLogoutToken

public static final class OidcLogoutToken.Builder
extends Object

A builder for OidcLogoutTokens

Method Summary

Modifier and Type	Method	Description
OidcLogoutToken.Builder	audience(Collection<String> audience)	Use this audience in the resulting OidcLogoutToken
OidcLogoutToken	build()
OidcLogoutToken.Builder	claim(String name, Object value)	Use this claim in the resulting OidcLogoutToken
OidcLogoutToken.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.
OidcLogoutToken.Builder	events(Map<String,Object> events)	A JSON object that identifies this token as a logout token
OidcLogoutToken.Builder	issuedAt(Instant issuedAt)	Use this issued-at timestamp in the resulting OidcLogoutToken
OidcLogoutToken.Builder	issuer(String issuer)	Use this issuer in the resulting OidcLogoutToken
OidcLogoutToken.Builder	jti(String jti)	Use this id to identify the resulting OidcLogoutToken
OidcLogoutToken.Builder	sessionId(String sessionId)	Use this session id to correlate the OIDC Provider session
OidcLogoutToken.Builder	subject(String subject)	Use this subject in the resulting OidcLogoutToken
OidcLogoutToken.Builder	tokenValue(String tokenValue)	Use this token value in the resulting OidcLogoutToken

Methods inherited from class java.lang.Object

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

Method Details

tokenValue

public OidcLogoutToken.Builder tokenValue(String tokenValue)

Use this token value in the resulting OidcLogoutToken

Parameters:

tokenValue - The token value to use

Returns:

the OidcLogoutToken.Builder for further configurations

claim

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

Use this claim in the resulting OidcLogoutToken

Parameters:

name - The claim name

value - The claim value

Returns:

the OidcLogoutToken.Builder for further configurations

claims

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

audience

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

Use this audience in the resulting OidcLogoutToken

Parameters:

audience - The audience(s) to use

Returns:

the OidcLogoutToken.Builder for further configurations

issuedAt

public OidcLogoutToken.Builder issuedAt(Instant issuedAt)

Use this issued-at timestamp in the resulting OidcLogoutToken

Parameters:

issuedAt - The issued-at timestamp to use

Returns:

the OidcLogoutToken.Builder for further configurations

issuer

public OidcLogoutToken.Builder issuer(String issuer)

Use this issuer in the resulting OidcLogoutToken

Parameters:

issuer - The issuer to use

Returns:

the OidcLogoutToken.Builder for further configurations

jti

public OidcLogoutToken.Builder jti(String jti)

Use this id to identify the resulting OidcLogoutToken

Parameters:

jti - The unique identifier to use

Returns:

the OidcLogoutToken.Builder for further configurations

subject

public OidcLogoutToken.Builder subject(String subject)

Use this subject in the resulting OidcLogoutToken

Parameters:

subject - The subject to use

Returns:

the OidcLogoutToken.Builder for further configurations

events

public OidcLogoutToken.Builder events(Map<String,Object> events)

A JSON object that identifies this token as a logout token

Parameters:

events - The JSON object to use

Returns:

the OidcLogoutToken.Builder for further configurations

sessionId

public OidcLogoutToken.Builder sessionId(String sessionId)

Use this session id to correlate the OIDC Provider session

Parameters:

sessionId - The session id to use

Returns:

the OidcLogoutToken.Builder for further configurations

build

public OidcLogoutToken build()