~launchpad-pqm/launchpad/devel

« back to all changes in this revision

Viewing changes to lib/lp/registry/interfaces/accesspolicy.py

  • Committer: Launchpad Patch Queue Manager
  • Date: 2011-11-21 23:18:40 UTC
  • mfrom: (14186.6.43 observer-model)
  • Revision ID: launchpad@pqm.canonical.com-20111121231840-jek6hufhmc2q0f2g
[r=sinzui][no-qa] Initial model work for access policies.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright 2011 Canonical Ltd.  This software is licensed under the
 
2
# GNU Affero General Public License version 3 (see the file LICENSE).
 
3
 
 
4
"""Interfaces for pillar and artifact access policies."""
 
5
 
 
6
__metaclass__ = type
 
7
 
 
8
__all__ = [
 
9
    'AccessPolicyType',
 
10
    'IAccessPolicy',
 
11
    'IAccessPolicyArtifact',
 
12
    'IAccessPolicyArtifactSource',
 
13
    'IAccessPolicyGrant',
 
14
    'IAccessPolicySource',
 
15
    ]
 
16
 
 
17
from lazr.enum import (
 
18
    DBEnumeratedType,
 
19
    DBItem,
 
20
    )
 
21
from zope.interface import (
 
22
    Attribute,
 
23
    Interface,
 
24
    )
 
25
 
 
26
 
 
27
class AccessPolicyType(DBEnumeratedType):
 
28
    """Access policy type."""
 
29
 
 
30
    PRIVATE = DBItem(1, """
 
31
        Private
 
32
 
 
33
        This policy covers general private information.
 
34
        """)
 
35
 
 
36
    SECURITY = DBItem(2, """
 
37
        Security
 
38
 
 
39
        This policy covers information relating to confidential security
 
40
        vulnerabilities.
 
41
        """)
 
42
 
 
43
 
 
44
class IAccessPolicy(Interface):
 
45
    id = Attribute("ID")
 
46
    pillar = Attribute("Pillar")
 
47
    type = Attribute("Type")
 
48
 
 
49
 
 
50
class IAccessPolicyArtifact(Interface):
 
51
    id = Attribute("ID")
 
52
    concrete_artifact = Attribute("Concrete artifact")
 
53
    policy = Attribute("Access policy")
 
54
 
 
55
 
 
56
class IAccessPolicyGrant(Interface):
 
57
    id = Attribute("ID")
 
58
    grantee = Attribute("Grantee")
 
59
    grantor = Attribute("Grantor")
 
60
    date_created = Attribute("Date created")
 
61
    policy = Attribute("Access policy")
 
62
    abstract_artifact = Attribute("Abstract artifact")
 
63
 
 
64
    concrete_artifact = Attribute("Concrete artifact")
 
65
 
 
66
 
 
67
class IAccessPolicySource(Interface):
 
68
 
 
69
    def create(pillar, display_name):
 
70
        """Create an `IAccessPolicy` for the pillar with the given name."""
 
71
 
 
72
    def getByID(id):
 
73
        """Return the `IAccessPolicy` with the given ID."""
 
74
 
 
75
    def getByPillarAndType(pillar, type):
 
76
        """Return the pillar's `IAccessPolicy` with the given type."""
 
77
 
 
78
    def findByPillar(pillar):
 
79
        """Return a ResultSet of all `IAccessPolicy`s for the pillar."""
 
80
 
 
81
 
 
82
class IAccessPolicyArtifactSource(Interface):
 
83
 
 
84
    def ensure(concrete_artifact):
 
85
        """Return the `IAccessPolicyArtifact` for a concrete artifact.
 
86
 
 
87
        Creates the abstract artifact if it doesn't already exist.
 
88
        """
 
89
 
 
90
    def get(concrete_artifact):
 
91
        """Return the `IAccessPolicyArtifact` for an artifact, if it exists.
 
92
 
 
93
        Use ensure() if you want to create one if it doesn't yet exist.
 
94
        """
 
95
 
 
96
    def delete(concrete_artifact):
 
97
        """Delete the `IAccessPolicyArtifact` for a concrete artifact.
 
98
 
 
99
        Also removes any AccessPolicyGrants for the artifact.
 
100
        """
 
101
 
 
102
 
 
103
class IAccessPolicyGrantSource(Interface):
 
104
 
 
105
    def grant(grantee, grantor, object):
 
106
        """Create an `IAccessPolicyGrant`.
 
107
 
 
108
        :param grantee: the `IPerson` to hold the access.
 
109
        :param grantor: the `IPerson` that grants the access.
 
110
        :param object: the `IAccessPolicy` or `IAccessPolicyArtifact` to
 
111
            grant access to.
 
112
        """
 
113
 
 
114
    def getByID(id):
 
115
        """Return the `IAccessPolicyGrant` with the given ID."""
 
116
 
 
117
    def findByPolicy(policy):
 
118
        """Return all `IAccessPolicyGrant` objects for the policy."""