Enum Class KeyAgreement

java.lang.Object
java.lang.Enum<KeyAgreement>
org.wildfly.security.ssl.KeyAgreement
All Implemented Interfaces:
Serializable, Comparable<KeyAgreement>, Constable

public enum KeyAgreement extends Enum<KeyAgreement>
The key agreement type for SSL/TLS cipher suite selection.
Author:
David M. Lloyd
  • 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
    Diffie-Hellman key agreement using DSS-signed keys.
    Ephemeral Diffie-Hellman key agreement.
    Ephemeral Diffie-Hellman pre-shared key ("PSK") key agreement.
    Diffie-Hellman key agreement using RSA-signed keys.
    Elliptic-curve Diffie-Hellman ("ECDH") key agreement using ECDH-signed keys.
    Ephemeral elliptic-curve Diffie-Hellman key agreement.
    RSA pre-shared key ("PSK") key agreement.
    Elliptic-curve Diffie-Hellman ("ECDH") key agreement using RSA-signed keys.
    Fortezza key agreement.
    VKA 34.10 key agreement as per RFC 4357.
    Kerberos V5 key agreement.
    Pre-shared key ("PSK") key agreement.
    RSA key agreement.
    RSA pre-shared key ("PSK") key agreement.
    Secure remote password ("SRP") key agreement as per RFC 5054.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    in(KeyAgreement... values)
    Determine whether this instance is equal to one of the given instances.
    boolean
    in(KeyAgreement value1, KeyAgreement value2)
    Determine whether this instance is equal to one of the given instances.
    boolean
    in(KeyAgreement value1, KeyAgreement value2, KeyAgreement value3)
    Determine whether this instance is equal to one of the given instances.
    static boolean
    isFull(EnumSet<KeyAgreement> keyAgreements)
    Determine whether the given set is "full" (meaning it contains all possible values).
    Returns the enum constant of this class with the specified name.
    static KeyAgreement[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • ECDHE

      public static final KeyAgreement ECDHE
      Ephemeral elliptic-curve Diffie-Hellman key agreement.
    • RSA

      public static final KeyAgreement RSA
      RSA key agreement.
    • DHr

      public static final KeyAgreement DHr
      Diffie-Hellman key agreement using RSA-signed keys.
    • DHd

      public static final KeyAgreement DHd
      Diffie-Hellman key agreement using DSS-signed keys.
    • DHE

      public static final KeyAgreement DHE
      Ephemeral Diffie-Hellman key agreement.
    • PSK

      public static final KeyAgreement PSK
      Pre-shared key ("PSK") key agreement.
    • FZA

      public static final KeyAgreement FZA
      Fortezza key agreement.
    • KRB5

      public static final KeyAgreement KRB5
      Kerberos V5 key agreement.
    • ECDHr

      public static final KeyAgreement ECDHr
      Elliptic-curve Diffie-Hellman ("ECDH") key agreement using RSA-signed keys.
    • ECDHe

      public static final KeyAgreement ECDHe
      Elliptic-curve Diffie-Hellman ("ECDH") key agreement using ECDH-signed keys.
    • GOST

      public static final KeyAgreement GOST
      VKA 34.10 key agreement as per RFC 4357.
    • SRP

      public static final KeyAgreement SRP
      Secure remote password ("SRP") key agreement as per RFC 5054.
    • RSAPSK

      public static final KeyAgreement RSAPSK
      RSA pre-shared key ("PSK") key agreement.
    • DHEPSK

      public static final KeyAgreement DHEPSK
      Ephemeral Diffie-Hellman pre-shared key ("PSK") key agreement.
    • ECDHEPSK

      public static final KeyAgreement ECDHEPSK
      RSA pre-shared key ("PSK") key agreement.
  • Method Details

    • values

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

      public static KeyAgreement valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • isFull

      public static boolean isFull(EnumSet<KeyAgreement> keyAgreements)
      Determine whether the given set is "full" (meaning it contains all possible values).
      Parameters:
      keyAgreements - the set
      Returns:
      true if the set is full, false otherwise
    • in

      public boolean in(KeyAgreement value1, KeyAgreement value2)
      Determine whether this instance is equal to one of the given instances.
      Parameters:
      value1 - the first instance
      value2 - the second instance
      Returns:
      true if one of the instances matches this one, false otherwise
    • in

      public boolean in(KeyAgreement value1, KeyAgreement value2, KeyAgreement value3)
      Determine whether this instance is equal to one of the given instances.
      Parameters:
      value1 - the first instance
      value2 - the second instance
      value3 - the third instance
      Returns:
      true if one of the instances matches this one, false otherwise
    • in

      public boolean in(KeyAgreement... values)
      Determine whether this instance is equal to one of the given instances.
      Parameters:
      values - the values to match against
      Returns:
      true if one of the instances matches this one, false otherwise