Home | Trees | Index | Help |
|
---|
Package twisted :: Package protocols :: Module xmlstream :: Class Authenticator |
|
ConnectAuthenticator
,
ListenComponentAuthenticator
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:STREAM_AUTHD_EVENT
when the stream has
been completely authenticated.
associateWithStream
is called.
streamStarted
, and start authentication
there.
Method Summary | |
---|---|
__init__(self,
streamHost)
| |
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. | |
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.
|
connectionMade(self)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() with the provided xmlstream parameter to send any initial data to the peer |
streamStarted(self, rootelem)Called by the XmlStream when it has received a root element from the connected peer.
|
Instance Variable Details |
---|
streamHostTarget host for this stream (used as the 'to' attribute)
|
xmlstreamThe XmlStream that needs authentication
|
Class Variable Details |
---|
namespaceDefault namespace for the XmlStream
|
versionVersion attribute for XmlStream. 0.0 will cause the XmlStream to not include aversion attribute in the header.
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.0 on Sat May 15 20:08:42 2004 | http://epydoc.sf.net |