Package org.springframework.security.oauth2.jwt

Class NimbusJwtEncoder.SecretKeyJwtEncoderBuilder

java.lang.Object

org.springframework.security.oauth2.jwt.NimbusJwtEncoder.SecretKeyJwtEncoderBuilder

Enclosing class:

NimbusJwtEncoder

public static final class NimbusJwtEncoder.SecretKeyJwtEncoderBuilder
extends Object

A builder for creating NimbusJwtEncoder instances configured with a SecretKey.

Since:

7.0

Method Summary

Modifier and Type	Method	Description
NimbusJwtEncoder.SecretKeyJwtEncoderBuilder	algorithm(MacAlgorithm macAlgorithm)	Sets the JWS algorithm to use for signing.
NimbusJwtEncoder	build()	Builds the NimbusJwtEncoder instance.
NimbusJwtEncoder.SecretKeyJwtEncoderBuilder	jwkPostProcessor(Consumer<com.nimbusds.jose.jwk.OctetSequenceKey.Builder> jwkPostProcessor)	Post-process the JWK using the given Consumer.

Methods inherited from class java.lang.Object

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

Method Details

algorithm

public NimbusJwtEncoder.SecretKeyJwtEncoderBuilder algorithm(MacAlgorithm macAlgorithm)

Sets the JWS algorithm to use for signing. Defaults to JWSAlgorithm.HS256. Must be an HMAC-based algorithm (HS256, HS384, or HS512).

Parameters:

macAlgorithm - the MacAlgorithm to use

Returns:

this builder instance for method chaining

jwkPostProcessor

public NimbusJwtEncoder.SecretKeyJwtEncoderBuilder jwkPostProcessor(Consumer<com.nimbusds.jose.jwk.OctetSequenceKey.Builder> jwkPostProcessor)

Post-process the JWK using the given Consumer. For example, you may use this to override the default kid

Parameters:

jwkPostProcessor - the post-processor to use

Returns:

this builder instance for method chaining

build

public NimbusJwtEncoder build()

Builds the NimbusJwtEncoder instance.

Returns:

the configured NimbusJwtEncoder

Throws:

IllegalStateException - if the configured JWS algorithm is not compatible with a SecretKey.