org.jivesoftware.smack.sasl

Class SASLMechanism

java.lang.Object

org.jivesoftware.smack.sasl.SASLMechanism

Direct Known Subclasses:

SASLAnonymous, SASLPlainMechanism

public abstract class SASLMechanism
extends java.lang.Object

Base class for SASL mechanisms. Subclasses must implement three methods:

• getName() -- returns the common name of the SASL mechanism.
• getAuthenticationText(String, String, String) -- authentication text to include in the initial auth stanza.
• getChallengeResponse(byte[]) -- to respond challenges made by the server.

Author:

Gaston Dombiak

Constructor Summary

Constructors

Constructor and Description
SASLMechanism(SASLAuthentication saslAuthentication)

Method Summary

Methods

Modifier and Type	Method and Description
void	authenticate(java.lang.String username, java.lang.String host, java.lang.String password) Builds and sends the auth stanza to the server.
void	challengeReceived(java.lang.String challenge) The server is challenging the SASL mechanism for the stanza he just sent.
protected abstract java.lang.String	getAuthenticationText(java.lang.String username, java.lang.String host, java.lang.String password) Returns the authentication text to include in the initial auth stanza or null if nothing should be added.
protected abstract java.lang.String	getChallengeResponse(byte[] bytes) Returns the response text to send answering the challenge sent by the server.
protected abstract java.lang.String	getName() Returns the common name of the SASL mechanism.
protected SASLAuthentication	getSASLAuthentication()

Methods inherited from class java.lang.Object

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

Constructor Detail

SASLMechanism

public SASLMechanism(SASLAuthentication saslAuthentication)

Method Detail

authenticate

public void authenticate(java.lang.String username,
                java.lang.String host,
                java.lang.String password)
                  throws java.io.IOException

Builds and sends the auth stanza to the server.

Parameters:

username - the username of the user being authenticated.

host - the hostname where the user account resides.

password - the password of the user.

Throws:

java.io.IOException - If a network error occures while authenticating.

challengeReceived

public void challengeReceived(java.lang.String challenge)
                       throws java.io.IOException

The server is challenging the SASL mechanism for the stanza he just sent. Send a response to the server's challenge.

Parameters:

challenge - a base64 encoded string representing the challenge.

Throws:

java.io.IOException

getChallengeResponse

protected abstract java.lang.String getChallengeResponse(byte[] bytes)

Returns the response text to send answering the challenge sent by the server. Mechanisms that will never receive a challenge may redefine this method returning null.

Parameters:

bytes - the challenge sent by the server.

Returns:

the response text to send to answer the challenge sent by the server.

getName

protected abstract java.lang.String getName()

Returns the common name of the SASL mechanism. E.g.: PLAIN, DIGEST-MD5 or KERBEROS_V4.

Returns:

the common name of the SASL mechanism.

getAuthenticationText

protected abstract java.lang.String getAuthenticationText(java.lang.String username,
                                     java.lang.String host,
                                     java.lang.String password)

Returns the authentication text to include in the initial auth stanza or null if nothing should be added.

Parameters:

username - the username of the user being authenticated.

host - the hostname where the user account resides.

password - the password of the user.

Returns:

the authentication text to include in the initial auth stanza or null if nothing should be added.

getSASLAuthentication

protected SASLAuthentication getSASLAuthentication()