Class SASLMechanismInfo

    • Constructor Summary

      Constructors 
      Constructor Description
      SASLMechanismInfo​(java.lang.String name, java.lang.String description, boolean acceptsPassword, boolean requiresPassword, SASLOption... options)
      Creates a new SASL mechanism info object with the provided information.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean acceptsPassword()
      Indicates whether the SASL mechanism accepts a password for authentication processing.
      java.lang.String getDescription()
      Retrieves a description for the SASL mechanism.
      java.lang.String getName()
      Retrieves the name of the SASL mechanism.
      java.util.List<SASLOption> getOptions()
      Retrieves a list of the options that may be used with the SASL mechanism.
      boolean requiresPassword()
      Indicates whether the SASL mechanism requires a password for authentication processing.
      java.lang.String toString()
      Retrieves a string representation of this SASL mechanism info object.
      void toString​(java.lang.StringBuilder buffer)
      Appends a string representation of this SASL mechanism info object to the provided buffer.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • SASLMechanismInfo

        public SASLMechanismInfo​(@NotNull
                                 java.lang.String name,
                                 @NotNull
                                 java.lang.String description,
                                 boolean acceptsPassword,
                                 boolean requiresPassword,
                                 @Nullable
                                 SASLOption... options)
        Creates a new SASL mechanism info object with the provided information.
        Parameters:
        name - The name for the SASL mechanism.
        description - A description for the SASL mechanism.
        acceptsPassword - Indicates whether the SASL mechanism allows a password to be provided.
        requiresPassword - Indicates whether the SASL mechanism requires a password to be provided.
        options - The set of options that are associated with the SASL mechanism.
    • Method Detail

      • getName

        @NotNull
        public java.lang.String getName()
        Retrieves the name of the SASL mechanism.
        Returns:
        The name of the SASL mechanism.
      • getDescription

        @NotNull
        public java.lang.String getDescription()
        Retrieves a description for the SASL mechanism.
        Returns:
        A description for the SASL mechanism.
      • acceptsPassword

        public boolean acceptsPassword()
        Indicates whether the SASL mechanism accepts a password for authentication processing.
        Returns:
        true if the SASL mechanism accepts a password for authentication processing, or false if not.
      • requiresPassword

        public boolean requiresPassword()
        Indicates whether the SASL mechanism requires a password for authentication processing.
        Returns:
        true if the SASL mechanism requires a password for authentication processing, or false if not.
      • getOptions

        @NotNull
        public java.util.List<SASLOptiongetOptions()
        Retrieves a list of the options that may be used with the SASL mechanism.
        Returns:
        A list of the options that may be used with the SASL mechanism, or an empty list if there are no supported SASL options for the associated mechanism.
      • toString

        @NotNull
        public java.lang.String toString()
        Retrieves a string representation of this SASL mechanism info object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this SASL mechanism info object.
      • toString

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