twisted.words.protocols.jabber.client.BasicAuthenticator(xmlstream.ConnectAuthenticator) class documentationtwisted.words.protocols.jabber.client
View Source
(View In Hierarchy)
Authenticates an XmlStream against a Jabber server as a Client.
This only implements non-SASL authentication, per JEP-0078. Additionally, this authenticator provides the ability to perform inline registration, per JEP-0077.
Under normal circumstances, the BasicAuthenticator generates the
xmlstream.STREAM_AUTHD_EVENT once the stream has
authenticated. However, it can also generate other events, such as:
INVALID_USER_EVENT : Authentication failed, due to invalid
username
AUTH_FAILED_EVENT : Authentication failed, due to invalid
password
REGISTER_FAILED_EVENT : Registration failed
If authentication fails for any reason, you can attempt to register by
calling the registerAccount
method. If the registration succeeds, a
xmlstream.STREAM_AUTHD_EVENT will be fired. Otherwise, one of
the above errors will be generated (again).
| Method | __init__ | Undocumented |
| Method | associateWithStream | Called by the XmlStreamFactory when a connection has been made to the requested peer, and an XmlStream object has been instantiated. |
| Method | registerAccount | Undocumented |
| Method | _registerResultEvent | Undocumented |
Inherited from Authenticator (via ConnectAuthenticator):
| Instance Variable | xmlstream | The XmlStream that needs authentication (type: XmlStream) |
Inherited from Authenticator (via ConnectAuthenticator):
| Instance Variable | xmlstream | The XmlStream that needs authentication (type: XmlStream) |
Called by the XmlStreamFactory when a connection has been made to the requested peer, and an XmlStream object has been instantiated.
The default implementation just saves a handle to the new XmlStream.
| Parameters | xmlstream | The XmlStream that will be passing events to this Authenticator. (type: XmlStream) |