io.jsonwebtoken.CompressionCodec Maven / Gradle / Ivy

/*
 * Copyright (C) 2015 jsonwebtoken.io
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.jsonwebtoken;

import io.jsonwebtoken.io.CompressionAlgorithm;

/**
 * Compresses and decompresses byte arrays according to a compression algorithm.
 *
 * "zip" identifier
 *
 * {@code CompressionCodec} extends {@code Identifiable}; the value returned from
 * {@link Identifiable#getId() getId()} will be used as the JWT
 * zip header value.
 *
 * @see Jwts.ZIP#DEF
 * @see Jwts.ZIP#GZIP
 * @since 0.6.0
 * @deprecated since 0.12.0 in favor of {@link io.jsonwebtoken.io.CompressionAlgorithm} to equal the RFC name for this concept.
 */
@Deprecated
public interface CompressionCodec extends CompressionAlgorithm {

    /**
     * The algorithm name to use as the JWT
     * zip header value.
     *
     * @return the algorithm name to use as the JWT
     * zip header value.
     * @deprecated since 0.12.0 in favor of {@link #getId()} to ensure congruence with
     * all other identifiable algorithms.
     */
    @SuppressWarnings("DeprecatedIsStillUsed")
    @Deprecated
    String getAlgorithmName();

    /**
     * Compresses the specified byte array, returning the compressed byte array result.
     *
     * @param content bytes to compress
     * @return compressed bytes
     * @throws CompressionException if the specified byte array cannot be compressed.
     */
    @Deprecated
    byte[] compress(byte[] content) throws CompressionException;

    /**
     * Decompresses the specified compressed byte array, returning the decompressed byte array result.  The
     * specified byte array must already be in compressed form.
     *
     * @param compressed compressed bytes
     * @return decompressed bytes
     * @throws CompressionException if the specified byte array cannot be decompressed.
     */
    @Deprecated
    byte[] decompress(byte[] compressed) throws CompressionException;
}