Back to index

plone3  3.1.7
Public Member Functions
PluggableAuthService.interfaces.plugins.IChallengeProtocolChooser Class Reference
Inheritance diagram for PluggableAuthService.interfaces.plugins.IChallengeProtocolChooser:
Inheritance graph
[legend]
Collaboration diagram for PluggableAuthService.interfaces.plugins.IChallengeProtocolChooser:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def chooseProtocols

Detailed Description

Choose a proper set of protocols to be used for challenging
the client given a request.

Definition at line 463 of file plugins.py.


Member Function Documentation

Choose a proper set of protocols to be used for challenging
the client given a request.
-> ( protocol_1, ... protocol_N) | None

o If a set of protocols is returned, the first plugin with a
    protocol that is in the set will define the protocol to be
    used for the current request.

o If None is returned, the 'first found protocol' wins.

o Once the protocol is decided, all challenge plugins for that
    protocol will be executed.

Definition at line 468 of file plugins.py.

00468 
00469     def chooseProtocols( request ):
00470         """ -> ( protocol_1, ... protocol_N) | None
00471         
00472         o If a set of protocols is returned, the first plugin with a
00473             protocol that is in the set will define the protocol to be
00474             used for the current request.
00475 
00476         o If None is returned, the 'first found protocol' wins.
00477 
00478         o Once the protocol is decided, all challenge plugins for that
00479             protocol will be executed.
00480         """
00481 #
00482 #   XXX:  Do we need a LocalRoleAlgorithm plugin type?  E.g., base_cms
00483 #         has two different algorithms, based on whether or not the
00484 #         context object implements IPlacelessSecurity.
00485 #

The documentation for this class was generated from the following file: