org.springframework.security.oauth2.jwt

Interface JwtDecoder

All Known Implementing Classes:

NimbusJwtDecoder, NimbusJwtDecoderJwkSupport

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface JwtDecoder

Implementations of this interface are responsible for "decoding" a JSON Web Token (JWT) from it's compact claims representation format to a Jwt.

JWTs may be represented using the JWS Compact Serialization format for a JSON Web Signature (JWS) structure or JWE Compact Serialization format for a JSON Web Encryption (JWE) structure. Therefore, implementors are responsible for verifying a JWS and/or decrypting a JWE.

Since:

5.0

See Also:

Jwt, JSON Web Token (JWT), JSON Web Signature (JWS), JSON Web Encryption (JWE), JWS Compact Serialization, JWE Compact Serialization

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.

Method Detail

decode

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

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

Parameters:

token - the JWT value

Returns:

a Jwt

Throws:

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