Home       Trees       Index       Help   

Twisted 1.0.7

Package twisted :: Package protocols :: Module xmlstream :: Class Authenticator
[frames | no frames]

Class Authenticator

Known Subclasses:
ComponentAuthenticator

Base class for business logic of authenticating an XmlStream

Subclass this object to enable an XmlStream to 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 authenticated.
  2. The Authenticator SHOULD reset all state information when associateWithStream is called.
  3. The Authenticator SHOULD override streamStarted, and start authentication there.
Method Summary
  __init__(self, streamHost)
  associateWithStream(self, xmlstream)
Called by the XmlStreamFactory when a connection has been made to the requested peer, and an XmlStream object has been instantiated.
  streamStarted(self, rootelem)
Called by the XmlStream when it has received a root element from the connected peer.

Instance Variable Summary
str streamHost: Target host for this stream (used as the 'to' attribute)
XmlStream xmlstream: The XmlStream that needs authentication

Class Variable Summary
str namespace: Default namespace for the XmlStream
int version: Version attribute for XmlStream.

Method Details

associateWithStream(self, 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)

streamStarted(self, rootelem)

Called by the XmlStream when it has received a root element from the connected peer.
Parameters:
rootelem - The root element of the XmlStream received from the streamHost
           (type=Element)

Instance Variable Details

streamHost

Target host for this stream (used as the 'to' attribute)
Type:
str

xmlstream

The XmlStream that needs authentication
Type:
XmlStream

Class Variable Details

namespace

Default namespace for the XmlStream
Type:
str
Value:
'invalid'

version

Version attribute for XmlStream. 0.0 will cause the XmlStream to not include a version attribute in the header.
Type:
int
Value:
0.0                                                                   

   Home       Trees       Index       Help   

Twisted 1.0.7

Generated by Epydoc 2.0 on Sat Sep 13 04:21:05 2003 http://epydoc.sf.net