Package com.unboundid.util

Class SASLOption

java.lang.Object
com.unboundid.util.SASLOption
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SASLOption extends Object implements Serializable
This class provides a data structure that holds information about an option that can be used in the course of SASL authentication.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    SASLOption(String name, String description, boolean isRequired, boolean isMultiValued)
    Creates a new SASL option with the provided information.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Retrieves a description for this SASL option.
    String
    getName()
    Retrieves the name for this SASL option.
    boolean
    isMultiValued()
    Indicates whether this SASL option may be provided multiple times when trying to bind with the associated mechanism.
    boolean
    isRequired()
    Indicates whether this SASL option must be provided when attempting to bind with the associated mechanism.
    String
    toString()
    Retrieves a string representation for this SASL option.
    void
    toString(StringBuilder buffer)
    Appends a string representation of this SASL option to the provided buffer.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SASLOption

      public SASLOption(@NotNull String name, @NotNull String description, boolean isRequired, boolean isMultiValued)
      Creates a new SASL option with the provided information.
      Parameters:
      name - The name for this SASL option.
      description - A description for this SASL option.
      isRequired - Indicates whether this option is required for use in conjunction with the associated SASL mechanism.
      isMultiValued - Indicates whether this option is allowed to be specified multiple times for a single bind request.

  • Method Details

    • getName

      @NotNull public String getName()
      Retrieves the name for this SASL option.
      Returns:
      The name for this SASL option.

    • getDescription

      @NotNull public String getDescription()
      Retrieves a description for this SASL option.
      Returns:
      A description for this SASL option.

    • isRequired

      public boolean isRequired()
      Indicates whether this SASL option must be provided when attempting to bind with the associated mechanism.
      Returns:
      true if this SASL option must be specified when trying to bind with the associated mechanism, or false if not.

    • isMultiValued

      public boolean isMultiValued()
      Indicates whether this SASL option may be provided multiple times when trying to bind with the associated mechanism.
      Returns:
      true if this SASL option may be provided multiple times when trying to bind with the associated mechanism, or false if not.

    • toString

      @NotNull public String toString()
      Retrieves a string representation for this SASL option.
      Overrides:
      toString in class Object
      Returns:
      A string representation for this SASL option.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this SASL option to the provided buffer.
      Parameters:
      buffer - The buffer to which the information should be appended.