io.jsonwebtoken

Interface JwtHandler<T>

Type Parameters:

T - the type of object to return to the parser caller after handling the parsed JWT.

All Known Implementing Classes:

JwtHandlerAdapter

public interface JwtHandler<T>

A JwtHandler is invoked by a JwtParser after parsing a JWT to indicate the exact type of JWT or JWS parsed.

Since:

0.2

Method Summary

Methods

Modifier and Type	Method and Description
T	onClaimsJws(Jws<Claims> jws) This method is invoked when a JwtParser determines that the parsed JWT is a valid Claims JWS.
T	onClaimsJwt(Jwt<Header,Claims> jwt) This method is invoked when a JwtParser determines that the parsed JWT is a Claims JWT.
T	onPlaintextJws(Jws<String> jws) This method is invoked when a JwtParser determines that the parsed JWT is a plaintext JWS.
T	onPlaintextJwt(Jwt<Header,String> jwt) This method is invoked when a JwtParser determines that the parsed JWT is a plaintext JWT.

Method Detail

onPlaintextJwt

T onPlaintextJwt(Jwt<Header,String> jwt)

This method is invoked when a JwtParser determines that the parsed JWT is a plaintext JWT. A plaintext JWT has a String (non-JSON) body payload and it is not cryptographically signed.

Parameters:

jwt - the parsed plaintext JWT

Returns:

any object to be used after inspecting the JWT, or null if no return value is necessary.

onClaimsJwt

T onClaimsJwt(Jwt<Header,Claims> jwt)

This method is invoked when a JwtParser determines that the parsed JWT is a Claims JWT. A Claims JWT has a Claims body and it is not cryptographically signed.

Parameters:

jwt - the parsed claims JWT

Returns:

any object to be used after inspecting the JWT, or null if no return value is necessary.

onPlaintextJws

T onPlaintextJws(Jws<String> jws)

This method is invoked when a JwtParser determines that the parsed JWT is a plaintext JWS. A plaintext JWS is a JWT with a String (non-JSON) body (payload) that has been cryptographically signed.

This method will only be invoked if the cryptographic signature can be successfully verified.

Parameters:

jws - the parsed plaintext JWS

Returns:

any object to be used after inspecting the JWS, or null if no return value is necessary.

onClaimsJws

T onClaimsJws(Jws<Claims> jws)

This method is invoked when a JwtParser determines that the parsed JWT is a valid Claims JWS. A Claims JWS is a JWT with a Claims body that has been cryptographically signed.

This method will only be invoked if the cryptographic signature can be successfully verified.

Parameters:

jws - the parsed claims JWS

Returns:

any object to be used after inspecting the JWS, or null if no return value is necessary.