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

Class GenericConsumer

source code

object --+
         |
        GenericConsumer
Known Subclasses:

This is the implementation of the common logic for OpenID consumers. It is unaware of the application in which it is running.

Instance Methods
 
__init__(self, store)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
begin(self, service_endpoint)
Create an AuthRequest object for the specified service_endpoint.
source code
 
complete(self, message, endpoint, return_to)
Process the OpenID message, using the specified endpoint and return_to URL as context.
source code

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

Class Variables
  openid1_nonce_query_arg_name = 'janrain_nonce'
  openid1_return_to_identifier_name = 'openid1_claimed_id'
  session_types = {'DH-SHA1': <class 'openid.consumer.consumer.D...
Instance Variables
openid.association.SessionNegotiator negotiator
An object that controls the kind of associations that the consumer makes.
Properties

Inherited from object: __class__

Method Details

__init__(self, store)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

begin(self, service_endpoint)

source code 

Create an AuthRequest object for the specified service_endpoint. This method will create an association if necessary.

complete(self, message, endpoint, return_to)

source code 

Process the OpenID message, using the specified endpoint and return_to URL as context. This method will handle any OpenID message that is sent to the return_to URL.


Class Variable Details

session_types

Value:
{'DH-SHA1': <class 'openid.consumer.consumer.DiffieHellmanSHA1Consumer\
Session'>,
 'DH-SHA256': <class 'openid.consumer.consumer.DiffieHellmanSHA256Cons\
umerSession'>,
 'no-encryption': <class 'openid.consumer.consumer.PlainTextConsumerSe\
ssion'>}

Instance Variable Details

negotiator

An object that controls the kind of associations that the consumer makes. It defaults to openid.association.default_negotiator. Assign a different negotiator to it if you have specific requirements for how associations are made.
Type:
openid.association.SessionNegotiator