mirror of https://github.com/jwtk/jjwt.git
Changed version references from 0.5.2 to 0.6.0 (no 0.5.2 release yet).
This commit is contained in:
parent
a4f4da767b
commit
98970a7e19
|
@ -20,7 +20,7 @@ package io.jsonwebtoken;
|
|||
*
|
||||
* @see io.jsonwebtoken.impl.compression.DeflateCompressionCodec
|
||||
* @see io.jsonwebtoken.impl.compression.GzipCompressionCodec
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
public interface CompressionCodec {
|
||||
|
||||
|
|
|
@ -29,7 +29,7 @@ package io.jsonwebtoken;
|
|||
* {@link io.jsonwebtoken.JwtBuilder#compressWith(CompressionCodec) building} and
|
||||
* {@link io.jsonwebtoken.JwtParser#setCompressionCodecResolver(CompressionCodecResolver) parsing} JWTs.</p>
|
||||
*
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
public interface CompressionCodecResolver {
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@ package io.jsonwebtoken;
|
|||
/**
|
||||
* Exception indicating that either compressing or decompressing an JWT body failed.
|
||||
*
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
public class CompressionException extends JwtException {
|
||||
|
||||
|
|
|
@ -107,7 +107,7 @@ public interface Header<T extends Header<T>> extends Map<String,Object> {
|
|||
* Returns the JWT <code>calg</code> (Compression Algorithm) header value or {@code null} if not present.
|
||||
*
|
||||
* @return the {@code calg} header parameter value or {@code null} if not present.
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
String getCompressionAlgorithm();
|
||||
|
||||
|
@ -120,7 +120,7 @@ public interface Header<T extends Header<T>> extends Map<String,Object> {
|
|||
* be able to deserialize a compressed JTW body correctly. </p>
|
||||
*
|
||||
* @param calg the JWT compression algorithm {@code calg} value or {@code null} to remove the property from the JSON map.
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
T setCompressionAlgorithm(String calg);
|
||||
|
||||
|
|
|
@ -357,15 +357,15 @@ public interface JwtBuilder extends ClaimsMutator<JwtBuilder> {
|
|||
* certain length. Using compression can help ensure the compact JWT fits within that length. However, NOTE:</p>
|
||||
*
|
||||
* <p><b>WARNING:</b> Compression is not defined by the JWT Specification, and it is not expected that other libraries
|
||||
* (including JJWT versions < 0.5.2) are able to consume a compressed JWT body correctly. Only use this method
|
||||
* if you are sure that you will consume the JWT with JJWT >= 0.5.2 or another library that you know implements
|
||||
* (including JJWT versions < 0.6.0) are able to consume a compressed JWT body correctly. Only use this method
|
||||
* if you are sure that you will consume the JWT with JJWT >= 0.6.0 or another library that you know implements
|
||||
* the same behavior.</p>
|
||||
*
|
||||
* @see io.jsonwebtoken.impl.compression.CompressionCodecs
|
||||
*
|
||||
* @param codec implementation of the {@link CompressionCodec} to be used.
|
||||
* @return the builder for method chaining.
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
JwtBuilder compressWith(CompressionCodec codec);
|
||||
|
||||
|
|
|
@ -209,8 +209,8 @@ public interface JwtParser {
|
|||
* Sets the {@link CompressionCodecResolver} used to acquire the {@link CompressionCodec} that should be used to
|
||||
* decompress the JWT body. If the parsed JWT is not compressed, this resolver is not used.
|
||||
* <p><b>NOTE:</b> Compression is not defined by the JWT Specification, and it is not expected that other libraries
|
||||
* (including JJWT versions < 0.5.2) are able to consume a compressed JWT body correctly. This method is only
|
||||
* useful if the compact JWT was compressed with JJWT >= 0.5.2 or another library that you know implements
|
||||
* (including JJWT versions < 0.6.0) are able to consume a compressed JWT body correctly. This method is only
|
||||
* useful if the compact JWT was compressed with JJWT >= 0.6.0 or another library that you know implements
|
||||
* the same behavior.</p>
|
||||
* <h5>Default Support</h5>
|
||||
* <p>JJWT's default {@link JwtParser} implementation supports both the
|
||||
|
@ -223,7 +223,7 @@ public interface JwtParser {
|
|||
*
|
||||
* @param compressionCodecResolver the compression codec resolver used to decompress the JWT body.
|
||||
* @return the parser for method chaining.
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
JwtParser setCompressionCodecResolver(CompressionCodecResolver compressionCodecResolver);
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ import java.io.IOException;
|
|||
/**
|
||||
* Abstract class that asserts arguments and wraps IOException with CompressionException.
|
||||
*
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
public abstract class AbstractCompressionCodec implements CompressionCodec {
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@ import io.jsonwebtoken.CompressionCodec;
|
|||
* @see #DEFLATE
|
||||
* @see #GZIP
|
||||
*
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
public final class CompressionCodecs {
|
||||
|
||||
|
|
|
@ -41,7 +41,7 @@ import io.jsonwebtoken.lang.Strings;
|
|||
*
|
||||
* @see DeflateCompressionCodec
|
||||
* @see GzipCompressionCodec
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
public class DefaultCompressionCodecResolver implements CompressionCodecResolver {
|
||||
|
||||
|
|
|
@ -26,7 +26,7 @@ import java.util.zip.InflaterOutputStream;
|
|||
/**
|
||||
* Codec implementing the <a href="https://en.wikipedia.org/wiki/DEFLATE">deflate compression algorithm</a>.
|
||||
*
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
public class DeflateCompressionCodec extends AbstractCompressionCodec {
|
||||
|
||||
|
|
|
@ -27,7 +27,7 @@ import java.util.zip.GZIPOutputStream;
|
|||
/**
|
||||
* Codec implementing the <a href="https://en.wikipedia.org/wiki/Gzip">gzip compression algorithm</a>.
|
||||
*
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
public class GzipCompressionCodec extends AbstractCompressionCodec implements CompressionCodec {
|
||||
|
||||
|
|
|
@ -20,7 +20,7 @@ import io.jsonwebtoken.CompressionException
|
|||
import org.junit.Test
|
||||
|
||||
/**
|
||||
* @since 0.5.2
|
||||
* @since 0.6.0
|
||||
*/
|
||||
class AbstractCompressionCodecTest {
|
||||
static class ExceptionThrowingCodec extends AbstractCompressionCodec {
|
||||
|
|
Loading…
Reference in New Issue