Package openid :: Package server :: Module server :: Class ProtocolError
[frames | no frames]

Type ProtocolError

   object --+        
            |        
BaseException --+    
                |    
        Exception --+
                    |
                   ProtocolError

Known Subclasses:
MalformedReturnURL, MalformedTrustRoot, UntrustedReturnURL

A message did not conform to the OpenID protocol.
Method Summary
  __init__(self, message, text, reference, contact)
When an error occurs.
  encodeToKVForm(self)
  encodeToURL(self)
str getReturnTo(self)
Get the return_to argument from the request, if any.
bool hasReturnTo(self)
Did this request have a return_to parameter?
  toFormMarkup(self)
Encode to HTML form markup for POST.
  toHTML(self)
Encode to a full HTML page, wrapping the form markup in a page that will autosubmit the form.
  toMessage(self)
Generate a Message object for sending to the relying party, after encoding.
  whichEncoding(self)
How should I be encoded?
Inherited from Exception: __new__
Inherited from BaseException: __delattr__, __getattribute__, __getitem__, __getslice__, __reduce__, __repr__, __setattr__, __setstate__, __str__
Inherited from object: __hash__, __reduce_ex__

Instance Variable Summary
openid.message.Message message: The query that is failing to be a valid OpenID request.

Class Variable Summary
Inherited from BaseException: args

Method Details

__init__(self, message, text=None, reference=None, contact=None)
(Constructor)

When an error occurs.
Parameters:
message - The message that is failing to be a valid OpenID request.
           (type=openid.message.Message)
text - A message about the encountered error. Set as args[0].
           (type=str)
Overrides:
exceptions.Exception.__init__

getReturnTo(self)

Get the return_to argument from the request, if any.
Returns:
str

hasReturnTo(self)

Did this request have a return_to parameter?
Returns:
bool

toFormMarkup(self)

Encode to HTML form markup for POST.

Since: 2.1.0

toHTML(self)

Encode to a full HTML page, wrapping the form markup in a page that will autosubmit the form.

Since: 2.1.?

toMessage(self)

Generate a Message object for sending to the relying party, after encoding.

whichEncoding(self)

How should I be encoded?
Returns:
one of ENCODE_URL, ENCODE_KVFORM, or None. If None, I cannot be encoded as a protocol message and should be displayed to the user.

Instance Variable Details

message

The query that is failing to be a valid OpenID request.
Type:
openid.message.Message

Generated by Epydoc 2.1 on Wed Apr 22 16:14:20 2009 http://epydoc.sf.net