org.springframework.security.oauth2.jwt

Class NimbusJwtDecoder

java.lang.Object

org.springframework.security.oauth2.jwt.NimbusJwtDecoder

All Implemented Interfaces:

JwtDecoder

public final class NimbusJwtDecoder
extends java.lang.Object
implements JwtDecoder

A low-level Nimbus implementation of JwtDecoder which takes a raw Nimbus configuration. It's simple to produce an instance of JWTProcessor using JwtProcessors:

        JWTProcessor<SecurityContext> jwtProcessor = JwtProcessors.fromJwkSetUri(uri).build();
        NimbusJwtDecoder jwtDecoder = new NimbusJwtDecoder(jwtProcessor);
 

Since:

5.2

See Also:

JwtProcessors

Constructor Summary

Constructors

Constructor and Description
NimbusJwtDecoder(com.nimbusds.jwt.proc.JWTProcessor<com.nimbusds.jose.proc.SecurityContext> jwtProcessor) Configures a NimbusJwtDecoder with the given parameters

Method Summary

Modifier and Type	Method and Description
Jwt	decode(java.lang.String token) Decode and validate the JWT from its compact claims representation format
void	setClaimSetConverter(org.springframework.core.convert.converter.Converter<java.util.Map<java.lang.String,java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>> claimSetConverter) Use the following Converter for manipulating the JWT's claim set
void	setJwtValidator(OAuth2TokenValidator<Jwt> jwtValidator) Use this Jwt Validator

Methods inherited from class java.lang.Object

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

Constructor Detail

NimbusJwtDecoder

public NimbusJwtDecoder(com.nimbusds.jwt.proc.JWTProcessor<com.nimbusds.jose.proc.SecurityContext> jwtProcessor)

Configures a NimbusJwtDecoder with the given parameters

Parameters:

jwtProcessor - - the JWTProcessor to use

Method Detail

setJwtValidator

public void setJwtValidator(OAuth2TokenValidator<Jwt> jwtValidator)

Use this Jwt Validator

Parameters:

jwtValidator - - the Jwt Validator to use

setClaimSetConverter

public void setClaimSetConverter(org.springframework.core.convert.converter.Converter<java.util.Map<java.lang.String,java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>> claimSetConverter)

Use the following Converter for manipulating the JWT's claim set

Parameters:

claimSetConverter - the Converter to use

decode

public Jwt decode(java.lang.String token)
           throws JwtException

Decode and validate the JWT from its compact claims representation format

Specified by:

decode in interface JwtDecoder

Parameters:

token - the JWT value

Returns:

a validated Jwt

Throws:

JwtException