Part of twisted.words.protocols.jabber.client View Source View In Hierarchy
This authenticator performs the initialization steps needed to start exchanging XML stanzas with an XMPP server as an XMPP client. It checks if the server advertises XML stream version 1.0, negotiates TLS (when available), performs SASL authentication, binds a resource and establishes a session.
Upon successful stream initialization, the
xmlstream.STREAM_AUTHD_EVENT event will be dispatched through
the XML stream object. Otherwise, the
xmlstream.INIT_FAILED_EVENT event will be dispatched with a
After inspection of the failure, initialization can then be restarted by
initializeStream. For example, in case of
authentication failure, a user may be given the opportunity to input the
correct password. By setting the
instance variable and restarting initialization, the stream authentication
step is then retried, and subsequent steps are performed if succesful.
|Instance Variable||jid||Jabber ID to authenticate with. This may contain a resource part, as a
suggestion to the server for resource binding. A server may override this,
though. If the resource part is left off, the server will generate a unique
resource identifier. The server will always return the full Jabber ID in
the resource binding step, and this is stored in this instance variable. (type:
|Instance Variable||password||password to be used during SASL authentication. (type:
|Method||associateWithStream||Register with the XML stream.|
Inherited from ConnectAuthenticator:
|Method||connectionMade||Called by the XmlStream when the underlying socket connection is in place.|
|Method||initializeStream||Perform stream initialization procedures.|
|Method||streamStarted||Called by the XmlStream when the stream has started.|
|Instance Variable||xmlstream||The XmlStream that needs authentication (type:
Populates stream's list of initializers, along with their requiredness.
This list is used by
to perform the initalization steps.