Changeset 5898

Timestamp:

30 Mar 2011, 16:17:43 (14 years ago)

Author:

uli

Message:

Add an interface for authentication plugins.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/interfaces.py (modified) (1 diff)

main/waeup.sirp/trunk/src/waeup/sirp/interfaces.py

@@ -295 +295 @@
            A standard Python logger for the plugins use.
         """
+
+class IAuthPluginUtility(interface):
+    """A component that cares for authentication setup at site creation.
+
+    Utilities providing this interface are looked up when a Pluggable
+    Authentication Utility (PAU) for any
+    :class:`waeup.sirp.app.University` instance is created and put
+    into ZODB.
+
+    The setup-code then calls the `register` method of the utility and
+    expects a modified (or unmodified) version of the PAU back.
+
+    This allows to define any authentication setup modifications by
+    submodules or third-party modules/packages.
+    """
+
+    def register(pau):
+        """Register any plugins wanted to be in the PAU.
+        """
+
+    def unregister(pau):
+        """Unregister any plugins not wanted to be in the PAU.
+        """