Fixed docs

mgonto · mgonto · commit e81ab98be5a7 · 2014-12-22T19:12:31.000-03:00
diff --git a/src/main/java/com/auth0/jwt/JWTSigner.java b/src/main/java/com/auth0/jwt/JWTSigner.java
@@ -27,7 +27,7 @@
  */
 public class JWTSigner {
     private final String secret;
-    
+
     public JWTSigner(String secret) {
         this.secret = secret;
     }
@@ -36,7 +36,7 @@ public JWTSigner(String secret) {
      * Generate a JSON Web Token.
      *  using the default algorithm HMAC SHA-256 ("HS256")
      * and no claims automatically set.
-     * 
+     *
      * @param claims A map of the JWT claims that form the payload. Registered claims
      *               must be of appropriate Java datatype as following:
      *               <ul>
@@ -47,9 +47,8 @@ public JWTSigner(String secret) {
      *               All claims with a null value are left out the JWT.
      *               Any claims set automatically as specified in
      *               the "options" parameter override claims in this map.
-     *               
-     * @param secret Key to use in signing. Used as-is without Base64 encoding.
-     * 
+     *
+     *
      * @param options Allow choosing the signing algorithm, and automatic setting of some registered claims.
      */
     public String sign(Map<String, Object> claims, Options options) {
@@ -72,15 +71,11 @@ public String sign(Map<String, Object> claims, Options options) {
     /**
      * Generate a JSON Web Token using the default algorithm HMAC SHA-256 ("HS256")
      * and no claims automatically set.
-     *
-     * @param secret Key to use in signing. Used as-is without Base64 encoding.
-     * 
-     * For details, see the two parameter variant of this method.
      */
     public String sign(Map<String, Object> claims) {
         return sign(claims, null);
     }
-    
+
     /**
      * Generate the header part of a JSON web token.
      */
@@ -99,7 +94,7 @@ private String encodedHeader(Algorithm algorithm) throws UnsupportedEncodingExce
 
     /**
      * Generate the JSON web token payload string from the claims.
-     * @param options 
+     * @param options
      */
     private String encodedPayload(Map<String, Object> _claims, Options options) throws Exception {
         Map<String, Object> claims = new HashMap<String, Object>(_claims);
@@ -110,14 +105,14 @@ private String encodedPayload(Map<String, Object> _claims, Options options) thro
         enforceIntDate(claims, "nbf");
         enforceIntDate(claims, "iat");
         enforceString(claims, "jti");
-        
+
         if (options != null)
             processPayloadOptions(claims, options);
 
         String payload = new ObjectMapper().writeValueAsString(claims);
         return base64UrlEncode(payload.getBytes("UTF-8"));
     }
-    
+
     private void processPayloadOptions(Map<String, Object> claims, Options options) {
         long now = System.currentTimeMillis() / 1000l;
         if (options.expirySeconds != null)
@@ -202,7 +197,7 @@ private String checkStringOrURI(Object value) {
         }
         return null;
     }
-    
+
     /**
      * Sign the header and payload
      */
@@ -269,7 +264,7 @@ public static class Options {
         private Integer notValidBeforeLeeway;
         private boolean issuedAt;
         private boolean jwtId;
-        
+
         public Algorithm getAlgorithm() {
             return algorithm;
         }
@@ -280,8 +275,8 @@ public Options setAlgorithm(Algorithm algorithm) {
             this.algorithm = algorithm;
             return this;
         }
-        
-        
+
+
         public Integer getExpirySeconds() {
             return expirySeconds;
         }
@@ -293,7 +288,7 @@ public Options setExpirySeconds(Integer expirySeconds) {
             this.expirySeconds = expirySeconds;
             return this;
         }
-        
+
         public Integer getNotValidBeforeLeeway() {
             return notValidBeforeLeeway;
         }
@@ -305,7 +300,7 @@ public Options setNotValidBeforeLeeway(Integer notValidBeforeLeeway) {
             this.notValidBeforeLeeway = notValidBeforeLeeway;
             return this;
         }
-        
+
         public boolean isIssuedAt() {
             return issuedAt;
         }
@@ -317,7 +312,7 @@ public Options setIssuedAt(boolean issuedAt) {
             this.issuedAt = issuedAt;
             return this;
         }
-        
+
         public boolean isJwtId() {
             return jwtId;
         }
diff --git a/src/main/java/com/auth0/jwt/JWTVerifier.java b/src/main/java/com/auth0/jwt/JWTVerifier.java
@@ -21,7 +21,6 @@
 
 /**
  * JWT Java Implementation
- * <p/>
  * Adapted from https://bitbucket.org/lluisfaja/javajwt/wiki/Home
  * See <a href="https://bitbucket.org/lluisfaja/javajwt/src/3941d23e8e70f681d8a9a2584760e58e79e498f1/JavaJWT/src/com/unblau/javajwt/JWTVerifier.java">JWTVerifier.java</a>
  */
@@ -35,7 +34,7 @@ public class JWTVerifier {
     private final ObjectMapper mapper;
 
     private Map<String, String> algorithms;
-    
+
     public JWTVerifier(String secret, String audience, String issuer) {
         this(secret.getBytes(Charset.forName("UTF-8")), audience, issuer);
     }
@@ -47,12 +46,12 @@ public JWTVerifier(String secret, String audience) {
     public JWTVerifier(String secret) {
         this(secret, null, null);
     }
-    
+
     public JWTVerifier(byte[] secret, String audience, String issuer) {
         if (secret == null || secret.length == 0) {
             throw new IllegalArgumentException("Secret cannot be null or empty");
         }
-        
+
     	mapper = new ObjectMapper();
 
         algorithms = new HashMap<String, String>();
@@ -177,4 +176,4 @@ JsonNode decodeAndParse(String b64String) throws IOException {
         JsonNode jwtHeader = mapper.readValue(jsonString, JsonNode.class);
         return jwtHeader;
     }
-}
+}
