summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorTres Seaver <tseaver@palladion.com>2012-12-23 20:54:01 +0000
committerTres Seaver <tseaver@palladion.com>2012-12-23 20:54:01 +0000
commit9f1faae693fc91ca97f2b3caf4e48fd3e62e2635 (patch)
tree7a22900886f66a9de888e2d0b3557a2d72f21f85 /docs/api
parent0990b869b1f5fff0d130d539ce9623b935fa66d9 (diff)
downloadzope-security-9f1faae693fc91ca97f2b3caf4e48fd3e62e2635.tar.gz
Refactor to allow room for other API docs.
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/interfaces.rst101
1 files changed, 101 insertions, 0 deletions
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst
new file mode 100644
index 0000000..9d3e96e
--- /dev/null
+++ b/docs/api/interfaces.rst
@@ -0,0 +1,101 @@
+:mod:`zope.security` API Revference
+===================================
+
+:mod:`zope.security.interfaces`
+-------------------------------
+
+.. automodule:: zope.security.interfaces
+
+Exceptions
+##########
+
+ .. autointerface:: IUnauthorized
+ :members:
+ :member-order: bysource
+
+ .. autoexception:: Unauthorized
+
+ .. autointerface:: IForbidden
+ :members:
+ :member-order: bysource
+
+ .. autoexception:: Forbidden
+
+ .. autointerface:: IForbiddenAttribute
+ :members:
+ :member-order: bysource
+
+ .. autoexception:: ForbiddenAttribute
+
+Utilities
+##########
+
+ .. autointerface:: ISecurityManagement
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: ISecurityChecking
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: ISecurityProxyFactory
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: IChecker
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: INameBasedChecker
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: ISecurityPolicy
+ :members:
+ :member-order: bysource
+
+Principals
+##########
+
+ .. autointerface:: IInteraction
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: IParticipation
+ :members:
+ :member-order: bysource
+
+ .. autoexception:: NoInteraction
+
+ .. autointerface:: IInteractionManagement
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: IPrincipal
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: IGroupAwarePrincipal
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: IGroupClosureAwarePrincipal
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: IGroup
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: IMemberGetterGroup
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: IMemberAwareGroup
+ :members:
+ :member-order: bysource
+
+ .. autointerface:: IPermission
+ :members:
+ :member-order: bysource
+