io.jsonwebtoken

Class SupportedJwtVisitor<T>

java.lang.Object

io.jsonwebtoken.SupportedJwtVisitor<T>

Type Parameters:

T - the type of value returned from the subclass handler method implementation.

All Implemented Interfaces:

JwtVisitor<T>

Direct Known Subclasses:

JwtHandlerAdapter

public class SupportedJwtVisitor<T>
extends Object
implements JwtVisitor<T>

A JwtVisitor that guarantees only supported JWT instances are handled, rejecting all other (unsupported) JWTs with UnsupportedJwtExceptions. A JWT is considered supported only if the type-specific handler method is overridden by a subclass.

Since:

0.12.0

Constructor Summary

Constructors

Constructor and Description
SupportedJwtVisitor() Default constructor, does not initialize any internal state.

Method Summary

Methods

Modifier and Type	Method and Description
T	onDecryptedClaims(Jwe<Claims> jwe) Handles an encountered JWE message that has been authenticated and decrypted, and has a Claims payload.
T	onDecryptedContent(Jwe<byte[]> jwe) Handles an encountered JWE message that has been authenticated and decrypted, and has byte[] array payload.
T	onUnsecuredClaims(Jwt<Header,Claims> jwt) Handles an encountered unsecured Claims JWT - one that is not cryptographically signed nor encrypted, and has a Claims payload.
T	onUnsecuredContent(Jwt<Header,byte[]> jwt) Handles an encountered unsecured content JWT - one that is not cryptographically signed nor encrypted, and has a byte[] array payload.
T	onVerifiedClaims(Jws<Claims> jws) Handles an encountered JWS message that has been cryptographically verified/authenticated and has a Claims payload.
T	onVerifiedContent(Jws<byte[]> jws) Handles an encountered JWS message that has been cryptographically verified/authenticated and has a byte[] array payload.
T	visit(Jwe<?> jwe) Handles an encountered JSON Web Encryption (aka 'JWE') message that has been authenticated and decrypted by delegating to either onDecryptedContent(Jwe) or onDecryptedClaims(Jwe) depending on the payload type.
T	visit(Jws<?> jws) Handles an encountered JSON Web Token (aka 'JWS') message that has been cryptographically verified/authenticated by delegating to either onVerifiedContent(Jws) or onVerifiedClaims(Jws) depending on the payload type.
T	visit(Jwt<?,?> jwt) Handles an encountered unsecured JWT by delegating to either onUnsecuredContent(Jwt) or onUnsecuredClaims(Jwt) depending on the payload type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SupportedJwtVisitor

public SupportedJwtVisitor()

Default constructor, does not initialize any internal state.

Method Detail

visit

public T visit(Jwt<?,?> jwt)

Handles an encountered unsecured JWT by delegating to either onUnsecuredContent(Jwt) or onUnsecuredClaims(Jwt) depending on the payload type.

Specified by:

visit in interface JwtVisitor<T>

Parameters:

jwt - the parsed unsecured JWT

Returns:

the value returned by either onUnsecuredContent(Jwt) or onUnsecuredClaims(Jwt) depending on the payload type.

Throws:

UnsupportedJwtException - if the payload is neither a byte[] nor Claims, or either delegate method throws the same.

onUnsecuredContent

public T onUnsecuredContent(Jwt<Header,byte[]> jwt)
                     throws UnsupportedJwtException

Handles an encountered unsecured content JWT - one that is not cryptographically signed nor encrypted, and has a byte[] array payload. If 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.

The default implementation immediately throws an UnsupportedJwtException; it is expected that subclasses will override this method if the application needs to support this type of JWT.

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.

Throws:

UnsupportedJwtException - by default, expecting the subclass implementation to override as necessary.

onUnsecuredClaims

public T onUnsecuredClaims(Jwt<Header,Claims> jwt)

Handles an encountered unsecured Claims JWT - one that is not cryptographically signed nor encrypted, and has a Claims payload.

The default implementation immediately throws an UnsupportedJwtException; it is expected that subclasses will override this method if the application needs to support this type of JWT.

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.

Throws:

UnsupportedJwtException - by default, expecting the subclass implementation to override as necessary.

visit

public T visit(Jws<?> jws)

Handles an encountered JSON Web Token (aka 'JWS') message that has been cryptographically verified/authenticated by delegating to either onVerifiedContent(Jws) or onVerifiedClaims(Jws) depending on the payload type.

Specified by:

visit in interface JwtVisitor<T>

Parameters:

jws - the parsed verified/authenticated JWS.

Returns:

the value returned by either onVerifiedContent(Jws) or onVerifiedClaims(Jws) depending on the payload type.

Throws:

UnsupportedJwtException - if the payload is neither a byte[] nor Claims, or either delegate method throws the same.

onVerifiedContent

public T onVerifiedContent(Jws<byte[]> jws)

Handles an encountered JWS message that has been cryptographically verified/authenticated and has a byte[] array payload. If 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.

The default implementation immediately throws an UnsupportedJwtException; it is expected that subclasses will override this method if the application needs to support this type of JWT.

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.

Throws:

UnsupportedJwtException - by default, expecting the subclass implementation to override as necessary.

onVerifiedClaims

public T onVerifiedClaims(Jws<Claims> jws)

Handles an encountered JWS message that has been cryptographically verified/authenticated and has a Claims payload.

The default implementation immediately throws an UnsupportedJwtException; it is expected that subclasses will override this method if the application needs to support this type of JWT.

Parameters:

jws - the parsed signed (and verified) Claims JWS

Returns:

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

Throws:

UnsupportedJwtException - by default, expecting the subclass implementation to override as necessary.

visit

public T visit(Jwe<?> jwe)

Handles an encountered JSON Web Encryption (aka 'JWE') message that has been authenticated and decrypted by delegating to either onDecryptedContent(Jwe) or onDecryptedClaims(Jwe) depending on the payload type.

Specified by:

visit in interface JwtVisitor<T>

Parameters:

jwe - the parsed authenticated and decrypted JWE.

Returns:

the value returned by either onDecryptedContent(Jwe) or onDecryptedClaims(Jwe) depending on the payload type.

Throws:

UnsupportedJwtException - if the payload is neither a byte[] nor Claims, or either delegate method throws the same.

onDecryptedContent

public T onDecryptedContent(Jwe<byte[]> jwe)

Handles an encountered JWE message that has been authenticated and decrypted, and has byte[] array payload. If 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.

The default implementation immediately throws an UnsupportedJwtException; it is expected that subclasses will override this method if the application needs to support this type of JWT.

Parameters:

jwe - the parsed authenticated and decrypted content JWE.

Returns:

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

Throws:

UnsupportedJwtException - by default, expecting the subclass implementation to override as necessary.

onDecryptedClaims

public T onDecryptedClaims(Jwe<Claims> jwe)

Handles an encountered JWE message that has been authenticated and decrypted, and has a Claims payload.

The default implementation immediately throws an UnsupportedJwtException; it is expected that subclasses will override this method if the application needs to support this type of JWT.

Parameters:

jwe - the parsed authenticated and decrypted content JWE.

Returns:

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

Throws:

UnsupportedJwtException - by default, expecting the subclass implementation to override as necessary.