__init__(self, client, dn, attributes={}, complete=0)
(Constructor)

Parameters:

client - The LDAP client connection this object belongs to.

dn - Distinguished Name of the object, as a string.

attributes - Attributes of the object. A dictionary of attribute types to list of attribute values.

__delitem__(self, key)
(Index deletion operator)

>>> o=LDAPEntry(client=ldapclient.LDAPClient(),
...     dn='cn=foo,dc=example,dc=com',
...     attributes={
...     'anAttribute': ['itsValue', 'secondValue'],
...     'another': ['moreValues'],
...     })
>>> del o['anAttribute']
>>> o
LDAPEntry(dn='cn=foo,dc=example,dc=com', attributes={'another': ['moreValues']})

__eq__(self, other)
(Equality operator)

>>> client=ldapclient.LDAPClient()
>>> a=LDAPEntry(client=client,
...             dn='dc=example,dc=com')
>>> b=LDAPEntry(client=client,
...             dn='dc=example,dc=com')
>>> a==b
1

>>> c=LDAPEntry(client=ldapclient.LDAPClient(),
...             dn='ou=different,dc=example,dc=com')
>>> a==c
0

>>> anotherClient=ldapclient.LDAPClient()
>>> d=LDAPEntry(client=anotherClient,
...             dn='dc=example,dc=com')
>>> a==d
1

__getitem__(self, key)
(Indexing operator)

>>> o=LDAPEntry(client=ldapclient.LDAPClient(),
...     dn='cn=foo,dc=example,dc=com',
...     attributes={'anAttribute': ['itsValue']})
>>> o['anAttribute']
['itsValue']

__ne__(self, other)

__setitem__(self, key, value)
(Index assignment operator)

>>> o=LDAPEntry(client=ldapclient.LDAPClient(),
...     dn='cn=foo,dc=example,dc=com',
...     attributes={'anAttribute': ['itsValue']})
>>> o['anAttribute']=['foo', 'bar']
>>> o['anAttribute']
['bar', 'foo']

__str__(self)
(Informal representation operator)

>>> o=LDAPEntry(client=ldapclient.LDAPClient(),
...     dn='cn=foo,dc=example,dc=com',
...     attributes={'anAttribute': ['itsValue', 'secondValue'],
...     'onemore': ['aValue'],
...     })
>>> # must use rstrip or doctests won't like it due to the empty line
>>> # you can just say "print o"
>>> print str(o).rstrip()
dn: cn=foo,dc=example,dc=com
anAttribute: itsValue
anAttribute: secondValue
onemore: aValue

commit(self)

Returns:

a Deferred that tells you whether the operation succeeded or not. (TODO specify how)

delete(self)

Returns:

A Deferred that will complete when the delete is done.

fetch(self, *attributes)

Returns:

A Deferred that will complete when the operation is done.

get(self, key, default=None)

>>> o=LDAPEntry(client=ldapclient.LDAPClient(),
...     dn='cn=foo,dc=example,dc=com',
...     attributes={'anAttribute': ['itsValue']})
>>> o.get('anAttribute')
['itsValue']

>>> o.get('foo')
>>> o.get('foo', [])
[]

journal(self, journalOperation)

Add an LDAPJournalOperation into the list of modifications that need to be flushed to the LDAP server.

move(self, newDN)

Parameters:

newDN - the new DistinguishedName

Returns:

A Deferred that will complete when the move is done.

namingContext(self)

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

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.

setPassword(self, newPasswd)

Parameters:

newPasswd - A string containing the new password.

Returns:

A Deferred that will complete when the operation is done.

setPassword_ExtendedOperation(self, newPasswd)

Parameters:

newPasswd - A string containing the new password.

Returns:

A Deferred that will complete when the operation is done.

setPassword_Samba(self, newPasswd)

Parameters:

newPasswd - A string containing the new password.

Returns:

A Deferred that will complete when the operation is done.

setPasswordMaybe_ExtendedOperation(self, newPasswd)

Parameters:

newPasswd - A string containing the new password.

Returns:

A Deferred that will complete when the operation is done.

setPasswordMaybe_Samba(self, newPasswd)

Parameters:

newPasswd - A string containing the new password.

Returns:

A Deferred that will complete when the operation is done.

undo(self)