io.smallrye.jwt

Enum KeyFormat

java.lang.Object

java.lang.Enum<KeyFormat>

io.smallrye.jwt.KeyFormat

All Implemented Interfaces:

Serializable, Comparable<KeyFormat>

public enum KeyFormat
extends Enum<KeyFormat>

Format or store type of the security key.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Key can be in any of the supported formats.
JWK JWK key set or single JWK key.
JWK_BASE64URL JWK key set or single JWK key which has been Base64URL-encoded.
PEM_CERTIFICATE PEM file containing a Base64-encoded certificate.
PEM_KEY PEM file containing a Base64-encoded key.

Method Summary

Modifier and Type	Method and Description
static KeyFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyFormat[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PEM_KEY

public static final KeyFormat PEM_KEY

PEM file containing a Base64-encoded key.

PEM_CERTIFICATE

public static final KeyFormat PEM_CERTIFICATE

PEM file containing a Base64-encoded certificate.

JWK

public static final KeyFormat JWK

JWK key set or single JWK key.

JWK_BASE64URL

public static final KeyFormat JWK_BASE64URL

JWK key set or single JWK key which has been Base64URL-encoded.

ANY

public static final KeyFormat ANY

Key can be in any of the supported formats.

Method Detail

values

public static KeyFormat[] 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 (KeyFormat c : KeyFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static KeyFormat 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