Back to index

plone3  3.1.7
Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | Static Private Attributes
PluggableAuthService.plugins.SearchPrincipalsPlugin.SearchPrincipalsPlugin Class Reference
Inheritance diagram for PluggableAuthService.plugins.SearchPrincipalsPlugin.SearchPrincipalsPlugin:
Inheritance graph
[legend]
Collaboration diagram for PluggableAuthService.plugins.SearchPrincipalsPlugin.SearchPrincipalsPlugin:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def enumerateUsers
def enumerateGroups

Public Attributes

 id
 title
 delegate

Static Public Attributes

tuple security = ClassSecurityInfo()
string meta_type = 'Search Principals Plugin'

Private Member Functions

def _getDelegate

Static Private Attributes

tuple _properties

Detailed Description

SearchPrincipalsPlugin delegates its enumerateUsers
and enumerateGroups methods to a delegate object

Definition at line 65 of file SearchPrincipalsPlugin.py.


Constructor & Destructor Documentation

def PluggableAuthService.plugins.SearchPrincipalsPlugin.SearchPrincipalsPlugin.__init__ (   self,
  id,
  title = '',
  delegate_path = '' 
)
Initialize a new instance 

Definition at line 80 of file SearchPrincipalsPlugin.py.

00080 
00081     def __init__(self, id, title='', delegate_path=''):
00082         """ Initialize a new instance """
00083         self.id = id
00084         self.title = title
00085         self.delegate = delegate_path


Member Function Documentation

Safely retrieve a PluggableAuthService to work with 

Definition at line 87 of file SearchPrincipalsPlugin.py.

00087 
00088     def _getDelegate(self):
00089         """ Safely retrieve a PluggableAuthService to work with """
00090         uf = getattr(aq_base(self), 'acl_users', None)
00091 
00092         if uf is None and self.delegate:
00093             uf = self.unrestrictedTraverse(self.delegate)
00094 
00095         return uf

Here is the call graph for this function:

Here is the caller graph for this function:

def PluggableAuthService.plugins.SearchPrincipalsPlugin.SearchPrincipalsPlugin.enumerateGroups (   self,
  id = None,
  exact_match = 0,
  sort_by = None,
  max_results = None,
  kw 
)
see IGroupEnumerationPlugin 

Definition at line 125 of file SearchPrincipalsPlugin.py.

00125 
00126                        ):
00127         """ see IGroupEnumerationPlugin """
00128         acl = self._getDelegate()
00129 
00130         if acl is None:
00131             return ()
00132 
00133         return acl.searchGroups( id=id
00134                                , exact_match=exact_match
00135                                , sort_by=sort_by
00136                                , max_results=max_results
00137                                , **kw )
00138 
00139 classImplements( SearchPrincipalsPlugin
00140                , ISearchPrincipalsPlugin
00141                , IUserEnumerationPlugin
00142                , IGroupEnumerationPlugin
00143                )
00144 
00145 InitializeClass(SearchPrincipalsPlugin)

Here is the call graph for this function:

Here is the caller graph for this function:

def PluggableAuthService.plugins.SearchPrincipalsPlugin.SearchPrincipalsPlugin.enumerateUsers (   self,
  id = None,
  login = None,
  exact_match = 0,
  sort_by = None,
  max_results = None,
  kw 
)
see IUserEnumerationPlugin 

Definition at line 104 of file SearchPrincipalsPlugin.py.

00104 
00105                       ):
00106         """ see IUserEnumerationPlugin """
00107         acl = self._getDelegate()
00108 
00109         if acl is None:
00110             return ()
00111 
00112         return acl.searchUsers( id=id
00113                               , login=login
00114                               , exact_match=exact_match
00115                               , sort_by=sort_by
00116                               , max_results=max_results
00117                               , **kw )

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

Initial value:
( { 'id' : 'delegate'
                    , 'label' : ' Delegate Path'
                    , 'type' : 'string'
                    , 'mode' : 'w'
                    }
                  ,
                  )

Definition at line 72 of file SearchPrincipalsPlugin.py.

Definition at line 84 of file SearchPrincipalsPlugin.py.

Definition at line 82 of file SearchPrincipalsPlugin.py.

Definition at line 70 of file SearchPrincipalsPlugin.py.

Definition at line 69 of file SearchPrincipalsPlugin.py.

Definition at line 83 of file SearchPrincipalsPlugin.py.


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