Added doc strings to classes

Lib/ldap/controls/libldap.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+"""
+controls.libldap - LDAP controls wrapper classes with en-/decoding done
+by OpenLDAP functions
+
+See http://www.python-ldap.org/ for details.
+
+$Id: libldap.py,v 1.2 2011/07/23 07:42:04 stroeder Exp $
+"""
+
+import _ldap,ldap
+from ldap.controls import RequestControl,LDAPControl,KNOWN_RESPONSE_CONTROLS
+
+
+class AssertionControl(RequestControl):
+  """
+  LDAP Assertion control, as defined in RFC 4528
+
+  filterstr
+    LDAP filter string specifying which assertions have to match
+    so that the server processes the operation
+  """
+  
+  controlType = ldap.CONTROL_ASSERT    
+  def __init__(self,criticality=True,filterstr='(objectClass=*)'):
+    self.criticality = criticality
+    self.filterstr = filterstr
+
+  def encodeControlValue(self):
+    return _ldap.encode_assertion_control(self.filterstr)
+
+KNOWN_RESPONSE_CONTROLS[ldap.CONTROL_ASSERT] = AssertionControl
+
+
+class MatchedValuesControl(RequestControl):
+  """
+  LDAP Matched Values control, as defined in RFC 3876
+
+  filterstr
+    LDAP filter string specifying which attribute values
+    should be returned
+  """
+  
+  controlType = ldap.CONTROL_VALUESRETURNFILTER
+  
+  def __init__(self,criticality=False,filterstr='(objectClass=*)'):
+    self.criticality = criticality
+    self.filterstr = filterstr
+
+  def encodeControlValue(self):
+    return _ldap.encode_valuesreturnfilter_control(self.filterstr)
+
+KNOWN_RESPONSE_CONTROLS[ldap.CONTROL_VALUESRETURNFILTER] = MatchedValuesControl
+
+
+class SimplePagedResultsControl(LDAPControl):
+  """
+  LDAP Control Extension for Simple Paged Results Manipulation
+
+  size
+    Page size requested (number of entries to be returned)
+  cookie
+    Cookie string received with last page
+  """
+  controlType = ldap.CONTROL_PAGEDRESULTS
+
+  def __init__(self,criticality=False,size=None,cookie=None):
+    self.criticality = criticality
+    self.size,self.cookie = size,cookie
+
+  def encodeControlValue(self):
+    return _ldap.encode_page_control(self.size,self.cookie)
+
+  def decodeControlValue(self,encodedControlValue):
+    self.size,self.cookie = _ldap.decode_page_control(encodedControlValue)
+
+KNOWN_RESPONSE_CONTROLS[ldap.CONTROL_PAGEDRESULTS] = SimplePagedResultsControl