com.nimbusds.jose.jwk

Enum KeyUse

java.lang.Object

java.lang.Enum<KeyUse>

com.nimbusds.jose.jwk.KeyUse

All Implemented Interfaces:

Serializable, Comparable<KeyUse>

public enum KeyUse
extends Enum<KeyUse>

Enumeration of public key uses. Represents the use parameter in a JSON Web Key (JWK).

Public JWK use values:

• sig
• enc

Version:

2016-12-06

Author:

Vladimir Dzhuvinov

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENCRYPTION Encryption.
SIGNATURE Signature.

Method Summary

Modifier and Type	Method and Description
static KeyUse	from(X509Certificate cert) Infers the public key use of the specified X.509 certificate.
String	identifier() Returns the identifier of this public key use.
static KeyUse	parse(String s) Parses a public key use from the specified JWK use parameter value.
String	toString()
static KeyUse	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyUse[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SIGNATURE

public static final KeyUse SIGNATURE

Signature.

ENCRYPTION

public static final KeyUse ENCRYPTION

Encryption.

Method Detail

values

public static KeyUse[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KeyUse c : KeyUse.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KeyUse valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

identifier

public String identifier()

Returns the identifier of this public key use.

Returns:

The identifier.

toString

public String toString()

Overrides:

toString in class Enum<KeyUse>

See Also:

identifier()

parse

public static KeyUse parse(String s)
                    throws ParseException

Parses a public key use from the specified JWK use parameter value.

Parameters:

s - The string to parse. May be null.

Returns:

The public key use, null if none.

Throws:

ParseException - If the string couldn't be parsed to a valid public key use.

from

public static KeyUse from(X509Certificate cert)

Infers the public key use of the specified X.509 certificate. Note that there is no standard algorithm for mapping PKIX key usage to JWK use. See RFC 2459, section 4.2.1.3, as well as the underlying code for the chosen algorithm to infer JWK use.

Parameters:

cert - The X.509 certificate. Must not be null.

Returns:

The public key use, null if the key use couldn't be reliably determined.