Apache.Qpid.Proton.Engine.Sasl.ISaslContext Interface Reference

Root context of a SASL authentication API which provides common elements used in both clients and servers. More...

Inheritance diagram for Apache.Qpid.Proton.Engine.Sasl.ISaslContext:

Properties
SaslContextRole	Role [get]
	Returns the role this context plays either client or server.
IAttachments	Attachments [get]
	Access to the linked attachments instance where properties can be attached to this context for later application use.
bool	IsDone [get]
	Checks if SASL authentication has completed and an outcome is available.
bool	IsServer [get]
	Provides a quick check for this context being a server context.
bool	IsClient [get]
	Provides a quick check for this context being a server context.
SaslAuthOutcome	Outcome [get]
	Gets the outcome of the SASL authentication process. If the SASL exchange is ongoing or the SASL layer was skipped because a particular engine configuration allows such behavior then this method should return null to indicate no SASL outcome is available.
EngineSaslState	State [get]
	Returns a state enum that indicates the current operating state of the SASL negotiation process or conversely if no SASL layer is configured this method should return the no-SASL state. This method must never return a null result.
Symbol[]	ServerMechanisms [get]
	After the server has sent its supported mechanisms this method will return a copy of that list for review by the server event handler. If called before the server has sent the mechanisms list this method will return null.
Symbol	ChosenMechanism [get]
	Returns the mechanism that was sent to the server to select the SASL mechanism to use for negotiations. If called before the client has sent its chosen mechanism this method returns null.
string	Hostname [get]
	The DNS name of the host (either fully qualified or relative) that was sent to the server which define the host the sending peer is connecting to. If called before the client sent the host name information to the server this method returns null.

Detailed Description

Root context of a SASL authentication API which provides common elements used in both clients and servers.

Property Documentation

Attachments

IAttachments Apache.Qpid.Proton.Engine.Sasl.ISaslContext.Attachments

get

Access to the linked attachments instance where properties can be attached to this context for later application use.

Implemented in Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext.

ChosenMechanism

Symbol Apache.Qpid.Proton.Engine.Sasl.ISaslContext.ChosenMechanism

get

Returns the mechanism that was sent to the server to select the SASL mechanism to use for negotiations. If called before the client has sent its chosen mechanism this method returns null.

Implemented in Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext.

Hostname

string Apache.Qpid.Proton.Engine.Sasl.ISaslContext.Hostname

get

The DNS name of the host (either fully qualified or relative) that was sent to the server which define the host the sending peer is connecting to. If called before the client sent the host name information to the server this method returns null.

Implemented in Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext.

IsClient

bool Apache.Qpid.Proton.Engine.Sasl.ISaslContext.IsClient

get

Provides a quick check for this context being a server context.

Implemented in Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext.

IsDone

bool Apache.Qpid.Proton.Engine.Sasl.ISaslContext.IsDone

get

Checks if SASL authentication has completed and an outcome is available.

Implemented in Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext.

IsServer

bool Apache.Qpid.Proton.Engine.Sasl.ISaslContext.IsServer

get

Provides a quick check for this context being a server context.

Implemented in Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext.

Outcome

SaslAuthOutcome Apache.Qpid.Proton.Engine.Sasl.ISaslContext.Outcome

get

Gets the outcome of the SASL authentication process. If the SASL exchange is ongoing or the SASL layer was skipped because a particular engine configuration allows such behavior then this method should return null to indicate no SASL outcome is available.

Implemented in Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext.

Role

SaslContextRole Apache.Qpid.Proton.Engine.Sasl.ISaslContext.Role

get

Returns the role this context plays either client or server.

Implemented in Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslClientContext, Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext, and Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext.

ServerMechanisms

Symbol [] Apache.Qpid.Proton.Engine.Sasl.ISaslContext.ServerMechanisms

get

After the server has sent its supported mechanisms this method will return a copy of that list for review by the server event handler. If called before the server has sent the mechanisms list this method will return null.

Implemented in Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext.

State

EngineSaslState Apache.Qpid.Proton.Engine.Sasl.ISaslContext.State

get

Returns a state enum that indicates the current operating state of the SASL negotiation process or conversely if no SASL layer is configured this method should return the no-SASL state. This method must never return a null result.

Implemented in Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext.

---

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

• src/Proton/Engine/Sasl/ISaslContext.cs