com.atlassian.jwt.reader

Interface JwtReader

public interface JwtReader

Parses and verifies Jwts attached to incoming requests.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Jwt	read(String jwt, Map<String,? extends JwtClaimVerifier> requiredClaims) Deprecated.
Jwt	readAndVerify(String jwt, Map<String,? extends JwtClaimVerifier> requiredClaims) Parses the encoded JWT message from String, verifies its signature (if there is one) and on success returns the decoded Jwt.
Jwt	readUnverified(String jwt) Parses the encoded JWT message from String and on success returns the decoded Jwt.

Method Detail

readUnverified

@Nonnull
Jwt readUnverified(@Nonnull
                            String jwt)
                     throws JwtParseException,
                            JwtVerificationException

Parses the encoded JWT message from String and on success returns the decoded Jwt. Does not attempt signature verification. (Useful if e.g. you need to know something from the JWT in order to determine the key.)

Parameters:

jwt - a JSON Web Token, (see example)

Returns:

a verified Jwt

Throws:

JwtParseException - if the JWT string was malformed

JwtVerificationException

readAndVerify

@Nonnull
Jwt readAndVerify(@Nonnull
                           String jwt,
                           @Nonnull
                           Map<String,? extends JwtClaimVerifier> requiredClaims)
                    throws JwtParseException,
                           JwtVerificationException

Parses the encoded JWT message from String, verifies its signature (if there is one) and on success returns the decoded Jwt.

Parameters:

jwt - a JSON Web Token, (see example)

requiredClaims - claims that must be present, the specified values

Returns:

a verified Jwt

Throws:

JwtParseException - if the JWT string was malformed

JwtVerificationException - if the JWT string was well-formed but failed verification

read

@Deprecated
 @Nonnull
Jwt read(@Nonnull
                               String jwt,
                               @Nonnull
                               Map<String,? extends JwtClaimVerifier> requiredClaims)
                        throws JwtParseException,
                               JwtVerificationException

Deprecated.

Parses the encoded JWT message from String, verifies its signature (if there is one) and on success returns the decoded Jwt. Deprecated because verification is not actually required in order to read the contents of a JWT. Use readAndVerify(String, java.util.Map) or readUnverified(String) instead.

Parameters:

jwt - a JSON Web Token, (see example)

requiredClaims - claims that must be present, the specified values

Returns:

a verified Jwt

Throws:

JwtParseException - if the JWT string was malformed

JwtVerificationException - if the JWT string was well-formed but failed verification