add specific exceptions to JWTVerifier#verify javadoc

lbalmaceda · lbalmaceda · commit b2eac8624c12 · 2017-04-20T16:32:21.000-03:00
diff --git a/lib/src/main/java/com/auth0/jwt/JWTVerifier.java b/lib/src/main/java/com/auth0/jwt/JWTVerifier.java
@@ -343,7 +343,10 @@ private void requireClaim(String name, Object value) {
      *
      * @param token to verify.
      * @return a verified and decoded JWT.
-     * @throws JWTVerificationException if any of the required contents inside the JWT is invalid.
+     * @throws AlgorithmMismatchException     if the algorithm stated in the token's header it's not equal to the one defined in the {@link JWTVerifier}.
+     * @throws SignatureVerificationException if the signature is invalid.
+     * @throws TokenExpiredException          if the token has expired.
+     * @throws InvalidClaimException          if a claim contained a different value than the expected one.
      */
     public DecodedJWT verify(String token) throws JWTVerificationException {
         DecodedJWT jwt = JWT.decode(token);
@@ -359,7 +362,7 @@ private void verifyAlgorithm(DecodedJWT jwt, Algorithm expectedAlgorithm) throws
         }
     }
 
-    private void verifyClaims(DecodedJWT jwt, Map<String, Object> claims) {
+    private void verifyClaims(DecodedJWT jwt, Map<String, Object> claims) throws TokenExpiredException, InvalidClaimException {
         for (Map.Entry<String, Object> entry : claims.entrySet()) {
             switch (entry.getKey()) {
                 case PublicClaims.AUDIENCE:

Original file line number	Diff line number	Diff line change
`@@ -343,7 +343,10 @@ private void requireClaim(String name, Object value) {`
`343`	`343`	`*`
`344`	`344`	`* @param token to verify.`
`345`	`345`	`* @return a verified and decoded JWT.`
`346`		`- * @throws JWTVerificationException if any of the required contents inside the JWT is invalid.`
	`346`	`+ * @throws AlgorithmMismatchException if the algorithm stated in the token's header it's not equal to the one defined in the {@link JWTVerifier}.`
	`347`	`+ * @throws SignatureVerificationException if the signature is invalid.`
	`348`	`+ * @throws TokenExpiredException if the token has expired.`
	`349`	`+ * @throws InvalidClaimException if a claim contained a different value than the expected one.`
`347`	`350`	`*/`
`348`	`351`	`public DecodedJWT verify(String token) throws JWTVerificationException {`
`349`	`352`	`DecodedJWT jwt = JWT.decode(token);`
`@@ -359,7 +362,7 @@ private void verifyAlgorithm(DecodedJWT jwt, Algorithm expectedAlgorithm) throws`
`359`	`362`	`}`
`360`	`363`	`}`
`361`	`364`
`362`		`- private void verifyClaims(DecodedJWT jwt, Map<String, Object> claims) {`
	`365`	`+ private void verifyClaims(DecodedJWT jwt, Map<String, Object> claims) throws TokenExpiredException, InvalidClaimException {`
`363`	`366`	`for (Map.Entry<String, Object> entry : claims.entrySet()) {`
`364`	`367`	`switch (entry.getKey()) {`
`365`	`368`	`case PublicClaims.AUDIENCE:`