ldaptor.protocols.ldap.ldapclient.LDAPClient

class documentation

class LDAPClient(protocol.Protocol): (source)

Known subclasses: ldaptor._scripts.ldap2pdns.MyLDAPClient, ldaptor._scripts.namingcontexts.Search, ldaptor._scripts.passwd.PasswdClient

View In Hierarchy

An LDAP client

Method __init__ Undocumented
Method bind @depreciated: Use e.bind(auth).
Method connectionLost Called when TCP connection has been lost
Method connectionMade TCP connection has opened
Method dataReceived Undocumented
Method handle Undocumented
Method send Send an LDAP operation to the server. @param op: the operation to send @type op: LDAPProtocolRequest @param controls: Any controls to be included in the request. @type controls: LDAPControls @return: the response from server @rtype: Deferred LDAPProtocolResponse...
Method send_multiResponse Send an LDAP operation to the server, expecting one or more responses.
Method send_multiResponse_ex Send an LDAP operation to the server, expecting one or more responses.
Method send_noResponse Send an LDAP operation to the server, with no response expected.
Method startTLS Start Transport Layer Security.
Method unbind Undocumented
Method unsolicitedNotification Undocumented
Class Variable berdecoder Undocumented
Class Variable debug Undocumented
Instance Variable buffer Undocumented
Instance Variable connected Undocumented
Instance Variable onwire Undocumented
Method _cbStartTLS Undocumented
Method _handle_bind_msg Undocumented
Method _send Undocumented
Method _startTLS Undocumented
def __init__(self): (source)
overridden in ldaptor._scripts.ldap2pdns.MyLDAPClient

Undocumented

def bind(self, dn='', auth=''): (source)

@depreciated: Use e.bind(auth). @todo: Remove this method when there are no callers.

def connectionLost(self, reason=protocol.connectionDone): (source)
overridden in ldaptor._scripts.ldap2pdns.MyLDAPClient

Called when TCP connection has been lost

def connectionMade(self): (source)
overridden in ldaptor._scripts.namingcontexts.Search, ldaptor._scripts.passwd.PasswdClient

TCP connection has opened

def dataReceived(self, recd): (source)

Undocumented

def handle(self, msg): (source)

Undocumented

def send(self, op, controls=None): (source)

Send an LDAP operation to the server. @param op: the operation to send @type op: LDAPProtocolRequest @param controls: Any controls to be included in the request. @type controls: LDAPControls @return: the response from server @rtype: Deferred LDAPProtocolResponse

def send_multiResponse(self, op, handler, *args, **kwargs): (source)

Send an LDAP operation to the server, expecting one or more responses. If `handler` is provided, it will receive a LDAP response as its first argument. The Deferred returned by this function will never fire. If `handler` is not provided, the Deferred returned by this function will fire with the final LDAP response. @param op: the operation to send @type op: LDAPProtocolRequest @param handler: a callable that will be called for each response. It should return a boolean, whether this was the final response. @param args: positional arguments to pass to handler @param kwargs: keyword arguments to pass to handler @return: the result from the first handler as a deferred that completes when the first response has been received @rtype: Deferred LDAPProtocolResponse

def send_multiResponse_ex(self, op, controls=None, handler=None, *args, **kwargs): (source)

Send an LDAP operation to the server, expecting one or more responses. If `handler` is provided, it will receive a LDAP response *and* response controls as its first 2 arguments. The Deferred returned by this function will never fire. If `handler` is not provided, the Deferred returned by this function will fire with a tuple of the first LDAP response and any associated response controls. @param op: the operation to send @type op: LDAPProtocolRequest @param controls: LDAP controls to send with the message. @type controls: LDAPControls @param handler: a callable that will be called for each response. It should return a boolean, whether this was the final response. @param args: positional arguments to pass to handler @param kwargs: keyword arguments to pass to handler @return: the result from the last handler as a deferred that completes when the last response has been received @rtype: Deferred LDAPProtocolResponse

def send_noResponse(self, op, controls=None): (source)

Send an LDAP operation to the server, with no response expected. @param op: the operation to send @type op: LDAPProtocolRequest

def startTLS(self, ctx=None): (source)

Start Transport Layer Security. It is the callers responsibility to make sure other things are not happening at the same time. @todo: server hostname check, see rfc2830 section 3.6. @return: a deferred that will complete when the TLS handshake is complete.

def unbind(self): (source)

Undocumented

def unsolicitedNotification(self, msg): (source)

Undocumented

berdecoder = (source)

Undocumented

debug: bool = (source)

Undocumented

buffer = (source)

Undocumented

connected: int = (source)

Undocumented

onwire: dict = (source)

Undocumented

def _cbStartTLS(self, msg, ctx): (source)

Undocumented

def _handle_bind_msg(self, msg): (source)

Undocumented

def _send(self, op, controls=None): (source)

Undocumented

def _startTLS(self, ctx): (source)

Undocumented