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.jwk;
18
19 import org.forgerock.json.JsonException;
20
21 /**
22 * Represents the Possible KeyUse values.
23 */
24 public enum KeyUse {
25 /**
26 * Use Key as a signature key.
27 */
28 SIG,
29
30 /**
31 * Use Key as a encryption key.
32 */
33 ENC;
34
35 /**
36 * Construct a KeyUse.
37 */
38 private KeyUse() {
39
40 }
41
42 /**
43 * Get the Value of the KeyUse.
44 * @return the KeyUse value.
45 */
46 public String value() {
47 return toString();
48 }
49
50 /**
51 * Get the KeyUse.
52 * @param keyUse the string representing the KeyUse to get
53 * @return a KeyUse, or null if keyUse is null or empty
54 */
55 public static KeyUse getKeyUse(String keyUse) {
56 if (keyUse == null || keyUse.isEmpty()) {
57 return null;
58 }
59 try {
60 return KeyUse.valueOf(keyUse.toUpperCase());
61 } catch (IllegalArgumentException e) {
62 throw new JsonException("Invalid key use");
63 }
64 }
65
66 /**
67 * Prints the KeyUse value.
68 * @return the KeyUse in lowercase
69 */
70 @Override
71 public String toString() {
72 return super.toString().toLowerCase();
73 }
74 }