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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
# 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.
import uuid
from openstack import resource
class Claim(resource.Resource):
# FIXME(anyone): The name string of `location` field of Zaqar API response
# is lower case. That is inconsistent with the guide from API-WG. This is
# a workaround for this issue.
location = resource.Header("location")
resources_key = 'claims'
base_path = '/queues/%(queue_name)s/claims'
# capabilities
allow_create = True
allow_fetch = True
allow_commit = True
allow_delete = True
commit_method = 'PATCH'
# Properties
#: The value in seconds indicating how long the claim has existed.
age = resource.Body("age")
#: In case worker stops responding for a long time, the server will
#: extend the lifetime of claimed messages to be at least as long as
#: the lifetime of the claim itself, plus the specified grace period.
#: Must between 60 and 43200 seconds(12 hours).
grace = resource.Body("grace")
#: The number of messages to claim. Default 10, up to 20.
limit = resource.Body("limit")
#: Messages have been successfully claimed.
messages = resource.Body("messages")
#: Number of seconds the server wait before releasing the claim. Must
#: between 60 and 43200 seconds(12 hours).
ttl = resource.Body("ttl")
#: The name of queue to claim message from.
queue_name = resource.URI("queue_name")
#: The ID to identify the client accessing Zaqar API. Must be specified
#: in header for each API request.
client_id = resource.Header("Client-ID")
#: The ID to identify the project. Must be provided when keystone
#: authentication is not enabled in Zaqar service.
project_id = resource.Header("X-PROJECT-ID")
def _translate_response(
self,
response,
has_body=None,
error_message=None,
*,
resource_response_key=None,
):
super()._translate_response(
response,
has_body,
error_message,
resource_response_key=resource_response_key,
)
if has_body and self.location:
# Extract claim ID from location
self.id = self.location.split("claims/")[1]
def create(self, session, prepend_key=False, base_path=None, **kwargs):
request = self._prepare_request(
requires_id=False, prepend_key=prepend_key, base_path=base_path
)
headers = {
"Client-ID": self.client_id or str(uuid.uuid4()),
"X-PROJECT-ID": self.project_id or session.get_project_id(),
}
request.headers.update(headers)
response = session.post(
request.url, json=request.body, headers=request.headers
)
# For case no message was claimed successfully, 204 No Content
# message will be returned. In other cases, we translate response
# body which has `messages` field(list) included.
if response.status_code != 204:
self._translate_response(response)
return self
def fetch(
self,
session,
requires_id=True,
base_path=None,
error_message=None,
skip_cache=False,
**kwargs,
):
request = self._prepare_request(
requires_id=requires_id, base_path=base_path
)
headers = {
"Client-ID": self.client_id or str(uuid.uuid4()),
"X-PROJECT-ID": self.project_id or session.get_project_id(),
}
request.headers.update(headers)
response = session.get(
request.url, headers=request.headers, skip_cache=False
)
self._translate_response(response)
return self
def commit(
self,
session,
prepend_key=True,
has_body=True,
retry_on_conflict=None,
base_path=None,
**kwargs,
):
request = self._prepare_request(
prepend_key=prepend_key, base_path=base_path
)
headers = {
"Client-ID": self.client_id or str(uuid.uuid4()),
"X-PROJECT-ID": self.project_id or session.get_project_id(),
}
request.headers.update(headers)
session.patch(request.url, json=request.body, headers=request.headers)
return self
def delete(self, session, *args, **kwargs):
request = self._prepare_request()
headers = {
"Client-ID": self.client_id or str(uuid.uuid4()),
"X-PROJECT-ID": self.project_id or session.get_project_id(),
}
request.headers.update(headers)
response = session.delete(request.url, headers=request.headers)
self._translate_response(response, has_body=False)
return self
|
