Package com.unboundid.util.ssl.cert

Enum ExtendedKeyUsageID

java.lang.Object
java.lang.Enum<ExtendedKeyUsageID>
com.unboundid.util.ssl.cert.ExtendedKeyUsageID
All Implemented Interfaces:
Serializable, Comparable<ExtendedKeyUsageID>, java.lang.constant.Constable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum ExtendedKeyUsageID extends Enum<ExtendedKeyUsageID>
This enum defines a set of OIDs that are known to be used in the ExtendedKeyUsageExtension. Note that extended key usage extensions may include OIDs that are not included in this enum, and any code that makes use of the extension should be prepared to handle other key usage IDs.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CODE_SIGNING
    The extended key usage ID that indicates that the associated certificate may be used for code signing.
    EMAIL_PROTECTION
    The extended key usage ID that indicates that the associated certificate may be used for email protection.
    OCSP_SIGNING
    The extended key usage ID that indicates that the associated certificate may be used for signing OCSP responses.
    TIME_STAMPING
    The extended key usage ID that indicates that the associated certificate may be used for time stamping.
    TLS_CLIENT_AUTHENTICATION
    The extended key usage ID that indicates that the associated certificate may be used for TLS client authentication.
    TLS_SERVER_AUTHENTICATION
    The extended key usage ID that indicates that the associated certificate may be used for TLS server authentication.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ExtendedKeyUsageID
    forName(String name)
    Retrieves the extended key usage ID with the specified name.
    static ExtendedKeyUsageID
    forOID(OID oid)
    Retrieves the extended key usage ID value with the specified OID.
    String
    getName()
    Retrieves the human-readable name for this extended key usage ID value.
    static String
    getNameOrOID(OID oid)
    Retrieves the human-readable name for the extended key usage ID value with the provided OID, or a string representation of the OID if there is no value with that OID.
    OID
    getOID()
    Retrieves the OID for this extended key usage ID value.
    static ExtendedKeyUsageID
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static ExtendedKeyUsageID[]
    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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • TLS_SERVER_AUTHENTICATION

      public static final ExtendedKeyUsageID TLS_SERVER_AUTHENTICATION
      The extended key usage ID that indicates that the associated certificate may be used for TLS server authentication.

    • TLS_CLIENT_AUTHENTICATION

      public static final ExtendedKeyUsageID TLS_CLIENT_AUTHENTICATION
      The extended key usage ID that indicates that the associated certificate may be used for TLS client authentication.

    • CODE_SIGNING

      public static final ExtendedKeyUsageID CODE_SIGNING
      The extended key usage ID that indicates that the associated certificate may be used for code signing.

    • EMAIL_PROTECTION

      public static final ExtendedKeyUsageID EMAIL_PROTECTION
      The extended key usage ID that indicates that the associated certificate may be used for email protection.

    • TIME_STAMPING

      public static final ExtendedKeyUsageID TIME_STAMPING
      The extended key usage ID that indicates that the associated certificate may be used for time stamping.

    • OCSP_SIGNING

      public static final ExtendedKeyUsageID OCSP_SIGNING
      The extended key usage ID that indicates that the associated certificate may be used for signing OCSP responses.

  • Method Details

    • values

      public static ExtendedKeyUsageID[] 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 ExtendedKeyUsageID 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

    • getOID

      @NotNull public OID getOID()
      Retrieves the OID for this extended key usage ID value.
      Returns:
      The OID for this extended key usage ID value.

    • getName

      @NotNull public String getName()
      Retrieves the human-readable name for this extended key usage ID value.
      Returns:
      The human-readable name for this extended key usage ID value.

    • forOID

      @Nullable public static ExtendedKeyUsageID forOID(@NotNull OID oid)
      Retrieves the extended key usage ID value with the specified OID.
      Parameters:
      oid - The OID of the extended key usage ID value to retrieve. It must not be null.
      Returns:
      The extended key usage ID value with the specified OID, or null if there is no value with the specified OID.

    • getNameOrOID

      @NotNull public static String getNameOrOID(@NotNull OID oid)
      Retrieves the human-readable name for the extended key usage ID value with the provided OID, or a string representation of the OID if there is no value with that OID.
      Parameters:
      oid - The OID for the extended key usage ID to retrieve.
      Returns:
      The human-readable name for the extended key usage ID value with the provided OID, or a string representation of the OID if there is no value with that OID.

    • forName

      @Nullable public static ExtendedKeyUsageID forName(@NotNull String name)
      Retrieves the extended key usage ID with the specified name.
      Parameters:
      name - The name of the extended key usage ID to retrieve. It must not be null.
      Returns:
      The requested extended key usage ID, or null if no such ID is defined.