|
Wildfire 3.1.1 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jivesoftware.wildfire.net.SASLAuthentication
public class SASLAuthentication
SASLAuthentication is responsible for returning the available SASL mechanisms to use and for actually performing the SASL authentication.
The list of available SASL mechanisms is determined by 1) the type of
UserProvider
being used since some SASL mechanisms
require the server to be able to retrieve user passwords; 2) whether anonymous logins are
enabled or not and 3) whether the underlying connection has been secured or not.
Nested Class Summary | |
---|---|
static class |
SASLAuthentication.ElementType
|
static class |
SASLAuthentication.Status
|
Field Summary | |
---|---|
protected static String |
CHARSET
The utf-8 charset for decoding and encoding Jabber packet streams. |
Constructor Summary | |
---|---|
SASLAuthentication()
|
Method Summary | |
---|---|
static void |
addSupportedMechanism(String mechanism)
Adds a new SASL mechanism to the list of supported SASL mechanisms by the server. |
static String |
getSASLMechanisms(Session session)
Returns a string with the valid SASL mechanisms available for the specified session. |
static Set<String> |
getSupportedMechanisms()
Returns the list of supported SASL mechanisms by the server. |
static SASLAuthentication.Status |
handle(Session session,
org.dom4j.Element doc)
Handles the SASL authentication packet. |
static void |
removeSupportedMechanism(String mechanism)
Removes a SASL mechanism from the list of supported SASL mechanisms by the server. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static String CHARSET
Constructor Detail |
---|
public SASLAuthentication()
Method Detail |
---|
public static String getSASLMechanisms(Session session)
public static SASLAuthentication.Status handle(Session session, org.dom4j.Element doc) throws UnsupportedEncodingException
session
- the session that is authenticating with the server.doc
- the stanza sent by the authenticating entity.
UnsupportedEncodingException
- If UTF-8 charset is not supported.public static void addSupportedMechanism(String mechanism)
mechanism
- the new SASL mechanism.public static void removeSupportedMechanism(String mechanism)
mechanism
- the SASL mechanism to remove.public static Set<String> getSupportedMechanisms()
addSupportedMechanism(String)
to add
new SASL mechanisms.
|
Wildfire 3.1.1 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |