twisted.words.protocols.jabber.xmlstream.Authenticator class documentationtwisted.words.protocols.jabber.xmlstream
(View In Hierarchy)
Known subclasses: twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator, twisted.words.protocols.jabber.xmlstream.ListenAuthenticator
Base class for business logic of initializing an XmlStream
Subclass this object to enable an XmlStream to initialize and authenticate to different types of stream hosts (such as clients, components, etc.).
Rules:
STREAM_AUTHD_EVENT
when the stream has been completely initialized.
associateWithStream
is called.
streamStarted,
and start initialization there.
| Note | the term authenticator is historical. Authenticators perform all steps required to prepare the stream for the exchange of XML stanzas. | |
| Instance Variable | xmlstream | The XmlStream that needs authentication (type: XmlStream) |
| Method | __init__ | Undocumented |
| Method | connectionMade | Called by the XmlStream when the underlying socket connection is in place. |
| Method | streamStarted | Called by the XmlStream when the stream has started. |
| Method | associateWithStream | Called by the XmlStreamFactory when a connection has been made to the requested peer, and an XmlStream object has been instantiated. |
Called by the XmlStream when the underlying socket connection is in place.
This allows the Authenticator to send an initial root element, if it's connecting, or wait for an inbound root from the peer if it's accepting the connection.
Subclasses can use self.xmlstream.send() to send any initial data to the peer.
Called by the XmlStream when the stream has started.
A stream is considered to have started when the start tag of the root element has been received.
This examines rootElement to see if there is a version
attribute. If absent, 0.0 is assumed per RFC 3920.
Subsequently, the minimum of the version from the received stream header
and the value stored in xmlstream
is taken and put back in xmlstream.
Extensions of this method can extract more information from the stream header and perform checks on them, optionally sending stream errors and closing the stream.
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) |