org.springframework.security.oauth2.jwt

Class NimbusJwtDecoderJwkSupport

java.lang.Object

org.springframework.security.oauth2.jwt.NimbusJwtDecoderJwkSupport

All Implemented Interfaces:

JwtDecoder

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

An implementation of a JwtDecoder that "decodes" a JSON Web Token (JWT) and additionally verifies it's digital signature if the JWT is a JSON Web Signature (JWS). The public key used for verification is obtained from the JSON Web Key (JWK) Set URL supplied via the constructor.

NOTE: This implementation uses the Nimbus JOSE + JWT SDK internally.

Since:

5.0

See Also:

JwtDecoder, JSON Web Token (JWT), JSON Web Signature (JWS), JSON Web Key (JWK), Nimbus JOSE + JWT SDK

Constructor Summary

Constructors

Constructor and Description
NimbusJwtDecoderJwkSupport(java.lang.String jwkSetUrl) Constructs a NimbusJwtDecoderJwkSupport using the provided parameters.
NimbusJwtDecoderJwkSupport(java.lang.String jwkSetUrl, java.lang.String jwsAlgorithm) Constructs a NimbusJwtDecoderJwkSupport using the provided parameters.

Method Summary

Modifier and Type	Method and Description
Jwt	decode(java.lang.String token) Decodes the JWT from it's compact claims representation format and returns a Jwt.
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
void	setRestOperations(org.springframework.web.client.RestOperations restOperations) Sets the RestOperations used when requesting the JSON Web Key (JWK) Set.

Methods inherited from class java.lang.Object

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

Constructor Detail

NimbusJwtDecoderJwkSupport

public NimbusJwtDecoderJwkSupport(java.lang.String jwkSetUrl)

Constructs a NimbusJwtDecoderJwkSupport using the provided parameters.

Parameters:

jwkSetUrl - the JSON Web Key (JWK) Set URL

NimbusJwtDecoderJwkSupport

public NimbusJwtDecoderJwkSupport(java.lang.String jwkSetUrl,
                                  java.lang.String jwsAlgorithm)

Constructs a NimbusJwtDecoderJwkSupport using the provided parameters.

Parameters:

jwkSetUrl - the JSON Web Key (JWK) Set URL

jwsAlgorithm - the JSON Web Algorithm (JWA) used for verifying the digital signatures

Method Detail

decode

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

Description copied from interface: JwtDecoder

Decodes the JWT from it's compact claims representation format and returns a Jwt.

Specified by:

decode in interface JwtDecoder

Parameters:

token - the JWT value

Returns:

a Jwt

Throws:

JwtException - if an error occurs while attempting to decode the JWT

setJwtValidator

public void setJwtValidator(OAuth2TokenValidator<Jwt> jwtValidator)

Use this Jwt Validator

Parameters:

jwtValidator - - the Jwt Validator to use

setClaimSetConverter

public final 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

setRestOperations

public final void setRestOperations(org.springframework.web.client.RestOperations restOperations)

Sets the RestOperations used when requesting the JSON Web Key (JWK) Set.

Parameters:

restOperations - the RestOperations used when requesting the JSON Web Key (JWK) Set

Since:

5.1