honeymoose
/
jjwt
mirror of https://github.com/jwtk/jjwt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor punctuation and sentence structure updates. Changed Json to JSON per spec.

This commit is contained in:
Micah Silverman 2017-09-01 03:18:28 -07:00
parent d2ec644f7c
commit 7c6c7df926
2 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/main/java/io/jsonwebtoken/Header.java
View File

@ -115,11 +115,11 @@ public interface Header<T extends Header<T>> extends Map<String,Object> {
*
* <h5>Compatiblity Note</h5>
*
* <p>While the JWT family of specifications only defines the <code>zip</code> header in the JWE (Json Web Encryption)
* specification, JJWT will also support compression for JWS as well if you choose to use it. However,
* be aware that <b>if you use
* compression when creating a JWS token, other libraries may not be able to parse the JWS</b>. Compression when
* creating JWE tokens however should be universally accepted for any library that supports JWE.</p>
* <p>While the JWT family of specifications only defines the <code>zip</code> header in the JWE
* (JSON Web Encryption) specification, JJWT will also support compression for JWS as well if you choose to use it.
* However, be aware that <b>if you use compression when creating a JWS token, other libraries may not be able to
* parse the JWS</b>. However, compression when creating JWE tokens should be universally accepted for any library
* that supports JWE.</p>
*
* @return the {@code zip} header parameter value or {@code null} if not present.
* @since 0.6.0
@ -133,13 +133,14 @@ public interface Header<T extends Header<T>> extends Map<String,Object> {
*
* <h5>Compatiblity Note</h5>
*
* <p>While the JWT family of specifications only defines the <code>zip</code> header in the JWE (Json Web Encryption)
* specification, JJWT will also support compression for JWS as well if you choose to use it. However,
* be aware that <b>if you use
* compression when creating a JWS token, other libraries may not be able to parse the JWS</b>. Compression when
* creating JWE tokens however should be universally accepted for any library that supports JWE.</p>
* <p>While the JWT family of specifications only defines the <code>zip</code> header in the JWE
* (JSON Web Encryption) specification, JJWT will also support compression for JWS as well if you choose to use it.
* However, be aware that <b>if you use compression when creating a JWS token, other libraries may not be able to
* parse the JWS</b>. However, Compression when creating JWE tokens should be universally accepted for any library
* that supports JWE.</p>
*
* @param zip the JWT compression algorithm {@code zip} value or {@code null} to remove the property from the JSON map.
* @param zip the JWT compression algorithm {@code zip} value or {@code null} to remove the property from the
* JSON map.
* @since 0.6.0
*/
T setCompressionAlgorithm(String zip);

4
src/main/java/io/jsonwebtoken/JwtBuilder.java
View File

@ -370,10 +370,10 @@ public interface JwtBuilder extends ClaimsMutator<JwtBuilder> {
*
* <h5>Compatibility Warning</h5>
*
* <p>The JWT family of specifications defines compression only for JWE (Json Web Encryption)
* <p>The JWT family of specifications defines compression only for JWE (JSON Web Encryption)
* tokens. Even so, JJWT will also support compression for JWS tokens as well if you choose to use it.
* However, be aware that <b>if you use compression when creating a JWS token, other libraries may not be able to
* parse that JWS token</b>. When using compression for JWS tokens, be sure that that all parties accessing the
* parse that JWS token</b>. When using compression for JWS tokens, be sure that that all parties accessing the
* JWS token support compression for JWS.</p>
*
* <p>Compression when creating JWE tokens however should be universally accepted for any