org.springframework.security.oauth2.server.authorization.token

Class OAuth2TokenClaimsSet.Builder

java.lang.Object

org.springframework.security.oauth2.server.authorization.token.OAuth2TokenClaimsSet.Builder

Enclosing class:

OAuth2TokenClaimsSet

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

A builder for OAuth2TokenClaimsSet.

Method Summary

Modifier and Type	Method and Description
OAuth2TokenClaimsSet.Builder	audience(java.util.List<java.lang.String> audience) Sets the audience (aud) claim, which identifies the recipient(s) that the OAuth 2.0 Token is intended for.
OAuth2TokenClaimsSet	build() Builds a new OAuth2TokenClaimsSet.
OAuth2TokenClaimsSet.Builder	claim(java.lang.String name, java.lang.Object value) Sets the claim.
OAuth2TokenClaimsSet.Builder	claims(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> claimsConsumer) A Consumer to be provided access to the claims allowing the ability to add, replace, or remove.
OAuth2TokenClaimsSet.Builder	expiresAt(java.time.Instant expiresAt) Sets the expiration time (exp) claim, which identifies the time on or after which the OAuth 2.0 Token MUST NOT be accepted for processing.
OAuth2TokenClaimsSet.Builder	id(java.lang.String jti) Sets the ID (jti) claim, which provides a unique identifier for the OAuth 2.0 Token.
OAuth2TokenClaimsSet.Builder	issuedAt(java.time.Instant issuedAt) Sets the issued at (iat) claim, which identifies the time at which the OAuth 2.0 Token was issued.
OAuth2TokenClaimsSet.Builder	issuer(java.lang.String issuer) Sets the issuer (iss) claim, which identifies the principal that issued the OAuth 2.0 Token.
OAuth2TokenClaimsSet.Builder	notBefore(java.time.Instant notBefore) Sets the not before (nbf) claim, which identifies the time before which the OAuth 2.0 Token MUST NOT be accepted for processing.
OAuth2TokenClaimsSet.Builder	subject(java.lang.String subject) Sets the subject (sub) claim, which identifies the principal that is the subject of the OAuth 2.0 Token.

Methods inherited from class java.lang.Object

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

Method Detail

issuer

public OAuth2TokenClaimsSet.Builder issuer(java.lang.String issuer)

Sets the issuer (iss) claim, which identifies the principal that issued the OAuth 2.0 Token.

Parameters:

issuer - the issuer identifier

Returns:

the OAuth2TokenClaimsSet.Builder

subject

public OAuth2TokenClaimsSet.Builder subject(java.lang.String subject)

Sets the subject (sub) claim, which identifies the principal that is the subject of the OAuth 2.0 Token.

Parameters:

subject - the subject identifier

Returns:

the OAuth2TokenClaimsSet.Builder

audience

public OAuth2TokenClaimsSet.Builder audience(java.util.List<java.lang.String> audience)

Sets the audience (aud) claim, which identifies the recipient(s) that the OAuth 2.0 Token is intended for.

Parameters:

audience - the audience that this OAuth 2.0 Token is intended for

Returns:

the OAuth2TokenClaimsSet.Builder

expiresAt

public OAuth2TokenClaimsSet.Builder expiresAt(java.time.Instant expiresAt)

Sets the expiration time (exp) claim, which identifies the time on or after which the OAuth 2.0 Token MUST NOT be accepted for processing.

Parameters:

expiresAt - the time on or after which the OAuth 2.0 Token MUST NOT be accepted for processing

Returns:

the OAuth2TokenClaimsSet.Builder

notBefore

public OAuth2TokenClaimsSet.Builder notBefore(java.time.Instant notBefore)

Sets the not before (nbf) claim, which identifies the time before which the OAuth 2.0 Token MUST NOT be accepted for processing.

Parameters:

notBefore - the time before which the OAuth 2.0 Token MUST NOT be accepted for processing

Returns:

the OAuth2TokenClaimsSet.Builder

issuedAt

public OAuth2TokenClaimsSet.Builder issuedAt(java.time.Instant issuedAt)

Sets the issued at (iat) claim, which identifies the time at which the OAuth 2.0 Token was issued.

Parameters:

issuedAt - the time at which the OAuth 2.0 Token was issued

Returns:

the OAuth2TokenClaimsSet.Builder

id

public OAuth2TokenClaimsSet.Builder id(java.lang.String jti)

Sets the ID (jti) claim, which provides a unique identifier for the OAuth 2.0 Token.

Parameters:

jti - the unique identifier for the OAuth 2.0 Token

Returns:

the OAuth2TokenClaimsSet.Builder

claim

public OAuth2TokenClaimsSet.Builder claim(java.lang.String name,
                                          java.lang.Object value)

Sets the claim.

Parameters:

name - the claim name

value - the claim value

Returns:

the OAuth2TokenClaimsSet.Builder

claims

public OAuth2TokenClaimsSet.Builder claims(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> claimsConsumer)

A Consumer to be provided access to the claims allowing the ability to add, replace, or remove.

Parameters:

claimsConsumer - a Consumer of the claims

build

public OAuth2TokenClaimsSet build()

Builds a new OAuth2TokenClaimsSet.

Returns:

a OAuth2TokenClaimsSet