paula.authutil/src/paula/authutil/interfaces.py

   1 # Copyright (c) 2008 by Florian Friesdorf
   2 #
   3 # GNU Affero General Public License (AGPL)
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU Affero General Public License as
   7 # published by the Free Software Foundation; either version 3 of the
   8 # License, or (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU Affero General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Affero General Public
  16 # License along with this program.  If not, see
  17 # <http://www.gnu.org/licenses/>.
  18 """
  19 """
  20 __author__ = "Florian Friesdorf <flo@chaoflow.net>"
  21 __docformat__ = "plaintext"
  22
  23 from zope.interface import Interface
  24
  25 from paula.authentication.interfaces import IAuthProviders
  26
  27
  28 class PrincipalIdAlreadyTaken(Exception):
  29     """Indicates that a principal with the same id is already registered
  30     """
  31
  32 class IAuthProviderAdaptable(Interface):
  33     """Marker interface for objects that can be adapted to IAuthProvider
  34     """
  35
  36 class IRWAuthProviders(IAuthProviders):
  37     """A IAuthProviders where objects can be registered/unregistered.
  38     """
  39
  40     def register(obj):
  41         """Register an object
  42
  43         It is assumed that the object provides IAuthProviderAdaptable and
  44         an adapter for IAuthProvider is available, an AdaptationError is
  45         raised otherwise.
  46
  47         Fails with PrincipalIdAlreadyTaken, in case an object with the same
  48         principal id is registered already.
  49         """
  50
  51     def unregister(obj):
  52         """Unregister an object.
  53
  54         Fails with KeyError, if the object is not registered.
  55         """