t.w.p.j.x.Authenticator : class documentation

Part of twisted.words.protocols.jabber.xmlstream View Source 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:

  1. The Authenticator MUST dispatch a STREAM_AUTHD_EVENT when the stream has been completely initialized.
  2. The Authenticator SHOULD reset all state information when associateWithStream is called.
  3. The Authenticator SHOULD override streamStarted, and start initialization there.
Notethe 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.
xmlstream =
The XmlStream that needs authentication (type: XmlStream)
def __init__(self): (source)
Undocumented
def connectionMade(self): (source)
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.

def streamStarted(self, rootElement): (source)
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.

def associateWithStream(self, xmlstream): (source)
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)
API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.