T - the type of object to return to the parser caller after handling the parsed JWT.public class JwtHandlerAdapter<T> extends Object implements JwtHandler<T>
JwtHandler interface that allows for anonymous subclasses to process only the JWT results that are
known/expected for a particular use case.
All of the methods in this implementation throw exceptions: overridden methods represent scenarios expected by calling code in known situations. It would be unexpected to receive a JWS or JWT that did not match parsing expectations, so all non-overridden methods throw exceptions to indicate that the JWT input was unexpected.
| Constructor and Description |
|---|
JwtHandlerAdapter() |
| 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. |
public T onPlaintextJwt(Jwt<Header,String> jwt)
JwtHandlerJwtParser 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.onPlaintextJwt in interface JwtHandler<T>jwt - the parsed plaintext JWTnull if no return value is necessary.public T onClaimsJwt(Jwt<Header,Claims> jwt)
JwtHandlerJwtParser determines that the parsed JWT is
a Claims JWT. A Claims JWT has a Claims body and it is not cryptographically signed.onClaimsJwt in interface JwtHandler<T>jwt - the parsed claims JWTnull if no return value is necessary.public T onPlaintextJws(Jws<String> jws)
JwtHandlerJwtParser 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.
onPlaintextJws in interface JwtHandler<T>jws - the parsed plaintext JWSnull if no return value is necessary.public T onClaimsJws(Jws<Claims> jws)
JwtHandlerJwtParser 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.
onClaimsJws in interface JwtHandler<T>jws - the parsed claims JWSnull if no return value is necessary.Copyright © 2014–2020 jsonwebtoken.io. All rights reserved.