org.apache.qpid.jms.sasl

Class GssapiMechanism

java.lang.Object

org.apache.qpid.jms.sasl.AbstractMechanism

org.apache.qpid.jms.sasl.GssapiMechanism

All Implemented Interfaces:

Comparable<Mechanism>, Mechanism

public class GssapiMechanism
extends AbstractMechanism

Implements the GSSAPI sasl authentication Mechanism.

Nested Class Summary

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

Mechanism.PRIORITY

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
GssapiMechanism()

Method Summary

Modifier and Type	Method and Description
byte[]	getChallengeResponse(byte[] challenge) Create a response based on a given challenge from the remote peer.
String	getConfigScope()
byte[]	getInitialResponse() Create an initial response based on selected mechanism.
String	getName()
int	getPriority()
String	getProtocol()
String	getServerName()
void	init(Map<String,String> saslOptions) Perform any configuration initiation required by the mechanism.
boolean	isApplicable(String username, String password, Principal localPrincipal) Allows the mechanism to determine if it can be used given the authentication provided.
boolean	isEnabledByDefault() Allows the mechanism to indicate if it is enabled by default, or only when explicitly enabled through configuring the permitted sasl mechanisms.
void	setConfigScope(String configScope)
void	setProtocol(String protocol)
void	setServerName(String serverName)
void	verifyCompletion() Verifies that the SASL exchange has completed successfully.

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

compareTo, getPassword, getUsername, setPassword, setUsername, toString

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

GssapiMechanism

public GssapiMechanism()

Method Detail

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.

isEnabledByDefault

public boolean isEnabledByDefault()

Description copied from interface: Mechanism

Allows the mechanism to indicate if it is enabled by default, or only when explicitly enabled through configuring the permitted sasl mechanisms.

Specified by:

isEnabledByDefault in interface Mechanism

Overrides:

isEnabledByDefault in class AbstractMechanism

Returns:

true if this Mechanism is enabled by default.

init

public void init(Map<String,String> saslOptions)

Description copied from interface: Mechanism

Perform any configuration initiation required by the mechanism.

Specified by:

init in interface Mechanism

Overrides:

init in class AbstractMechanism

Parameters:

saslOptions - An immutable map of sasl options. Will always be non-null.

getInitialResponse

public byte[] getInitialResponse()
                          throws SaslException

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.

Throws:

SaslException - if an error occurs computing the response.

getChallengeResponse

public byte[] getChallengeResponse(byte[] challenge)
                            throws SaslException

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.

Throws:

SaslException - if an error occurs computing the response.

verifyCompletion

public void verifyCompletion()
                      throws SaslException

Description copied from interface: Mechanism

Verifies that the SASL exchange has completed successfully. This is an opportunity for the mechanism to ensure that all mandatory steps have been completed successfully and to cleanup and resources that are held by this Mechanism.

Specified by:

verifyCompletion in interface Mechanism

Overrides:

verifyCompletion in class AbstractMechanism

Throws:

SaslException - if the outcome of the SASL exchange is not valid for this 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.

getProtocol

public String getProtocol()

setProtocol

public void setProtocol(String protocol)

getServerName

public String getServerName()

setServerName

public void setServerName(String serverName)

getConfigScope

public String getConfigScope()

setConfigScope

public void setConfigScope(String configScope)