summaryrefslogtreecommitdiff
path: root/keystoneclient/v3/groups.py
blob: 843ad00289954632aad770852597edd1e180db65 (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# Copyright 2011 OpenStack Foundation
# Copyright 2011 Nebula, 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.

from keystoneclient import base


class Group(base.Resource):
    """Represents an Identity user group.

    Attributes:
        * id: a uuid that identifies the group
        * name: group name
        * description: group description

    """

    def update(self, name=None, description=None):
        kwargs = {
            'name': name if name is not None else self.name,
            'description': (description
                            if description is not None
                            else self.description),
        }

        try:
            retval = self.manager.update(self.id, **kwargs)
            self = retval
        except Exception:
            retval = None

        return retval


class GroupManager(base.CrudManager):
    """Manager class for manipulating Identity groups."""

    resource_class = Group
    collection_key = 'groups'
    key = 'group'

    def create(self, name, domain=None, description=None, **kwargs):
        """Create a group.

        :param str name: the name of the group.
        :param domain: the domain of the group.
        :type domain: str or :class:`keystoneclient.v3.domains.Domain`
        :param str description: a description of the group.
        :param kwargs: any other attribute provided will be passed to the
                       server.

        :returns: the created group returned from server.
        :rtype: :class:`keystoneclient.v3.groups.Group`

        """
        return super(GroupManager, self).create(
            name=name,
            domain_id=base.getid(domain),
            description=description,
            **kwargs)

    def list(self, user=None, domain=None, **kwargs):
        """List groups.

        :param user: the user of the groups to be filtered on.
        :type user: str or :class:`keystoneclient.v3.users.User`
        :param domain: the domain of the groups to be filtered on.
        :type domain: str or :class:`keystoneclient.v3.domains.Domain`
        :param kwargs: any other attribute provided will filter groups on.

        :returns: a list of groups.
        :rtype: list of :class:`keystoneclient.v3.groups.Group`.

        """
        if user:
            base_url = '/users/%s' % base.getid(user)
        else:
            base_url = None
        return super(GroupManager, self).list(
            base_url=base_url,
            domain_id=base.getid(domain),
            **kwargs)

    def get(self, group):
        """Retrieve a group.

        :param group: the group to be retrieved from the server.
        :type group: str or :class:`keystoneclient.v3.groups.Group`

        :returns: the specified group returned from server.
        :rtype: :class:`keystoneclient.v3.groups.Group`

        """
        return super(GroupManager, self).get(
            group_id=base.getid(group))

    def update(self, group, name=None, description=None, **kwargs):
        """Update a group.

        :param group: the group to be updated on the server.
        :type group: str or :class:`keystoneclient.v3.groups.Group`
        :param str name: the new name of the group.
        :param str description: the new description of the group.
        :param kwargs: any other attribute provided will be passed to server.

        :returns: the updated group returned from server.
        :rtype: :class:`keystoneclient.v3.groups.Group`

        """
        return super(GroupManager, self).update(
            group_id=base.getid(group),
            name=name,
            description=description,
            **kwargs)

    def delete(self, group):
        """Delete a group.

        :param group: the group to be deleted on the server.
        :type group: str or :class:`keystoneclient.v3.groups.Group`

        :returns: Response object with 204 status.
        :rtype: :class:`requests.models.Response`

        """
        return super(GroupManager, self).delete(
            group_id=base.getid(group))