io.jsonwebtoken

Interface JwtHandler<T>

Type Parameters:

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

All Superinterfaces:

JwtVisitor<T>

All Known Implementing Classes:

JwtHandlerAdapter

Deprecated.

since 0.12.0 in favor of calling Jwt.accept(JwtVisitor).

@Deprecated
public interface JwtHandler<T>
extends JwtVisitor<T>

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

Since:

0.2

Method Summary

Methods

Modifier and Type	Method and Description
T	onClaimsJwe(Jwe<Claims> jwe) Deprecated. This method is invoked when a JwtParser determines that the parsed JWT is a valid Claims JWE.
T	onClaimsJws(Jws<Claims> jws) Deprecated. This method is invoked when a JwtParser determines that the parsed JWT is a valid Claims JWS.
T	onClaimsJwt(Jwt<Header,Claims> jwt) Deprecated. This method is invoked when a JwtParser determines that the parsed JWT is a Claims JWT.
T	onContentJwe(Jwe<byte[]> jwe) Deprecated. This method is invoked when a JwtParser determines that the parsed JWT is a content JWE.
T	onContentJws(Jws<byte[]> jws) Deprecated. This method is invoked when a JwtParser determines that the parsed JWT is a content JWS.
T	onContentJwt(Jwt<Header,byte[]> jwt) Deprecated. This method is invoked when a JwtParser determines that the parsed JWT is an unsecured content JWT.

Methods inherited from interface io.jsonwebtoken.JwtVisitor

visit, visit, visit

Method Detail

onContentJwt

T onContentJwt(Jwt<Header,byte[]> jwt)

Deprecated.

This method is invoked when a JwtParser determines that the parsed JWT is an unsecured content JWT. An unsecured content JWT has a byte array payload that is not cryptographically signed or encrypted. If the JWT creator set the (optional) contentType header value, the application may inspect that value to determine how to convert the byte array to the final content type as desired.

Parameters:

jwt - the parsed unsecured content 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)

Deprecated.

This method is invoked when a JwtParser determines that the parsed JWT is a Claims JWT. A Claims JWT has a Claims payload that is not cryptographically signed or encrypted.

Parameters:

jwt - the parsed claims JWT

Returns:

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

onContentJws

T onContentJws(Jws<byte[]> jws)

Deprecated.

This method is invoked when a JwtParser determines that the parsed JWT is a content JWS. A content JWS is a JWT with a byte array payload that has been cryptographically signed. If the JWT creator set the (optional) contentType header value, the application may inspect that value to determine how to convert the byte array to the final content type as desired.

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

Parameters:

jws - the parsed content 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)

Deprecated.

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 payload 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.

onContentJwe

T onContentJwe(Jwe<byte[]> jwe)

Deprecated.

This method is invoked when a JwtParser determines that the parsed JWT is a content JWE. A content JWE is a JWE with a byte array payload that has been encrypted. If the JWT creator set the (optional) contentType header value, the application may inspect that value to determine how to convert the byte array to the final content type as desired.

This method will only be invoked if the content JWE can be successfully decrypted.

Parameters:

jwe - the parsed content jwe

Returns:

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

Since:

0.12.0

onClaimsJwe

T onClaimsJwe(Jwe<Claims> jwe)

Deprecated.

This method is invoked when a JwtParser determines that the parsed JWT is a valid Claims JWE. A Claims JWE is a JWT with a Claims payload that has been encrypted.

This method will only be invoked if the Claims JWE can be successfully decrypted.

Parameters:

jwe - the parsed claims jwe

Returns:

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

Since:

0.12.0