9c2b15247e
Implmenting claim messages and delete messages necessitated a refactoring of the proxy interfaces. They were ugly and cumbersome. The information was pushed into the objects. This comes at the expense of a bit of validation when creating messages but it's minor. The new design is more in tune with the hypermedia nature of the Message Service API. Before I was fighting against it, trying to parse out ids. That's a recipe for brittle code. Much better to make use of the hrefs as they're intended to be used. Change-Id: Ib14632a2a05539eae060771f46e0a313a652903f
105 lines
3.5 KiB
Python
105 lines
3.5 KiB
Python
# 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 copy
|
|
import json
|
|
|
|
from six.moves.urllib import parse
|
|
|
|
from openstack.message import message_service
|
|
from openstack import resource
|
|
|
|
|
|
class Message(resource.Resource):
|
|
resources_key = 'messages'
|
|
base_path = "/queues/%(queue_name)s/messages"
|
|
service = message_service.MessageService()
|
|
|
|
# capabilities
|
|
allow_create = True
|
|
allow_list = False
|
|
allow_retrieve = False
|
|
allow_delete = False
|
|
|
|
#: A UUID for each client instance. The UUID must be submitted in its
|
|
#: canonical form (for example, 3381af92-2b9e-11e3-b191-71861300734c).
|
|
#: The client generates this UUID once. The client UUID persists between
|
|
#: restarts of the client so the client should reuse that same UUID.
|
|
#: All message-related operations require the use of the client UUID in
|
|
#: the headers to ensure that messages are not echoed back to the client
|
|
#: that posted them, unless the client explicitly requests this.
|
|
client = None
|
|
|
|
#: The queue this Message belongs to.
|
|
queue = None
|
|
|
|
#: A relative href that references this Message.
|
|
href = resource.prop("href")
|
|
|
|
#: An arbitrary JSON document that constitutes the body of the message
|
|
#: being sent.
|
|
body = resource.prop("body")
|
|
|
|
#: Specifies how long the server waits, in seconds, before marking the
|
|
#: message as expired and removing it from the queue.
|
|
ttl = resource.prop("ttl")
|
|
|
|
#: Specifies how long the message has been in the queue, in seconds.
|
|
age = resource.prop("age")
|
|
|
|
@classmethod
|
|
def create_messages(cls, session, messages):
|
|
if len(messages) == 0:
|
|
raise ValueError('messages cannot be empty')
|
|
|
|
for i, message in enumerate(messages, -1):
|
|
if message.queue != messages[i].queue:
|
|
raise ValueError('All queues in messages must be equal')
|
|
if message.client != messages[i].client:
|
|
raise ValueError('All clients in messages must be equal')
|
|
|
|
url = cls._get_url({'queue_name': messages[0].queue})
|
|
headers = {'Client-ID': messages[0].client}
|
|
|
|
resp = session.post(url, service=cls.service, headers=headers,
|
|
data=json.dumps(messages, cls=MessageEncoder))
|
|
|
|
messages_deepcopy = copy.deepcopy(messages)
|
|
hrefs = resp.body['resources']
|
|
|
|
for i, href in enumerate(hrefs):
|
|
messages_deepcopy[i].href = href
|
|
|
|
return messages_deepcopy
|
|
|
|
@classmethod
|
|
def _strip_version(cls, href):
|
|
path = parse.urlparse(href).path
|
|
|
|
if path.startswith('/v'):
|
|
return href[href.find('/', 1):]
|
|
else:
|
|
return href
|
|
|
|
@classmethod
|
|
def delete_by_id(cls, session, message, path_args=None):
|
|
url = cls._strip_version(message.href)
|
|
headers = {'Client-ID': message.client}
|
|
|
|
session.delete(url, service=cls.service,
|
|
headers=headers, accept=None)
|
|
|
|
|
|
class MessageEncoder(json.JSONEncoder):
|
|
def default(self, message):
|
|
return {'body': message.body, 'ttl': message.ttl}
|