Apache.Qpid.Proton.Client.SaslOptions Class Reference

Options that control how the SASL authentication process is performed. More...

Inheritance diagram for Apache.Qpid.Proton.Client.SaslOptions:

Public Member Functions
	SaslOptions ()
	Creates a default SASL options instance.
	SaslOptions (SaslOptions other)
	Create a new SASL options instance whose settings are copied from the instance provided.
void	AddAllowedMechanism (string mechanism)
	Adds the given SASL mechanism to the set of those allowed during connection authentication.
object	Clone ()
	Clone this options instance, changes to the cloned options are not reflected in this options instance.

Static Public Attributes
static readonly bool	DEFAULT_SASL_ENABLED = true
	Default for SASL use on any connection created using these options.

Properties
bool	SaslEnabled = DEFAULT_SASL_ENABLED [get, set]
	Configures if a connection will enable its SASL layer for authentication which by default all connections will do. This should only be disabled if the remote peer is known not to be using a SASL authentication layer.
IReadOnlyCollection< string >	AllowedMechanisms [get]
	Returns a copy of the set of all allowed SASL mechanisms for the connections created using these options. By default there are no restrictions and all client supported SASL mechanisms will be considered however in some cases certain mechanisms are not enabled unless the user manually specifies them at the exclusion of all other mechanisms.

Detailed Description

Options that control how the SASL authentication process is performed.

Constructor & Destructor Documentation

SaslOptions()

Apache.Qpid.Proton.Client.SaslOptions.SaslOptions ( SaslOptions  other )

inline

Create a new SASL options instance whose settings are copied from the instance provided.

Parameters

other

The connection options instance to copy

Member Function Documentation

AddAllowedMechanism()

void Apache.Qpid.Proton.Client.SaslOptions.AddAllowedMechanism ( string  mechanism )

inline

Adds the given SASL mechanism to the set of those allowed during connection authentication.

Parameters

mechanism

The mechanism to add to the allowed set

Clone()

object Apache.Qpid.Proton.Client.SaslOptions.Clone ( )

inline

Clone this options instance, changes to the cloned options are not reflected in this options instance.

Returns

A deep copy of this options instance.

---

The documentation for this class was generated from the following file:

• src/Proton.Client/Client/SaslOptions.cs