From b4be8404755924e3b88594c7f47bc86ca6185319 Mon Sep 17 00:00:00 2001 From: stroeder Date: Thu, 9 Aug 2012 07:19:30 +0000 Subject: [PATCH] Fixed class names --- Doc/ldap-controls.rst | 211 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 211 insertions(+) create mode 100644 Doc/ldap-controls.rst diff --git a/Doc/ldap-controls.rst b/Doc/ldap-controls.rst new file mode 100644 index 0000000..00266e6 --- /dev/null +++ b/Doc/ldap-controls.rst @@ -0,0 +1,211 @@ +.. % $Id: ldap-controls.rst,v 1.11 2012/08/09 07:19:30 stroeder Exp $ + + +********************************************************************* +:py:mod:`ldap.controls` High-level access to LDAPv3 extended controls +********************************************************************* + +.. py:module:: ldap.controls + :synopsis: High-level access to LDAPv3 extended controls. +.. moduleauthor:: python-ldap project (see http://www.python-ldap.org/) + + +Variables +========= + +.. py:data:: KNOWN_RESPONSE_CONTROLS + + Dictionary mapping the OIDs of known response controls to the accompanying + :py:class:`ResponseControl` classes. This is used + by :py:func:`DecodeControlTuples` to automatically decode control values. + Calling application can also register their custom :py:class:`ResponseControl` + classes in this dictionary possibly overriding pre-registered classes. + + +Classes +======= + +This module defines the following classes: + + +.. autoclass:: ldap.controls.RequestControl + :members: + +.. autoclass:: ldap.controls.ResponseControl + :members: + +.. autoclass:: ldap.controls.LDAPControl + :members: + + +Functions +========= + +This module defines the following functions: + + +.. autofunction:: ldap.controls.RequestControlTuples + +.. autofunction:: ldap.controls.DecodeControlTuples + + +Sub-modules +=========== + +Various sub-modules implement specific LDAPv3 extended controls. The classes +therein are derived from the base-classes :py:class:`ldap.controls.RequestControl`, +:py:class:`ldap.controls.ResponseControl` or :py:class:`ldap.controls.LDAPControl`. + +Some of them require :py:mod:`pyasn1` and :py:mod:`pyasn1_modules` to be installed: + +Usually the names of the method arguments and the class attributes match +the ASN.1 identifiers used in the specification. So looking at the referenced +RFC or Internet-Draft is very helpful to understand the API. + + +:py:mod:`ldap.controls.simple` Very simple controls +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. py:module:: ldap.controls.simple + :synopsis: simple request and response controls implemented in pure Python + + +.. autoclass:: ldap.controls.simple.ValueLessRequestControl + :members: + +.. autoclass:: ldap.controls.simple.OctetStringInteger + :members: + +.. autoclass:: ldap.controls.simple.BooleanControl + :members: + +.. autoclass:: ldap.controls.simple.ManageDSAITControl + :members: + + .. seealso:: + + :rfc:`3296` - Named Subordinate References in Lightweight Directory Access Protocol (LDAP) Directories + +.. autoclass:: ldap.controls.simple.RelaxRulesControl + :members: + + .. seealso:: + + http://tools.ietf.org/draft/draft-zeilenga-ldap-relax/ + +.. autoclass:: ldap.controls.simple.ProxyAuthzControl + :members: + + .. seealso:: + + :rfc:`4370` - Lightweight Directory Access Protocol (LDAP): Proxied Authorization Control + +.. autoclass:: ldap.controls.simple.AuthorizationIdentityRequestControl + :members: + + .. seealso:: + + :rfc:`3829` - Lightweight Directory Access Protocol (LDAP): Authorization Identity Request and Response Controls + +.. autoclass:: ldap.controls.simple.AuthorizationIdentityResponseControl + :members: + + .. seealso:: + + :rfc:`3829` - Lightweight Directory Access Protocol (LDAP): Authorization Identity Request and Response Controls + +.. autoclass:: ldap.controls.simple.GetEffectiveRightsControl + :members: + + + +:py:mod:`ldap.controls.libldap` Various controls implemented in OpenLDAP libs +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +.. py:module:: ldap.controls.libldap + :synopsis: request and response controls implemented by OpenLDAP libs + +This module wraps C functions in OpenLDAP client libs which implement various +request and response controls into Python classes. + + +.. autoclass:: ldap.controls.libldap.AssertionControl + :members: + + .. seealso:: + + :rfc:`4528` - Lightweight Directory Access Protocol (LDAP) Assertion Control + + +.. autoclass:: ldap.controls.libldap.MatchedValuesControl + :members: + + .. seealso:: + + :rfc:`3876` - Returning Matched Values with the Lightweight Directory Access Protocol version 3 (LDAPv3) + + +.. autoclass:: ldap.controls.libldap.SimplePagedResultsControl + :members: + + .. seealso:: + + :rfc:`2696` - LDAP Control Extension for Simple Paged Results Manipulation + + +:py:mod:`ldap.controls.psearch` LDAP Persistent Search +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. py:module:: ldap.controls.psearch + :synopsis: request and response controls for LDAP persistent search + +This module implements request and response controls for LDAP persistent +search. + +.. seealso:: + + http://tools.ietf.org/html/draft-ietf-ldapext-psearch + + +.. autoclass:: ldap.controls.psearch.PersistentSearchControl + :members: + +.. autoclass:: ldap.controls.psearch.EntryChangeNotificationControl + :members: + + +:py:mod:`ldap.controls.sessiontrack` Session tracking control +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. py:module:: ldap.controls.sessiontrack + :synopsis: request control for session tracking + +.. seealso:: + + http://tools.ietf.org/html/draft-wahl-ldap-session + + +.. autoclass:: ldap.controls.sessiontrack.SessionTrackingControl + :members: + + +:py:mod:`ldap.controls.readentry` Read entry control +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. py:module:: ldap.controls.readentry + :synopsis: read entryrequest and response controls + +.. seealso:: + + :rfc:`4527` - Lightweight Directory Access Protocol (LDAP): Read Entry Controls + + +.. autoclass:: ldap.controls.readentry.ReadEntryControl + :members: + +.. autoclass:: ldap.controls.readentry.PreReadControl + :members: + +.. autoclass:: ldap.controls.readentry.PostReadControl + :members: