|
Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.jivesoftware.smack.sasl.SASLMechanism
public abstract class SASLMechanism
Base class for SASL mechanisms. Subclasses must implement these methods:
getName() -- returns the common name of the SASL mechanism.authenticate(String, String, String) -- Initiate authentication stanza using the
deprecated method.authenticate(String, String, CallbackHandler) -- Initiate authentication stanza
using the CallbackHandler method.challengeReceived(String) -- Handle a challenge from the server.
| Nested Class Summary | |
|---|---|
class |
SASLMechanism.AuthMechanism
Initiating SASL authentication by select a mechanism. |
static class |
SASLMechanism.Challenge
A SASL challenge stanza. |
static class |
SASLMechanism.Failure
A SASL failure stanza. |
class |
SASLMechanism.Response
A SASL response stanza. |
static class |
SASLMechanism.Success
A SASL success stanza. |
| Field Summary | |
|---|---|
protected String |
authenticationId
|
protected String |
hostname
|
protected String |
password
|
protected javax.security.sasl.SaslClient |
sc
|
| Constructor Summary | |
|---|---|
SASLMechanism(SASLAuthentication saslAuthentication)
|
|
| Method Summary | |
|---|---|
protected void |
authenticate()
|
void |
authenticate(String username,
String host,
javax.security.auth.callback.CallbackHandler cbh)
Builds and sends the auth stanza to the server. |
void |
authenticate(String username,
String host,
String password)
Builds and sends the auth stanza to the server. |
void |
challengeReceived(String challenge)
The server is challenging the SASL mechanism for the stanza he just sent. |
protected abstract String |
getName()
Returns the common name of the SASL mechanism. |
protected SASLAuthentication |
getSASLAuthentication()
|
void |
handle(javax.security.auth.callback.Callback[] callbacks)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected javax.security.sasl.SaslClient sc
protected String authenticationId
protected String password
protected String hostname
| Constructor Detail |
|---|
public SASLMechanism(SASLAuthentication saslAuthentication)
| Method Detail |
|---|
public void authenticate(String username,
String host,
String password)
throws IOException,
XMPPException
authenticate(String, String, CallbackHandler) whenever possible.
username - the username of the user being authenticated.host - the hostname where the user account resides.password - the password for this account.
IOException - If a network error occurs while authenticating.
XMPPException - If a protocol error occurs or the user is not authenticated.
public void authenticate(String username,
String host,
javax.security.auth.callback.CallbackHandler cbh)
throws IOException,
XMPPException
username - the username of the user being authenticated.host - the hostname where the user account resides.cbh - the CallbackHandler to obtain user information.
IOException - If a network error occures while authenticating.
XMPPException - If a protocol error occurs or the user is not authenticated.
protected void authenticate()
throws IOException,
XMPPException
IOException
XMPPException
public void challengeReceived(String challenge)
throws IOException
challenge - a base64 encoded string representing the challenge.
IOException - if an exception sending the response occurs.protected abstract String getName()
protected SASLAuthentication getSASLAuthentication()
public void handle(javax.security.auth.callback.Callback[] callbacks)
throws IOException,
javax.security.auth.callback.UnsupportedCallbackException
handle in interface javax.security.auth.callback.CallbackHandlerIOException
javax.security.auth.callback.UnsupportedCallbackException
|
Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||