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

Class JwtGenerator

java.lang.Object

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

All Implemented Interfaces:

OAuth2TokenGenerator<org.springframework.security.oauth2.jwt.Jwt>

public final class JwtGenerator
extends Object
implements OAuth2TokenGenerator<org.springframework.security.oauth2.jwt.Jwt>

An OAuth2TokenGenerator that generates a Jwt used for an OAuth2AccessToken or OidcIdToken.

Since:

0.2.3

See Also:

• OAuth2TokenGenerator
• Jwt
• JwtEncoder
• OAuth2TokenCustomizer
• JwtEncodingContext
• OAuth2AccessToken
• OidcIdToken

Constructor Summary

Constructors

Constructor	Description
JwtGenerator(org.springframework.security.oauth2.jwt.JwtEncoder jwtEncoder)	Constructs a JwtGenerator using the provided parameters.

Method Summary

Modifier and Type	Method	Description
org.springframework.security.oauth2.jwt.Jwt	generate(OAuth2TokenContext context)	Generate an OAuth 2.0 Token using the attributes contained in the OAuth2TokenContext, or return null if the OAuth2TokenContext.getTokenType() is not supported.
void	setJwtCustomizer(OAuth2TokenCustomizer<JwtEncodingContext> jwtCustomizer)	Sets the OAuth2TokenCustomizer that customizes the JWS headers and/or claims for the generated Jwt.

Methods inherited from class java.lang.Object

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

Constructor Details

JwtGenerator

public JwtGenerator(org.springframework.security.oauth2.jwt.JwtEncoder jwtEncoder)

Constructs a JwtGenerator using the provided parameters.

Parameters:

jwtEncoder - the jwt encoder

Method Details

generate

@Nullable
public org.springframework.security.oauth2.jwt.Jwt generate(OAuth2TokenContext context)

Description copied from interface: OAuth2TokenGenerator

Generate an OAuth 2.0 Token using the attributes contained in the OAuth2TokenContext, or return null if the OAuth2TokenContext.getTokenType() is not supported.

If the returned OAuth2Token has a set of claims, it should implement ClaimAccessor in order for it to be stored with the OAuth2Authorization.

Specified by:

generate in interface OAuth2TokenGenerator<org.springframework.security.oauth2.jwt.Jwt>

Parameters:

context - the context containing the OAuth 2.0 Token attributes

Returns:

an OAuth2Token or null if the OAuth2TokenContext.getTokenType() is not supported

setJwtCustomizer

public void setJwtCustomizer(OAuth2TokenCustomizer<JwtEncodingContext> jwtCustomizer)

Sets the OAuth2TokenCustomizer that customizes the JWS headers and/or claims for the generated Jwt.

Parameters:

jwtCustomizer - the OAuth2TokenCustomizer that customizes the headers and/or claims for the generated Jwt