Package ldaptor :: Module interfaces :: Class IConnectedLDAPEntry
[show private | hide private]
[frames | no frames]

Type IConnectedLDAPEntry

object --+    
         |    
 Interface --+
             |
            IConnectedLDAPEntry


Interface definition for LDAP entries that are part of a bigger whole.
Method Summary
  children(self, callback)
List the direct children of this entry.
  fetch(self, *attributes)
Fetch the attributes of this object from the server.
  lookup(self, dn)
Lookup the referred to by dn.
  match(self, filter)
Does entry match filter.
  namingContext(self)
Return an LDAPEntry for the naming context that contains this object.
  search(self, filterText, filterObject, attributes, scope, derefAliases, sizeLimit, timeLimit, typesOnly, callback)
Perform an LDAP search with this object as the base.
  subtree(self, callback)
List the subtree rooted at this entry, including this entry.
    Inherited from Interface
  adaptWith(self, using, to, registry)
(Class method)
    Inherited from object
  __init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Instance Method Details

children(self, callback=None)

List the direct children of this entry. Try to avoid using .search(), as this will be used later to implement .search() on LDAP backends.
Parameters:
callback - Callback function to call for each resulting LDAPEntry. None means gather the results into a list and give that to the Deferred returned from here.
Returns:
A Deferred that will complete when the list is over. The Deferred gives None if callback was given and a list of the children if callback is not given or is None.

fetch(self, *attributes)

Fetch the attributes of this object from the server.
Returns:
A Deferred that will complete when the operation is done.

lookup(self, dn)

Lookup the referred to by dn.
Returns:
A Deferred returning an ILDAPEntry, or failing with e.g. LDAPNoSuchObject.

match(self, filter)

Does entry match filter.
Parameters:
filter - An LDAPFilter (e.g. LDAPFilter_present, LDAPFilter_equalityMatch etc. TODO provide an interface or superclass for filters.)
Returns:
Boolean.

namingContext(self)

Return an LDAPEntry for the naming context that contains this object.

search(self, filterText=None, filterObject=None, attributes=(), scope=None, derefAliases=None, sizeLimit=0, timeLimit=0, typesOnly=0, callback=None)

Perform an LDAP search with this object as the base.
Parameters:
filterText - LDAP search filter as a string.
filterObject - LDAP search filter as LDAPFilter. Note if both filterText and filterObject are given, they are combined with AND. If neither is given, the search is made with a filter that matches everything.
attributes - List of attributes to retrieve for the result objects. An empty list and means all.
scope - Whether to recurse into subtrees.
derefAliases - Whether to deref LDAP aliases. TODO write better documentation.
sizeLimit - At most how many entries to return. 0 means unlimited.
timeLimit - At most how long to use for processing the search request. 0 means unlimited.
typesOnly - Whether to return attribute types only, or also values.
callback - Callback function to call for each resulting LDAPEntry. None means gather the results into a list and give that to the Deferred returned from here.
Returns:
A Deferred that will complete when the search is done. The Deferred gives None if callback was given and a list of the search results if callback is not given or is None.

subtree(self, callback=None)

List the subtree rooted at this entry, including this entry. Try to avoid using .search(), as this will be used later to implement .search() on LDAP backends.
Parameters:
callback - Callback function to call for each resulting LDAPEntry. None means gather the results into a list and give that to the Deferred returned from here.
Returns:
A Deferred that will complete when the list is over. The Deferred gives None if callback was given and a list of the children if callback is not given or is None.

Generated by Epydoc 2.1 on Tue Aug 17 17:08:20 2004 http://epydoc.sf.net