Package org.apache.qpid.jms.sasl

Class ExternalMechanism

java.lang.Object

org.apache.qpid.jms.sasl.AbstractMechanism

org.apache.qpid.jms.sasl.ExternalMechanism

All Implemented Interfaces:

Comparable<Mechanism>, Mechanism

public class ExternalMechanism
extends AbstractMechanism

Implements the External SASL authentication mechanism.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.qpid.jms.sasl.Mechanism

Mechanism.PRIORITY

Field Summary

Fields inherited from class org.apache.qpid.jms.sasl.AbstractMechanism

EMPTY

Constructor Summary

Constructors

Constructor	Description
ExternalMechanism()

Method Summary

Modifier and Type	Method	Description
byte[]	getChallengeResponse(byte[] challenge)	Create a response based on a given challenge from the remote peer.
byte[]	getInitialResponse()	Create an initial response based on selected mechanism.
String	getName()
int	getPriority()
boolean	isApplicable(String username, String password, Principal localPrincipal)	Allows the mechanism to determine if it can be used given the authentication provided.

Methods inherited from class org.apache.qpid.jms.sasl.AbstractMechanism

compareTo, getPassword, getUsername, init, isEnabledByDefault, setPassword, setUsername, toString, verifyCompletion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.qpid.jms.sasl.Mechanism

getAdditionalFailureInformation

Constructor Detail

ExternalMechanism

public ExternalMechanism()

Method Detail

getInitialResponse

public byte[] getInitialResponse()

Description copied from interface: Mechanism

Create an initial response based on selected mechanism. May be null if there is no initial response.

Returns:

the initial response, or null if there isn't one.

getChallengeResponse

public byte[] getChallengeResponse(byte[] challenge)

Description copied from interface: Mechanism

Create a response based on a given challenge from the remote peer.

Parameters:

challenge - the challenge that this Mechanism should response to.

Returns:

the response that answers the given challenge.

getPriority

public int getPriority()

Returns:

return the relative priority of this SASL mechanism.

getName

public String getName()

Returns:

the well known name of this SASL mechanism.

isApplicable

public boolean isApplicable(String username,
                            String password,
                            Principal localPrincipal)

Description copied from interface: Mechanism

Allows the mechanism to determine if it can be used given the authentication provided.

Parameters:

username - The user name given to the client for authentication.

password - The password given to the client for authentication.

localPrincipal - The local Principal configured for the client for authentication.

Returns:

if this Mechanism is able to validate using the given credentials.