ldap.controls High-level access to LDAP controls

The ldap.controls module defines the following classes:

class ldap.controls.LDAPControl(controlType, criticality[, controlValue=:const:`None`[, encodedControlValue=:const:`None`]])

Base class for all LDAP controls. This class should not be used directly, instead one of the following subclasses should be used as appropriate.

encodeControlValue(value)

Dummy method to be overridden by subclasses.

decodeControlValue(value)

Dummy method to be overridden by subclasses.

getEncodedTuple()

Return a readily encoded 3-tuple which can be directly passed to C module _ldap. This method is called by function ldap.EncodeControlTuples().

class ldap.controls.BooleanControl(controlType, criticality[, controlValue=:const:`None`[, encodedControlValue=:const:`None`]])

Base class for simple controls with booelan control value. In this base class controlValue has to be passed as boolean type (True/False or 1/0).

class ldap.controls.SimplePagedResultsControl(controlType, criticality[, controlValue=:const:`None`[, encodedControlValue=:const:`None`]])

The class provides the LDAP Control Extension for Simple Paged Results Manipulation. controlType is ignored in favor of ldap.LDAP_CONTROL_PAGE_OID.

See also

RFC 2696 - LDAP Control Extension for Simple Paged Results Manipulation

class ldap.controls.MatchedValuesControl(criticality[, controlValue=:const:`None`])

This class provides the LDAP Matched Values control. controlValue is an LDAP filter.

See also

RFC 3876 - Returning Matched Values with the Lightweight Directory Access Protocol version 3 (LDAPv3)

The ldap.controls module defines the following functions:

ldap.controls.EncodeControlTuples(ldapControls)

Returns list of readily encoded 3-tuples which can be directly passed to C module _ldap.

ldap.controls.DecodeControlTuples(ldapControlTuples)

Decodes a list of readily encoded 3-tuples as returned by the C module _ldap.