Package org.forgerock.json.jose.jws

Enum JwsHeaderKey

java.lang.Object
java.lang.Enum<JwsHeaderKey>
org.forgerock.json.jose.jws.JwsHeaderKey
All Implemented Interfaces:
Serializable, Comparable<JwsHeaderKey>
public enum JwsHeaderKey extends Enum<JwsHeaderKey>
An Enum for the JWS Header parameter names.

As described in the JWS specification, the reserved JWS header parameters are listed,

  • "jku"
  • "jwk"
  • "x5u"
  • "x5t"
  • "x5c"
  • "kid"
  • "cty"
  • "crit"
Any other header parameter name is deemed as a "custom" header parameter.
Since:
2.0.0

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CRIT
    Critical header parameter.
    CTY
    Content Type header parameter.
    CUSTOM
    Generic header key for a custom header parameter.
    JKU
    JWK Set URL header parameter.
    JWK
    JSON Web Key header parameter.
    KID
    Key ID header parameter.
    X5C
    X.509 Certificate Chain header parameter.
    X5T
    X.509 Certificate Thumbprint header parameter.
    X5U
    X.509 URL header parameter.

  • Method Summary

    Modifier and Type
    Method
    Description
    static JwsHeaderKey
    getHeaderKey(String headerKey)
    Gets the JwsHeaderKey constant that matches the given String.
    String
    toString()
    Turns the JwsHeaderKey constant into a lowercase String.
    String
    value()
    Returns a lowercase String of the JwsHeaderKey constant.
    static JwsHeaderKey
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static JwsHeaderKey[]
    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