Package org.forgerock.json.jose.jws

Enum JwsAlgorithm

java.lang.Object
java.lang.Enum<JwsAlgorithm>
org.forgerock.json.jose.jws.JwsAlgorithm
All Implemented Interfaces:
Serializable, Comparable<JwsAlgorithm>, Algorithm
public enum JwsAlgorithm extends Enum<JwsAlgorithm> implements Algorithm
An Enum of the possible signing algorithms that can be used to sign a JWT.

Since:
2.0.0
See Also:

  • Enum Constant Details

  • Method Details

    • values

      public static JwsAlgorithm[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

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

    • getAlgorithm

      public String getAlgorithm()
      Description copied from interface: Algorithm
      Gets the actual name of the algorithm that is understood by Java cryptographic operations.
      Specified by:
      getAlgorithm in interface Algorithm
      Returns:
      The name of the algorithm.

    • getJwaAlgorithmName

      public String getJwaAlgorithmName()
      Description copied from interface: Algorithm
      Gets the name of the algorithm as defined in the JWA standard.
      Specified by:
      getJwaAlgorithmName in interface Algorithm
      Returns:
      The name of the algorithm.

    • getMdAlgorithm

      public String getMdAlgorithm()
      Returns the Java-friendly name of the message digest algorithm implementation.
      Returns:
      the Java-friendly name of the message digest algorithm implementation.
      See Also:

    • getEllipticCurveName

      public String getEllipticCurveName()
      Return the standard name of the elliptic curve definition. Only applicable for ECDSA algorithms.
      Returns:
      the curve name or null if not applicable.

    • getAlgorithmType

      public JwsAlgorithmType getAlgorithmType()
      Gets the JwsAlgorithmType of the JwsAlgorithm.
      Returns:
      The JwsAlgorithmType.

    • getJwsAlgorithm

      @Deprecated public static JwsAlgorithm getJwsAlgorithm(String algorithm)
      Deprecated.
      Replaced by parseCryptographicAlgorithm(String)
      See parseCryptographicAlgorithm(String)}.
      Parameters:
      algorithm - The Java Cryptographic string algorithm name.
      Returns:
      The matching JwsAlgorithm.

    • parseCryptographicAlgorithm

      public static JwsAlgorithm parseCryptographicAlgorithm(String algorithm)
      Parses the given algorithm string to find the matching Java Cryptographic algorithm name.

      If the given algorithm name does not match the algorithm name of any of the constants, then an IllegalArgumentException will be thrown.

      Parameters:
      algorithm - The Java Cryptographic string algorithm name.
      Returns:
      The matching JwsAlgorithm.

    • toString

      public String toString()
      Turns the JwsAlgorithm constant into a JSON value string.
      Overrides:
      toString in class Enum<JwsAlgorithm>
      Returns: