001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2013-2015 ForgeRock AS.
015 */
016
017package org.forgerock.json.jose.jwe.handlers.compression;
018
019/**
020 * The interface for CompressionHandlers for all the different compression algorithms.
021 * <p>
022 * Provides methods for compressing and decompression byte arrays.
023 *
024 * @since 2.0.0
025 */
026public interface CompressionHandler {
027
028    /**
029     * Applies the compression algorithm to compress the given array of bytes.
030     *
031     * @param bytes The array of bytes to compress.
032     * @return The compressed representation of the byte array.
033     */
034    byte[] compress(byte[] bytes);
035
036    /**
037     * Applies the compression algorithm to decompress the given array of bytes.
038     *
039     * @param bytes The array of bytes to decompress.
040     * @return The decompressed representation of the byte array.
041     */
042    byte[] decompress(byte[] bytes);
043}