Package org.apache.qpid.protonj2.engine.sasl.client

Class ExternalMechanism

java.lang.Object

org.apache.qpid.protonj2.engine.sasl.client.AbstractMechanism

org.apache.qpid.protonj2.engine.sasl.client.ExternalMechanism

All Implemented Interfaces:

Mechanism

public class ExternalMechanism
extends AbstractMechanism

Implements the External SASL authentication mechanism.

Field Summary

Fields

Modifier and Type	Field	Description
static final Symbol	EXTERNAL	A singleton instance of the symbolic mechanism name.

Fields inherited from class org.apache.qpid.protonj2.engine.sasl.client.AbstractMechanism

EMPTY

Constructor Summary

Constructors

Constructor	Description
ExternalMechanism()

Method Summary

Modifier and Type	Method	Description
Symbol	getName()
boolean	isApplicable(SaslCredentialsProvider credentials)	Allows the Mechanism to determine if it is a valid choice based on the configured credentials at the time of selection.

Methods inherited from class org.apache.qpid.protonj2.engine.sasl.client.AbstractMechanism

getChallengeResponse, getInitialResponse, isEnabledByDefault, toString, verifyCompletion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

EXTERNAL

public static final Symbol EXTERNAL

A singleton instance of the symbolic mechanism name.

Constructor Details

ExternalMechanism

public ExternalMechanism()

Method Details

isApplicable

public boolean isApplicable(SaslCredentialsProvider credentials)

Description copied from interface: Mechanism

Allows the Mechanism to determine if it is a valid choice based on the configured credentials at the time of selection.

Parameters:

credentials - the login credentials available at the time of mechanism selection.

Returns:

true if the mechanism can be used with the provided credentials

getName

public Symbol getName()

Returns:

the well known name of this SASL mechanism.