Package com.unboundid.ldap.sdk

Enum SASLQualityOfProtection

java.lang.Object
java.lang.Enum<SASLQualityOfProtection>
com.unboundid.ldap.sdk.SASLQualityOfProtection
All Implemented Interfaces:
Serializable, Comparable<SASLQualityOfProtection>, java.lang.constant.Constable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum SASLQualityOfProtection extends Enum<SASLQualityOfProtection>
This enum defines the set of supported SASL quality of protection values.

  • Enum Constant Details

    • AUTH

      public static final SASLQualityOfProtection AUTH
      The quality of protection value that indicates that only authentication is to be performed, with no integrity or confidentiality protection for subsequent communication.

    • AUTH_INT

      public static final SASLQualityOfProtection AUTH_INT
      The quality of protection value that indicates that integrity protection will be provided for subsequent communication after authentication has completed. While integrity protection does not ensure that third-party observers cannot decipher communication between the client and server, it does ensure that the communication cannot be altered in an undetectable manner.

    • AUTH_CONF

      public static final SASLQualityOfProtection AUTH_CONF
      The quality of protection value that indicates that confidentiality protection will be provided for subsequent communication after authentication has completed. This ensures that third-party observers will not be able to decipher communication between the client and server (i.e., that the communication will be encrypted).

  • Method Details

    • values

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

    • forName

      @Nullable public static SASLQualityOfProtection forName(@NotNull String name)
      Retrieves the SASL quality of protection value with the given name.
      Parameters:
      name - The name of the SASL quality of protection value to retrieve. It must not be null.
      Returns:
      The requested SASL quality of protection value, or null if there is no value with the provided name.

    • decodeQoPList

      @NotNull public static List<SASLQualityOfProtection> decodeQoPList(@Nullable String s) throws LDAPException
      Decodes the provided string as a comma-delimited list of SASL quality of protection values.
      Parameters:
      s - The string to be decoded.
      Returns:
      The decoded list of SASL quality of protection values. It will not be null but may be empty if the provided string was null or empty.
      Throws:
      LDAPException - If the provided string cannot be decoded as a valid list of SASL quality of protection values.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this SASL quality of protection.
      Overrides:
      toString in class Enum<SASLQualityOfProtection>
      Returns:
      A string representation of this SASL quality of protection.

    • toString

      @NotNull public static String toString(@NotNull List<SASLQualityOfProtection> qopValues)
      Retrieves a string representation of the provided list of quality of protection values, as may be provided to a Java SaslClient.
      Parameters:
      qopValues - The list of values for which to create the string representation.
      Returns:
      A string representation of the provided list of quality of protection values, as may be provided to a Java SaslClient.