twisted.words.protocols.jabber.client.BasicAuthenticator(xmlstream.ConnectAuthenticator) class documentation

Part of twisted.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:

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).

Class Variable INVALID_USER_EVENT See IQAuthInitializer.INVALID_USER_EVENT. (type: str)
Class Variable AUTH_FAILED_EVENT See IQAuthInitializer.AUTH_FAILED_EVENT. (type: str)
Class Variable REGISTER_FAILED_EVENT Token to signal that registration failed. (type: str)
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)
INVALID_USER_EVENT =
See IQAuthInitializer.INVALID_USER_EVENT. (type: str)
AUTH_FAILED_EVENT =
See IQAuthInitializer.AUTH_FAILED_EVENT. (type: str)
REGISTER_FAILED_EVENT =
Token to signal that registration failed. (type: str)
def __init__(self, jid, password): (source)
overrides twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.__init__
Undocumented
def associateWithStream(self, xs): (source)
overrides twisted.words.protocols.jabber.xmlstream.Authenticator.associateWithStream

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.

ParametersxmlstreamThe XmlStream that will be passing events to this Authenticator. (type: XmlStream)
def registerAccount(self, username=None, password=None): (source)
Undocumented
def _registerResultEvent(self, iq): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2017-06-11 10:59:01.