Class SASLOption

    • Constructor Summary

      Constructors 
      Constructor Description
      SASLOption​(java.lang.String name, java.lang.String description, boolean isRequired, boolean isMultiValued)
      Creates a new SASL option with the provided information.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Retrieves a description for this SASL option.
      java.lang.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.
      java.lang.String toString()
      Retrieves a string representation for this SASL option.
      void toString​(java.lang.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 Detail

      • SASLOption

        public SASLOption​(java.lang.String name,
                          java.lang.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 Detail

      • getName

        public java.lang.String getName()
        Retrieves the name for this SASL option.
        Returns:
        The name for this SASL option.
      • getDescription

        public java.lang.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

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

        public void toString​(java.lang.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.