View Javadoc
1   /*
2    * The contents of this file are subject to the terms of the Common Development and
3    * Distribution License (the License). You may not use this file except in compliance with the
4    * License.
5    *
6    * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7    * specific language governing permission and limitations under the License.
8    *
9    * When distributing Covered Software, include this CDDL Header Notice in each file and include
10   * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11   * Header, with the fields enclosed by brackets [] replaced by your own identifying
12   * information: "Portions copyright [year] [name of copyright owner]".
13   *
14   * Copyright 2013-2015 ForgeRock AS.
15   */
16  
17  package org.forgerock.json.jose.jwe;
18  
19  /**
20   * An Enum of the possible compression algorithms that can be applied to the JWE payload plaintext.
21   * <p>
22   * @see <a href="http://tools.ietf.org/html/draft-ietf-jose-json-web-encryption-11#section-4.1.4">
23   *     JWE Compression Algorithm</a>
24   *
25   * @since 2.0.0
26   */
27  public enum CompressionAlgorithm {
28  
29      /** When no compression is applied. */
30      NONE,
31      /**
32       * A lossless compressed data format that compresses data using a combination of the LZ77 algorithm and Huffman
33       * coding.
34       */
35      DEF;
36  
37      /**
38       * Parses the given algorithm string to find the matching CompressionAlgorithm enum constant.
39       *
40       * @param algorithm The compression algorithm.
41       * @return The CompressionAlgorithm enum.
42       */
43      public static CompressionAlgorithm parseAlgorithm(String algorithm) {
44          try {
45              return CompressionAlgorithm.valueOf(algorithm.toUpperCase());
46          } catch (IllegalArgumentException e) {
47              return NONE;
48          }
49      }
50  
51  }