Package org.apache.qpid.protonj2.client

Class SaslOptions

  • public class SaslOptions
extends java.lang.Object
    Connection options that are applied to the SASL layer.

    • Field Detail

      • DEFAULT_SASL_ENABLED

        public static final boolean DEFAULT_SASL_ENABLED
        The client default configuration value for SASL enabled state (default is true)
        See Also:
        Constant Field Values

    • Constructor Detail

      • SaslOptions

        public SaslOptions()
        Create a new SaslOptions instance configured with default configuration settings.

    • Method Detail

      • clone

        public SaslOptions clone()
        Overrides:
        clone in class java.lang.Object

      • saslEnabled

        public boolean saslEnabled()
        Returns:
        the saslLayer

      • saslEnabled

        public SaslOptions saslEnabled​(boolean saslEnabled)
        Parameters:
        saslEnabled - the saslLayer to set
        Returns:
        this options instance.

      • addAllowedMechanism

        public SaslOptions addAllowedMechanism​(java.lang.String mechanism)
        Adds a mechanism to the list of allowed SASL mechanisms this client will use when selecting from the remote peers offered set of SASL mechanisms. If no allowed mechanisms are configured then the client will select the first mechanism from the server offered mechanisms that is supported.
        Parameters:
        mechanism - The mechanism to allow.
        Returns:
        this options object for chaining.

      • allowedMechanisms

        public java.util.Set<java.lang.String> allowedMechanisms()
        Returns:
        the current list of allowed SASL Mechanisms.

      • copyInto

        public SaslOptions copyInto​(SaslOptions other)
        Copy all configuration into the given SaslOptions from this instance.
        Parameters:
        other - another SaslOptions instance that will receive the configuration from this instance.
        Returns:
        the options instance that was copied into.