Back to index

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

List of all members.

Public Member Functions

def getUserNames
def getUsers
def getUser
def getUserById
def validate

Detailed Description

Interface for user folders which can afford to enumerate their users.

Definition at line 252 of file authservice.py.


Member Function Documentation

Specify the interface called out in AccessControl.User.BasicUserFolder
as the "Public UserFolder object interface":

o N.B: "enumeration" methods ('getUserNames', 'getUsers') are *not*
   part of the contract!  See IEnumerableUserFolder.
Return the named user object or None.

Definition at line 117 of file authservice.py.

00117 
00118     def getUser( name ):
00119 
00120         """ Return the named user object or None.
00121         """

Here is the caller graph for this function:

def PluggableAuthService.interfaces.authservice.IUserFolder.getUserById (   id,
  default = None 
) [inherited]
Return the user corresponding to the given id.

o If no such user can be found, return 'default'.

Definition at line 122 of file authservice.py.

00122 
00123     def getUserById( id, default=None ):
00124 
00125         """ Return the user corresponding to the given id.
00126 
00127         o If no such user can be found, return 'default'.
00128         """

Interface for user folders which can afford to enumerate their users.
Return a list of usernames.

Definition at line 257 of file authservice.py.

00257 
00258     def getUserNames():
00259 
00260         """ Return a list of usernames.
00261         """

Return a list of user objects.

Definition at line 262 of file authservice.py.

00262 
00263     def getUsers():
00264 
00265         """ Return a list of user objects.
00266         """
def PluggableAuthService.interfaces.authservice.IUserFolder.validate (   request,
  auth = '',
  roles = _noroles 
) [inherited]
Perform identification, authentication, and authorization.

o Return an IUser-conformant user object, or None if we can't
  identify / authorize the user.

o 'request' is the request object

o 'auth' is any credential information already extracted by
  the caller

o roles is the list of roles the caller

Definition at line 129 of file authservice.py.

00129 
00130     def validate( request, auth='', roles=_noroles ):
00131 
00132         """ Perform identification, authentication, and authorization.
00133 
00134         o Return an IUser-conformant user object, or None if we can't
00135           identify / authorize the user.
00136 
00137         o 'request' is the request object
00138 
00139         o 'auth' is any credential information already extracted by
00140           the caller
00141 
00142         o roles is the list of roles the caller
00143         """

Here is the caller graph for this function:


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