Bug 48111 - add section about new listener module API to developer documentation
add section about new listener module API to developer documentation
Status: CLOSED FIXED
Product: UCS extended documentation
Classification: Unclassified
Component: Developer documentation
unspecified
Other Linux
: P5 normal (vote)
: UCS 5.0-0-errata
Assigned To: Philipp Hahn
Daniel Tröder
:
Depends on: 44786
Blocks:
  Show dependency treegraph
 
Reported: 2018-11-07 11:34 CET by Daniel Tröder
Modified: 2021-11-22 13:13 CET (History)
6 users (show)

See Also:
What kind of report is it?: Bug Report
What type of bug is this?: 2: Improvement: Would be a product improvement
Who will be affected by this bug?: 2: Will only affect a few installed domains
How will those affected feel about the bug?: 2: A Pain – users won’t like this once they notice it
User Pain: 0.046
Enterprise Customer affected?:
School Customer affected?:
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):
Max CVSS v3 score:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Daniel Tröder univentionstaff 2018-11-07 11:34:24 CET
+++ This bug was initially created as a clone of Bug #44786 +++

The new listener module API is already in production use and ISVs regularly ask for documentation how to integrate their products with UCS. The new API is much simpler and should be documented in the UCS developer documentation.

Two starting points:
* https://git.knut.univention.de/univention/ucs/blob/4.3-2/management/univention-directory-listener/README.md
* Examples:
  - https://git.knut.univention.de/univention/ucs/blob/4.3-2/management/univention-directory-listener/examples/listener_module_template.py
  - https://git.knut.univention.de/univention/ucs/blob/4.3-2/management/univention-directory-listener/examples/complex_handler.py
Comment 1 Sönke Schwardt-Krummrich univentionstaff 2021-02-23 17:46:17 CET
Is setdata() also covered by the new API?
Comment 2 Philipp Hahn univentionstaff 2021-11-18 12:18:54 CET
(In reply to Sönke Schwardt-Krummrich from comment #1)
> Is setdata() also covered by the new API?

Yes: The 4 values are collected and stored in self._ldap, which can be retrieved via "self._get_ldap_credentials()" and are already used for property "self.lo" to open an LDAP connection.