org.apache.activemq.transport.amqp.sasl

Interface SaslMechanism

All Known Implementing Classes:

AbstractSaslMechanism, AnonymousMechanism, PlainMechanism

public interface SaslMechanism

A SASL Mechanism implements this interface in order to provide the AmqpAuthenticator with the means of providing authentication services in the SASL handshake step.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFailureReason()
String	getMechanismName()
String	getPassword()
String	getUsername()
boolean	isFailed()
void	processSaslStep(org.apache.qpid.proton.engine.Sasl sasl) Perform the SASL processing for this mechanism type.

Method Detail

processSaslStep

void processSaslStep(org.apache.qpid.proton.engine.Sasl sasl)

Perform the SASL processing for this mechanism type.

Parameters:

sasl - the SASL server that has read the incoming SASL exchange.

getUsername

String getUsername()

Returns:

the User Name extracted from the SASL echange or null if none.

getPassword

String getPassword()

Returns:

the Password extracted from the SASL echange or null if none.

getMechanismName

String getMechanismName()

Returns:

the name of the implemented SASL mechanism.

isFailed

boolean isFailed()

Returns:

true if the SASL processing failed during a step.

getFailureReason

String getFailureReason()

Returns:

a failure error to explain why the mechanism failed.