io.jsonwebtoken

Interface JwtVisitor<T>

Type Parameters:

T - the type of object to return after invoking the Jwt.accept(JwtVisitor) method.

All Known Subinterfaces:

JwtHandler<T>

All Known Implementing Classes:

JwtHandlerAdapter, SupportedJwtVisitor

public interface JwtVisitor<T>

A JwtVisitor supports the Visitor design pattern for Jwt instances. Visitor implementations define logic for a specific JWT subtype or payload subtype avoiding type-checking if-then-else conditionals in favor of type-safe method dispatch when encountering a JWT.

Since:

0.12.0

Method Summary

Methods

Modifier and Type	Method and Description
T	visit(Jwe<?> jwe) Handles an encountered JSON Web Encryption (aka 'JWE') message that has been authenticated and decrypted.
T	visit(Jws<?> jws) Handles an encountered JSON Web Signature (aka 'JWS') message that has been cryptographically verified/authenticated.
T	visit(Jwt<?,?> jwt) Handles an encountered Unsecured JWT that has not been cryptographically secured at all.

Method Detail

visit

T visit(Jwt<?,?> jwt)

Handles an encountered Unsecured JWT that has not been cryptographically secured at all. Implementations can check the Jwt.getPayload() to determine if it is a Claims instance or a byte[] array.

If the payload is a byte[] array, and the JWT creator has set the (optional) Header.getContentType() value, the application may inspect that value to determine how to convert the byte array to the final type as desired.

Parameters:

jwt - the parsed Unsecured JWT.

Returns:

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

visit

T visit(Jws<?> jws)

Handles an encountered JSON Web Signature (aka 'JWS') message that has been cryptographically verified/authenticated. Implementations can check the Jwt.getPayload() determine if it is a Claims instance or a byte[] array.

If the payload is a byte[] array, and the JWS creator has set the (optional) Header.getContentType() value, the application may inspect that value to determine how to convert the byte array to the final type as desired.

Parameters:

jws - the parsed verified/authenticated JWS.

Returns:

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

visit

T visit(Jwe<?> jwe)

Handles an encountered JSON Web Encryption (aka 'JWE') message that has been authenticated and decrypted. Implementations can check the (decrypted) Jwt.getPayload() to determine if it is a Claims instance or a byte[] array.

If the payload is a byte[] array, and the JWE creator has set the (optional) Header.getContentType() value, the application may inspect that value to determine how to convert the byte array to the final type as desired.

Parameters:

jwe - the parsed authenticated and decrypted JWE.

Returns:

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