summaryrefslogtreecommitdiff
path: root/repoze/bfg/interfaces.py
blob: 710b910745acaeffc544bbf6db27632aab69f560 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
from zope.interface import Interface
from zope.interface import Attribute

class IRequest(Interface):
    """ Marker interface for a request object """
    
class IResponse(Interface):
    status = Attribute('WSGI status code of response')
    headerlist = Attribute('List of response headers')
    app_iter = Attribute('Iterable representing the response body')

class IView(Interface):
    def __call__(context, request):
        """ Must return an object that implements IResponse """

class IRootPolicy(Interface):
    def __call__(environ):
        """ Return a root object """

class ITraverser(Interface):
    def __call__(path):
        """ Return a tuple in the form (context, name, subpath), typically
        the result of an object graph traversal """

class ITraverserFactory(Interface):
    def __call__(context, request):
        """ Return an object that implements IPublishTraverser """

class ITemplateFactory(Interface):
    def __call__(path):
        """ Return an an ITemplate given a filesystem path """

class ITemplate(Interface):
    def __call__(**kw):
        """ Return a string result given a template path """

class INodeTemplate(Interface):
    def __call__(node, **kw):
        """ Return a string result given a template path """
        
class ISecurityPolicy(Interface):
    """ A utility that provides a mechanism to check authorization
       using authentication data """
    def permits(context, request, permission):
        """ Returns True if the combination of the authorization
            information in the context and the authentication data in
            the request allow the action implied by the permission """

class NoAuthorizationInformation(Exception):
    pass

class IViewPermission(Interface):
    def __call__(security_policy):
        """ Return True if the permission allows, return False if it denies. """

class IViewPermissionFactory(Interface):
    def __call__(context, request):
        """ Return an IViewPermission """