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;
018
019/**
020 * An Enum of the possible compression algorithms that can be applied to the JWE payload plaintext.
021 * <p>
022 * @see <a href="http://tools.ietf.org/html/draft-ietf-jose-json-web-encryption-11#section-4.1.4">
023 *     JWE Compression Algorithm</a>
024 *
025 * @since 2.0.0
026 */
027public enum CompressionAlgorithm {
028
029    /** When no compression is applied. */
030    NONE,
031    /**
032     * A lossless compressed data format that compresses data using a combination of the LZ77 algorithm and Huffman
033     * coding.
034     */
035    DEF;
036
037    /**
038     * Parses the given algorithm string to find the matching CompressionAlgorithm enum constant.
039     *
040     * @param algorithm The compression algorithm.
041     * @return The CompressionAlgorithm enum.
042     */
043    public static CompressionAlgorithm parseAlgorithm(String algorithm) {
044        try {
045            return CompressionAlgorithm.valueOf(algorithm.toUpperCase());
046        } catch (IllegalArgumentException e) {
047            return NONE;
048        }
049    }
050
051}