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.jws;
18  
19  import java.util.Map;
20  
21  /**
22   * An implementation for the JWS Header parameters.
23   *
24   * @since 2.0.0
25   */
26  public class JwsHeader extends JwtSecureHeader {
27  
28      /**
29       * Constructs a new, empty JwsHeader.
30       */
31      public JwsHeader() {
32      }
33  
34      /**
35       * Constructs a new JwsHeader, with its parameters set to the contents of the given Map.
36       *
37       * @param headerParameters A Map containing the parameters to be set in the header.
38       */
39      public JwsHeader(Map<String, Object> headerParameters) {
40          super(headerParameters);
41      }
42  
43      /**
44       * Gets the Algorithm set in the JWT header.
45       * <p>
46       * If there is no algorithm set in the JWT header, then the JwsAlgorithm NONE will be returned.
47       *
48       * @return {@inheritDoc}
49       */
50      @Override
51      public JwsAlgorithm getAlgorithm() {
52          String algorithm = getAlgorithmString();
53          if (algorithm == null) {
54              return JwsAlgorithm.NONE;
55          } else {
56              return JwsAlgorithm.valueOf(algorithm);
57          }
58      }
59  }