Package io.jans.as.model.jwk

Enum Use

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Use>
    public enum Use
extends java.lang.Enum<Use>
    Version:
    September 30, 2021
    Author:
    Javier Rojas Blum

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ENCRYPTION
      Use this constant when the key is being used for encryption.
      SIGNATURE
      Use this constant when the key is being used for signature.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Use fromString​(java.lang.String param)
      Returns the corresponding Use for a parameter use of the JWK endpoint.
      java.lang.String getParamName()  
      java.lang.String toString()
      Returns a string representation of the object.
      static Use valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Use[] 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 Use SIGNATURE
        Use this constant when the key is being used for signature.

      • ENCRYPTION

        public static final Use ENCRYPTION
        Use this constant when the key is being used for encryption.

    • Method Detail

      • values

        public static Use[] 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 (Use c : Use.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Use valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getParamName

        public java.lang.String getParamName()

      • fromString

        public static Use fromString​(java.lang.String param)
        Returns the corresponding Use for a parameter use of the JWK endpoint.
        Parameters:
        param - The use parameter.
        Returns:
        The corresponding use if found, otherwise null.

      • toString

        public java.lang.String toString()
        Returns a string representation of the object. In this case the parameter name.
        Overrides:
        toString in class java.lang.Enum<Use>
        Returns:
        The string representation of the object.