6d0391ceb3
This patch implements methods for every queue operation. The 2
operations left out in this patch are: queue_list and queue_stats.
This patch makes the client, officially, usable as a library. An example
of how this could be use:
client = Client()
queue = client.queue('my_queue') # Creates the queue automatically
queue.metadata() # Get's metadata from the queue
queue.metadata(dict(new_meta='Yo yo!'))
queue.delete()
Metadata was implemented as method instead of as a property to make it
explicit that both get and set do something in the remote server.
The client API was implemented in 2 separate levels. The highest level
is the one shown in the example above, which allows users to just query
Marconi instances without worrying about the transport, request build
process, references, deserealization and what not. The lowest instead,
allows the user to control every bit of the communication process - the
user can pick a specific transport, or pass custom params. For example -
which will make it possible to have other implementations around that
API in addition to the asynchronous support. Example of the API:
transport = http.HttpTransport(cfg.CONF)
request = request.prepare_request(cfg.CONF,
endpoint='http://localhost:8888')
core.queue_create(transport, request, 1, callback=my_callback)
There are tons of things to do and improve. For example:
* The way config params are registered may work when using
marconiclient as a library but they won't when using it as a CLI
tool.
* This code lacks of logging.
* Handling of 20(1|4) is missing.
Partially-Implements blueprint python-marconiclient-v1
Implements blueprint queues-management
Change-Id: I8bdc8a4aff8ea22b5673bc7440e07796ecaf34cc
94 lines
3.0 KiB
Python
94 lines
3.0 KiB
Python
# Copyright (c) 2013 Red Hat, Inc.
|
|
#
|
|
# 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.
|
|
|
|
"""
|
|
This module defines a lower level API for queues' v1. This level of the
|
|
API is responsible for packing up the final request, sending it to the server
|
|
and handling asynchronous requests.
|
|
|
|
Functions present in this module assume that:
|
|
|
|
1. The transport instance is ready to `send` the
|
|
request to the server.
|
|
|
|
2. Transport instance holds the conf instance to use for this
|
|
request.
|
|
"""
|
|
|
|
import json
|
|
|
|
import marconiclient.transport.errors as errors
|
|
|
|
|
|
def _common_queue_ops(operation, transport, request, name, callback=None):
|
|
"""Function for common operation
|
|
|
|
This is a lower level call to get a single
|
|
instance of queue.
|
|
|
|
:param transport: Transport instance to use
|
|
:type transport: `transport.base.Transport`
|
|
:param request: Request instance ready to be sent.
|
|
:type request: `transport.request.Request`
|
|
:param name: Queue reference name.
|
|
:type name: `six.text_type`
|
|
:param callback: Optional callable to use as callback.
|
|
If specified, this request will be sent asynchronously.
|
|
(IGNORED UNTIL ASYNC SUPPORT IS COMPLETE)
|
|
:type callback: Callable object.
|
|
"""
|
|
request.operation = operation
|
|
request.params['queue_name'] = name
|
|
return transport.send(request)
|
|
|
|
|
|
def queue_create(transport, request, name, callback=None):
|
|
"""Creates a queue."""
|
|
return _common_queue_ops('queue_create', transport,
|
|
request, name, callback=callback)
|
|
|
|
|
|
def queue_exists(transport, request, name, callback=None):
|
|
"""Checks if the queue exists."""
|
|
try:
|
|
_common_queue_ops('queue_exists', transport,
|
|
request, name, callback=callback)
|
|
return True
|
|
except errors.ResourceNotFound:
|
|
return False
|
|
|
|
|
|
def queue_get_metadata(transport, request, name, callback=None):
|
|
"""Gets queue metadata."""
|
|
resp = _common_queue_ops('queue_get_metadata', transport,
|
|
request, name, callback=callback)
|
|
return json.loads(resp.content)
|
|
|
|
|
|
def queue_set_metadata(transport, request, name, metadata, callback=None):
|
|
"""Sets queue metadata."""
|
|
|
|
request.operation = 'queue_set_metadata'
|
|
request.params['queue_name'] = name
|
|
request.content = json.dumps(metadata)
|
|
|
|
transport.send(request)
|
|
|
|
|
|
def queue_delete(transport, request, name, callback=None):
|
|
"""Deletes queue."""
|
|
return _common_queue_ops('queue_delete', transport,
|
|
request, name, callback=callback)
|