class documentation

Undocumented

Method __init__ Initialize the object.
Method addChild TODO ugly API. Returns the created entry.
Method children List the direct children of this entry. Try to avoid using .search(), as this will be used later to implement .search() on LDAP backends.
Method commit Send all pending changes to the LDAP server.
Method delete Delete this object from the LDAP server.
Method deleteChild Undocumented
Method fetch Fetch the attributes of this object from the server.
Method lookup Lookup the referred to by dn.
Method move Move the object to a new DN.
Method parent Undocumented
Instance Variable dn Undocumented
Method _delete Undocumented
Method _deleteChild Undocumented
Method _lookup Undocumented
Method _move Undocumented
Method _move2 Undocumented
Instance Variable _children Undocumented
Instance Variable _parent Undocumented

Inherited from EditableLDAPEntry:

Method __delitem__ Delete all values of an attribute.
Method __setitem__ Set values of an attribute. Please use lists. Do not modify the lists in place, that's not supported _yet_.
Method setPassword Update the password for the entry with a new password and salt passed as bytes.
Method undo Forget all pending changes.

Inherited from BaseLDAPEntry (via EditableLDAPEntry):

Method __bool__ Undocumented
Method __contains__ TODO
Method __eq__ Comparison. Only equality is supported.
Method __getitem__ Get all values of an attribute.
Method __hash__ Undocumented
Method __iter__ Undocumented
Method __len__ TODO
Method __ne__ Inequality comparison. See L{__eq__}.
Method __nonzero__ Always return True
Method __repr__ Undocumented
Method bind Try to authenticate with given secret.
Method buildAttributeSet Undocumented
Method diff Compute differences between this and another LDAP entry.
Method get Get all values of an attribute.
Method getLDIF Undocumented
Method has_key TODO
Method hasMember Undocumented
Method items TODO
Method keys TODO
Method toWire Undocumented
Method _bind Undocumented
Class Variable _object_class_keys Undocumented
Class Variable _object_class_lower_keys Undocumented
Class Variable _user_password_keys Undocumented
Instance Variable _attributes Undocumented

Inherited from WireStrAlias (via EditableLDAPEntry, BaseLDAPEntry):

Method __str__ Undocumented

Inherited from DiffTreeMixin:

Method diffTree Undocumented
Method _diffTree_addedChildren Undocumented
Method _diffTree_commonChildren Undocumented
Method _diffTree_deletedChildren Undocumented
Method _diffTree_gotBothChildren Undocumented
Method _diffTree_gotMyChildren Undocumented

Inherited from SubtreeFromChildrenMixin:

Method subtree Undocumented

Inherited from MatchMixin:

Method match Undocumented

Inherited from SearchByTreeWalkingMixin:

Method search Undocumented
def __init__(self, *a, **kw): (source)

Initialize the object. @param dn: Distinguished Name of the object, as a string. @param attributes: Attributes of the object. A dictionary of attribute types to list of attribute values.

def addChild(self, rdn, attributes): (source)

TODO ugly API. Returns the created entry.

def children(self, callback=None): (source)

List the direct children of this entry. Try to avoid using .search(), as this will be used later to implement .search() on LDAP backends. @param 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. @return: 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.

def commit(self): (source)

Send all pending changes to the LDAP server. @returns: a Deferred that fires True (operation succeeded) or False (operation failed).

def delete(self): (source)

Delete this object from the LDAP server. @return: A Deferred that will complete when the delete is done.

def deleteChild(self, rdn): (source)

Undocumented

def fetch(self, *attributes): (source)

Fetch the attributes of this object from the server. @param attributes: Attributes to fetch. If none, fetch all attributes. Fetched attributes are overwritten, and if fetching all attributes, attributes that are not on the server are removed. @return: A Deferred that will complete when the operation is done.

def lookup(self, dn): (source)

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

def move(self, newDN): (source)

Move the object to a new DN. @param newDN: the new DistinguishedName @return: A Deferred that will complete when the move is done.

def parent(self): (source)

Undocumented

def _delete(self): (source)

Undocumented

def _deleteChild(self, rdn): (source)

Undocumented

def _lookup(self, dn): (source)

Undocumented

def _move(self, newDN): (source)

Undocumented

def _move2(self, newParent, newDN): (source)

Undocumented

_children: dict = (source)

Undocumented

_parent = (source)

Undocumented