Package ldaptor :: Package protocols :: Package ldap :: Module ldapsyntax :: Class LDAPEntryWithClient
[hide private]
[frames] | no frames]

Class LDAPEntryWithClient

source code

         object --+        
                  |        
entry.BaseLDAPEntry --+    
                      |    
entry.EditableLDAPEntry --+
                          |
                         LDAPEntryWithClient
Known Subclasses:

Instance Methods [hide private]
 
__init__(self, client, dn, attributes={}, complete=0)
Initialize the object.
source code
 
buildAttributeSet(self, key, values) source code
 
_canRemove(self, key, value)
Called by JournaledLDAPAttributeSet when it is about to remove a value of an attributeType.
source code
 
_canRemoveAll(self, key)
Called by JournaledLDAPAttributeSet when it is about to remove all values of an attributeType.
source code
 
_checkState(self) source code
 
journal(self, journalOperation)
Add a Modification into the list of modifications that need to be flushed to the LDAP server.
source code
 
__getitem__(self, *a, **kw) source code
 
get(self, *a, **kw) source code
 
has_key(self, *a, **kw) source code
 
__contains__(self, key) source code
 
keys(self) source code
 
items(self) source code
 
__str__(self)
str(x)
source code
 
__eq__(self, other) source code
 
__ne__(self, other) source code
 
__len__(self) source code
 
__nonzero__(self) source code
 
bind(self, password) source code
 
_handle_bind_msg(self, msg) source code
 
__setitem__(self, key, value) source code
 
__delitem__(self, key) source code
 
undo(self) source code
 
_commit_success(self, msg) source code
 
commit(self) source code
 
_cbMoveDone(self, msg, newDN) source code
 
move(self, newDN) source code
 
_cbDeleteDone(self, msg) source code
 
delete(self) source code
 
_cbAddDone(self, msg, dn) source code
 
addChild(self, rdn, attributes) source code
 
_cbSetPassword_ExtendedOperation(self, msg) source code
 
setPassword_ExtendedOperation(self, newPasswd)
Set the password on this object.
source code
 
setPasswordMaybe_ExtendedOperation(self, newPasswd)
Set the password on this object.
source code
 
setPassword_Samba(self, newPasswd, style=None)
Set the Samba password on this object.
source code
 
setPasswordMaybe_Samba(self, newPasswd)
Set the Samba password on this object if it is a sambaSamAccount or sambaAccount.
source code
 
_cbSetPassword(self, dl, names) source code
 
_cbSetPassword_one(self, result) source code
 
_ebSetPassword_one(self, fail) source code
 
_setPasswordAll(self, results, newPasswd, prefix, names) source code
 
setPassword(self, newPasswd) source code
 
_cbNamingContext_Entries(self, results) source code
 
namingContext(self) source code
 
_cbFetch(self, results, overWrite) source code
 
fetch(self, *attributes) source code
 
_cbSearchEntry(self, callback, objectName, attributes, complete) source code
 
_cbSearchMsg(self, msg, d, callback, complete, sizeLimitIsNonFatal) source code
 
search(self, filterText=None, filterObject=None, attributes=(), scope=None, derefAliases=None, sizeLimit=0, sizeLimitIsNonFatal=False, timeLimit=0, typesOnly=0, callback=None) source code
 
lookup(self, dn) source code
 
__repr__(self)
repr(x)
source code
 
__provides__(...)
Special descriptor for class __provides__

Inherited from entry.BaseLDAPEntry: __hash__, __providedBy__, diff, hasMember

Inherited from entry.BaseLDAPEntry (private): _bind

Inherited from object: __delattr__, __format__, __getattribute__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]
  _state = 'invalid'
State of an LDAPEntry is one of:
  _setPasswordPriority_ExtendedOperation = 0
hash(x)
  _setPasswordPriority_Samba = 20
hash(x)
  __implemented__ = <implementedBy ldaptor.protocols.ldap.ldapsy...

Inherited from entry.BaseLDAPEntry: dn

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

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

source code 

Initialize the object.

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.
Overrides: object.__init__

buildAttributeSet(self, key, values)

source code 
Overrides: entry.BaseLDAPEntry.buildAttributeSet

journal(self, journalOperation)

source code 

Add a Modification into the list of modifications that need to be flushed to the LDAP server.

Normal callers should not use this, they should use the o['foo']=['bar', 'baz'] -style API that enforces schema, handles errors and updates the cached data.

__getitem__(self, *a, **kw)
(Indexing operator)

source code 
Overrides: entry.BaseLDAPEntry.__getitem__

get(self, *a, **kw)

source code 
Overrides: entry.BaseLDAPEntry.get

has_key(self, *a, **kw)

source code 
Overrides: entry.BaseLDAPEntry.has_key

__contains__(self, key)
(In operator)

source code 
Overrides: entry.BaseLDAPEntry.__contains__

keys(self)

source code 
Overrides: entry.BaseLDAPEntry.keys

items(self)

source code 
Overrides: entry.BaseLDAPEntry.items

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

__eq__(self, other)
(Equality operator)

source code 
Overrides: entry.BaseLDAPEntry.__eq__

__ne__(self, other)

source code 
Overrides: entry.BaseLDAPEntry.__ne__

__len__(self)
(Length operator)

source code 
Overrides: entry.BaseLDAPEntry.__len__

__nonzero__(self)
(Boolean test operator)

source code 
Overrides: entry.BaseLDAPEntry.__nonzero__

bind(self, password)

source code 
Overrides: entry.BaseLDAPEntry.bind

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

source code 
Overrides: entry.EditableLDAPEntry.__setitem__

__delitem__(self, key)
(Index deletion operator)

source code 
Overrides: entry.EditableLDAPEntry.__delitem__

undo(self)

source code 
Overrides: entry.EditableLDAPEntry.undo

commit(self)

source code 
Overrides: entry.EditableLDAPEntry.commit

move(self, newDN)

source code 
Overrides: entry.EditableLDAPEntry.move

delete(self)

source code 
Overrides: entry.EditableLDAPEntry.delete

setPassword_ExtendedOperation(self, newPasswd)

source code 

Set the password on this object.

Parameters:
  • newPasswd - A string containing the new password.
Returns:
A Deferred that will complete when the operation is done.

setPasswordMaybe_ExtendedOperation(self, newPasswd)

source code 

Set the password on this object.

Parameters:
  • newPasswd - A string containing the new password.
Returns:
A Deferred that will complete when the operation is done.

setPassword_Samba(self, newPasswd, style=None)

source code 

Set the Samba password on this object.

Parameters:
  • newPasswd - A string containing the new password.
  • style - one of 'sambaSamAccount', 'sambaAccount' or None. Specifies the style of samba accounts used. None is default and is the same as 'sambaSamAccount'.
Returns:
A Deferred that will complete when the operation is done.

setPasswordMaybe_Samba(self, newPasswd)

source code 

Set the Samba password on this object if it is a sambaSamAccount or sambaAccount.

Parameters:
  • newPasswd - A string containing the new password.
Returns:
A Deferred that will complete when the operation is done.

setPassword(self, newPasswd)

source code 
Overrides: entry.EditableLDAPEntry.setPassword

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

__provides__(...)

 

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

Overrides: entry.BaseLDAPEntry.__provides__

Class Variable Details [hide private]

_state

State of an LDAPEntry is one of:

invalid - object not initialized yet

ready - normal

deleted - object has been deleted

Value:
'invalid'

__implemented__

Value:
<implementedBy ldaptor.protocols.ldap.ldapsyntax.LDAPEntryWithClient>