Package org.springframework.security.oauth2.jwt

Interface JwtEncoder

All Known Implementing Classes:

NimbusJwtEncoder

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 JwtEncoder

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

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 signing a JWS and/or encrypting a JWE.

Since:

5.6

See Also:

• Jwt
• JwtEncoderParameters
• JwtDecoder
• JSON Web Token (JWT)
• JSON Web Signature (JWS)
• JSON Web Encryption (JWE)
• JWS Compact Serialization
• JWE Compact Serialization

Method Summary

Modifier and Type	Method	Description
Jwt	encode(JwtEncoderParameters parameters)	Encode the JWT to it's compact claims representation format.

Method Details

encode

Jwt encode(JwtEncoderParameters parameters)
    throws JwtEncodingException

Encode the JWT to it's compact claims representation format.

Parameters:

parameters - the parameters containing the JOSE header and JWT Claims Set

Returns:

a Jwt

Throws:

JwtEncodingException - if an error occurs while attempting to encode the JWT