Package com.nimbusds.jose.jwk

Class KeyUse

  • All Implemented Interfaces:
    java.io.Serializable
    public final class KeyUse
extends java.lang.Object
implements java.io.Serializable
    Enumeration of public key uses. Represents the use parameter in a JSON Web Key (JWK).

    Public JWK use values:

    Version:
    2019-10-03
    Author:
    Vladimir Dzhuvinov
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      KeyUse​(java.lang.String identifier)
      Creates a new public key use with the specified identifier.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      static KeyUse from​(java.security.cert.X509Certificate cert)
      Infers the use of the public key in the specified X.509 certificate.
      java.lang.String getValue()  
      int hashCode()  
      java.lang.String identifier()
      Returns the identifier of this public key use.
      static KeyUse parse​(java.lang.String s)
      Parses a public key use from the specified JWK use parameter value.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • SIGNATURE

        public static final KeyUse SIGNATURE
        Signature.

      • ENCRYPTION

        public static final KeyUse ENCRYPTION
        Encryption.

    • Constructor Detail

      • KeyUse

        public KeyUse​(java.lang.String identifier)
        Creates a new public key use with the specified identifier.
        Parameters:
        identifier - The public key use identifier. Must not be null.

    • Method Detail

      • identifier

        public java.lang.String identifier()
        Returns the identifier of this public key use.
        Returns:
        The identifier.

      • getValue

        public java.lang.String getValue()
        See Also:
        identifier()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        identifier()

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • parse

        public static KeyUse parse​(java.lang.String s)
                    throws java.text.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:
        java.text.ParseException - If the string couldn't be parsed to a valid public key use.

      • from

        public static KeyUse from​(java.security.cert.X509Certificate cert)
        Infers the use of the public key in 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 inferred public key use, null if the use of the public key is not specified by the X.509 certificate or the use maps to both SIGNATURE and ENCRYPTION.