Package openid :: Package consumer :: Module consumer :: Class SuccessResponse
[frames | no frames]

Type SuccessResponse

object --+    
         |    
  Response --+
             |
            SuccessResponse


A response with a status of SUCCESS. Indicates that this request is a successful acknowledgement from the OpenID server that the supplied URL is, indeed controlled by the requesting agent.
Method Summary
  __init__(self, endpoint, message, signed_fields)
  __eq__(self, other)
  __ne__(self, other)
  __repr__(self)
  extensionResponse(self, namespace_uri, require_signed)
Return response arguments in the specified namespace.
str getReturnTo(self)
Get the openid.return_to argument from this response.
  getSigned(self, ns_uri, ns_key, default)
Return the specified signed field if available, otherwise return default
  getSignedNS(self, ns_uri)
Get signed arguments from the response message.
  isOpenID1(self)
Was this authentication response an OpenID 1 authentication response?
  isSigned(self, ns_uri, ns_key)
Return whether a particular key is signed, regardless of its namespace alias
Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Instance Variable Summary
OpenIDServiceEndpoint endpoint: The endpoint that authenticated the identifier.
  identity_url: The identity URL that has been authenticated; the Claimed Identifier.
  signed_fields: The arguments in the server's response that were signed and verified.

Class Variable Summary
str status: SUCCESS

Method Details

extensionResponse(self, namespace_uri, require_signed)

Return response arguments in the specified namespace.
Parameters:
namespace_uri - The namespace URI of the arguments to be returned.
require_signed -

True if the arguments should be among those signed in the response, False if you don't care.

If require_signed is True and the arguments are not signed, return None.

getReturnTo(self)

Get the openid.return_to argument from this response.

This is useful for verifying that this request was initiated by this consumer.
Returns:
The return_to URL supplied to the server on the initial request, or None if the response did not contain an openid.return_to argument.
           (type=str)

getSigned(self, ns_uri, ns_key, default=None)

Return the specified signed field if available, otherwise return default

getSignedNS(self, ns_uri)

Get signed arguments from the response message. Return a dict of all arguments in the specified namespace. If any of the arguments are not signed, return None.

isOpenID1(self)

Was this authentication response an OpenID 1 authentication response?

isSigned(self, ns_uri, ns_key)

Return whether a particular key is signed, regardless of its namespace alias

Instance Variable Details

endpoint

The endpoint that authenticated the identifier. You may access other discovered information related to this endpoint, such as the CanonicalID of an XRI, through this object.
Type:
OpenIDServiceEndpoint

identity_url

The identity URL that has been authenticated; the Claimed Identifier. See also getDisplayIdentifier.

signed_fields

The arguments in the server's response that were signed and verified.

Class Variable Details

status

SUCCESS
Type:
str
Value:
'success'                                                              

Generated by Epydoc 2.1 on Fri Jun 6 15:54:34 2008 http://epydoc.sf.net