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

Class CheckIDRequest

source code

   object --+    
            |    
OpenIDRequest --+
                |
               CheckIDRequest

A request to confirm the identity of a user.

This class handles requests for openid modes checkid_immediate and checkid_setup.

Instance Methods [hide private]
  __init__(self, identity, return_to, trust_root=None, immediate=False, assoc_handle=None)
Construct me.
bool trustRootValid(self)
Is my return_to under my trust_root?
OpenIDResponse answer(self, allow, server_url=None)
Respond to this request.
str encodeToURL(self, server_url)
Encode this request as a URL to GET.
str getCancelURL(self)
Get the URL to cancel this request.
  __str__(self)
str(x)

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__


Class Methods [hide private]
CheckIDRequest fromQuery(klass, query)
Construct me from a web query.

Class Variables [hide private]
str mode
the openid.mode of this request.

Instance Variables [hide private]
str assoc_handle
Provided in smart mode requests, a handle for a previously established association.
str identity
The identity URL being checked.
bool immediate
Is this an immediate-mode request?
str return_to
The URL to send the user agent back to to reply to this request.
str trust_root
"Are you Frank?" asks the checkid request.

Properties [hide private]

Inherited from object: __class__


Method Details [hide private]

__init__(self, identity, return_to, trust_root=None, immediate=False, assoc_handle=None)
(Constructor)

source code 

Construct me.

These parameters are assigned directly as class attributes, see my class documentation for their descriptions.
Raises:
Overrides: object.__init__

fromQuery(klass, query)
Class Method

source code 

Construct me from a web query.
Parameters:
  • query (dict) - The query parameters as a dictionary with each key mapping to one value.
Returns: CheckIDRequest
Raises:

trustRootValid(self)

source code 

Is my return_to under my trust_root?
Returns: bool

answer(self, allow, server_url=None)

source code 

Respond to this request.
Parameters:
  • allow (bool) - Allow this user to claim this identity, and allow the consumer to have this information?
  • server_url (str) - When an immediate mode request does not succeed, it gets back a URL where the request may be carried out in a not-so-immediate fashion. Pass my URL in here (the fully qualified address of this server's endpoint, i.e. http://example.com/server), and I will use it as a base for the URL for a new request.

    Optional for requests where CheckIDRequest.immediate is False or allow is True.
Returns: OpenIDResponse

encodeToURL(self, server_url)

source code 

Encode this request as a URL to GET.
Parameters:
  • server_url (str) - The URL of the OpenID server to make this request of.
Returns: str

getCancelURL(self)

source code 

Get the URL to cancel this request.

Useful for creating a "Cancel" button on a web form so that operation can be carried out directly without another trip through the server.

(Except you probably want to make another trip through the server so that it knows that the user did make a decision. Or you could simulate this method by doing .answer(False).encodeToURL())
Returns: str
The return_to URL with openid.mode = cancel.

__str__(self)
(Informal representation operator)

source code 

str(x)
Overrides: object.__str__
(inherited documentation)

Class Variable Details [hide private]

mode


the openid.mode of this request.
Type:
str

Instance Variable Details [hide private]

assoc_handle


Provided in smart mode requests, a handle for a previously established association. None for dumb mode requests.
Type:
str

identity


The identity URL being checked.
Type:
str

immediate


Is this an immediate-mode request?
Type:
bool

return_to


The URL to send the user agent back to to reply to this request.
Type:
str

trust_root


"Are you Frank?" asks the checkid request. "Who wants to know?" trust_root, that's who. This URL identifies the party making the request, and the user will use that to make her decision about what answer she trusts them to have.
Type:
str