Package openid :: Package extensions :: Module pape :: Class Request
[frames | no frames]

Type Request

object --+    
         |    
 Extension --+
             |
            Request


A Provider Authentication Policy request, sent from a relying party to a provider
Method Summary
  __init__(self, preferred_auth_policies, max_auth_age)
  __nonzero__(self)
  addPolicyURI(self, policy_uri)
Add an acceptable authentication policy URI to this request
  fromOpenIDRequest(cls, request)
Instantiate a Request object from the arguments in a checkid_* OpenID message (Class method)
  getExtensionArgs(self)
None parseExtensionArgs(self, args)
Set the state of this request to be that expressed in these PAPE arguments
[str] preferredTypes(self, supported_types)
Given a list of authentication policy URIs that a provider supports, this method returns the subsequence of those types that are preferred by the relying party.
Inherited from Extension: toMessage
Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variable Summary
int or NoneType max_auth_age: The maximum time, in seconds, that the relying party wants to allow to have elapsed before the user must re-authenticate
NoneType ns_uri: The namespace to which to add the arguments for this extension
[str] preferred_auth_policies: The authentication policies that the relying party prefers

Class Variable Summary
str ns_alias = 'pape'

Instance Method Details

addPolicyURI(self, policy_uri)

Add an acceptable authentication policy URI to this request

This method is intended to be used by the relying party to add acceptable authentication types to the request.
Parameters:
policy_uri - The identifier for the preferred type of authentication.

See Also: http://openid.net/specs/openid-provider-authentication-policy-extension-1_0-01.html#auth_policies

getExtensionArgs(self)

Overrides:
openid.extension.Extension.getExtensionArgs

See Also: Extension.getExtensionArgs

parseExtensionArgs(self, args)

Set the state of this request to be that expressed in these PAPE arguments
Parameters:
args - The PAPE arguments without a namespace
Returns:
None
Raises:
ValueError - When the max_auth_age is not parseable as an integer

preferredTypes(self, supported_types)

Given a list of authentication policy URIs that a provider supports, this method returns the subsequence of those types that are preferred by the relying party.
Parameters:
supported_types - A sequence of authentication policy type URIs that are supported by a provider
Returns:
The sub-sequence of the supported types that are preferred by the relying party. This list will be ordered in the order that the types appear in the supported_types sequence, and may be empty if the provider does not prefer any of the supported authentication types.
           (type=[str])

Class Method Details

fromOpenIDRequest(cls, request)

Instantiate a Request object from the arguments in a checkid_* OpenID message

Instance Variable Details

max_auth_age

The maximum time, in seconds, that the relying party wants to allow to have elapsed before the user must re-authenticate
Type:
int or NoneType

ns_uri

The namespace to which to add the arguments for this extension
Type:
NoneType
Value:
'http://specs.openid.net/extensions/pape/1.0'                          

preferred_auth_policies

The authentication policies that the relying party prefers
Type:
[str]

Class Variable Details

ns_alias

Type:
str
Value:
'pape'                                                                 

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