[CalendarServer-changes] [10552] CalendarServer/trunk/twext
source_changes at macosforge.org
source_changes at macosforge.org
Fri Jan 25 17:27:18 PST 2013
Revision: 10552
http://trac.calendarserver.org//changeset/10552
Author: wsanchez at apple.com
Date: 2013-01-25 17:27:18 -0800 (Fri, 25 Jan 2013)
Log Message:
-----------
Define new base directory interface.
Added Paths:
-----------
CalendarServer/trunk/twext/who/
CalendarServer/trunk/twext/who/__init__.py
CalendarServer/trunk/twext/who/idirectory.py
Added: CalendarServer/trunk/twext/who/__init__.py
===================================================================
--- CalendarServer/trunk/twext/who/__init__.py (rev 0)
+++ CalendarServer/trunk/twext/who/__init__.py 2013-01-26 01:27:18 UTC (rev 10552)
@@ -0,0 +1,19 @@
+##
+# Copyright (c) 2013 Apple Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+"""
+Directory service integration
+"""
Added: CalendarServer/trunk/twext/who/idirectory.py
===================================================================
--- CalendarServer/trunk/twext/who/idirectory.py (rev 0)
+++ CalendarServer/trunk/twext/who/idirectory.py 2013-01-26 01:27:18 UTC (rev 10552)
@@ -0,0 +1,130 @@
+##
+# Copyright (c) 2006-2013 Apple Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+"""
+Directory service interface.
+"""
+
+__all__ = [
+ "DirectoryServiceError",
+ "FieldName",
+ "MatchType",
+ "QueryFlags",
+ "IDirectoryQueryMatchExpression",
+ "IDirectoryService",
+ "IDirectoryRecord",
+]
+
+from zope.interface import Attribute, Interface
+
+from twisted.python.constants import Names, NamedConstant
+from twisted.python.constants import Flags, FlagConstant
+
+
+
+##
+# Exceptions
+##
+
+class DirectoryServiceError(RuntimeError):
+ """
+ Directory service generic error.
+ """
+
+class QueryNotSupportedError(DirectoryServiceError):
+ """
+ Query not supported.
+ """
+
+
+
+##
+# Constants
+##
+
+class FieldName(Names):
+ """
+ Constants for common field names.
+ """
+ recordType = NamedConstant()
+ shortNames = NamedConstant()
+ uid = NamedConstant()
+ guid = NamedConstant()
+ emailAddresses = NamedConstant()
+
+class MatchType(Names):
+ """
+ Query match types.
+ """
+ equals = NamedConstant()
+ startsWith = NamedConstant()
+ contains = NamedConstant()
+
+class Operand(Names):
+ OR = NamedConstant()
+ AND = NamedConstant()
+
+class QueryFlags(Flags):
+ """
+ Query flags.
+ """
+ caseInsensitive = FlagConstant()
+
+
+
+##
+# Interfaces
+##
+
+class IDirectoryQueryMatchExpression(Interface):
+ """
+ Directory query.
+ """
+ fieldName = Attribute("A L{Field}.")
+ fieldValue = Attribute("A text value to match.")
+ matchType = Attribute("A L{MatchType}.")
+ flags = Attribute("L{QueryFlags}.")
+
+
+
+class IDirectoryService(Interface):
+ """
+ Directory service.
+ """
+ realmName = Attribute("The name of the authentication realm this service represents.")
+
+ def recordTypes():
+ """
+ @return: a deferred iterable of strings denoting the record
+ types that are kept in the directory. For example:
+ C{("users", "groups", "resources")}.
+ """
+
+ def recordFromQuery(expressions, operand=Operand.AND):
+ """
+ @return: a deferred iterable of matching L{IDirectoryRecord}s.
+ @raises: L{QueryNotSupportedError} is the query is not
+ supported by this directory service.
+ """
+
+
+
+class IDirectoryRecord(Interface):
+ """
+ Directory record.
+ """
+ service = Attribute("The L{IDirectoryService} this record exists in.")
+ fields = Attribute("...") # FIXME
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20130125/857701a3/attachment-0001.html>
More information about the calendarserver-changes
mailing list