com.microsoft.azure.sdk.iot.deps.transport.amqp

Interface SaslHandler

public interface SaslHandler

Interface definition for what client events are expected to be handled during Sasl negotiation

See Also:

AMQPS 1.0 Sasl Negotiation Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SaslHandler.SaslOutcome Possible outcomes of Sasl negotiation as per AMQP 1.0

Method Summary

Modifier and Type	Method and Description
String	chooseSaslMechanism(String[] mechanisms) Handle the provided mechanisms and return the mechanism to be used from a provided list
byte[]	getInitPayload(String chosenMechanism) Based on the chosen mechanism, builds and returns the bytes to be sent in the payload for the Sasl init message
String	getPlainPassword()
String	getPlainUsername()
byte[]	handleChallenge(byte[] saslChallenge) Handles a given challenge and returns the bytes to be sent in the payload of the Sasl response message
void	handleOutcome(SaslHandler.SaslOutcome outcome) Handles what to do upon the Sasl negotiation finishing.
void	setSasToken(String sasToken)

Method Detail

chooseSaslMechanism

String chooseSaslMechanism(String[] mechanisms)
                    throws Exception

Handle the provided mechanisms and return the mechanism to be used from a provided list

Parameters:

mechanisms - A list of available Sasl Mechanisms offered by the service

Returns:

the mechanism to use

Throws:

Exception - if sasl negotiation fails

getInitPayload

byte[] getInitPayload(String chosenMechanism)
               throws Exception

Based on the chosen mechanism, builds and returns the bytes to be sent in the payload for the Sasl init message

Parameters:

chosenMechanism - the sasl mechanism that was chosen

Returns:

the bytes to be used as the paylaod for the Sasl init message

Throws:

Exception - if sasl negotiation fails

handleChallenge

byte[] handleChallenge(byte[] saslChallenge)
                throws Exception

Handles a given challenge and returns the bytes to be sent in the payload of the Sasl response message

Parameters:

saslChallenge - The bytes from the Sasl challenge received from the service

Returns:

the bytes to be sent in the payload of the Sasl response to the provided challenge

Throws:

Exception - if sasl negotiation fails

handleOutcome

void handleOutcome(SaslHandler.SaslOutcome outcome)
            throws Exception

Handles what to do upon the Sasl negotiation finishing.

Parameters:

outcome - The outcome of the sasl negotiation

Throws:

Exception - if sasl negotiation fails

getPlainUsername

String getPlainUsername()

getPlainPassword

String getPlainPassword()

setSasToken

void setSasToken(String sasToken)