# # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you 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. # """ Management API for Qpid """ import qpid import base64 import socket from threading import Thread from message import Message from time import sleep from qpid.client import Client from qpid.content import Content from cStringIO import StringIO from codec import Codec, EOF from threading import Lock class SequenceManager: def __init__ (self): self.lock = Lock () self.sequence = 0 self.pending = {} def reserve (self, data): self.lock.acquire () result = self.sequence self.sequence = self.sequence + 1 self.pending[result] = data self.lock.release () return result def release (self, seq): data = None self.lock.acquire () if seq in self.pending: data = self.pending[seq] del self.pending[seq] self.lock.release () return data class ManagementMetadata: """One instance of this class is created for each ManagedBroker. It is used to store metadata from the broker which is needed for the proper interpretation of received management content.""" def encodeValue (self, codec, value, typecode): if typecode == 1: codec.encode_octet (int (value)) elif typecode == 2: codec.encode_short (int (value)) elif typecode == 3: codec.encode_long (long (value)) elif typecode == 4: codec.encode_longlong (long (value)) elif typecode == 5: codec.encode_octet (int (value)) elif typecode == 6: codec.encode_shortstr (value) elif typecode == 7: codec.encode_longstr (value) elif typecode == 8: # ABSTIME codec.encode_longlong (long (value)) elif typecode == 9: # DELTATIME codec.encode_longlong (long (value)) elif typecode == 10: # REF codec.encode_longlong (long (value)) elif typecode == 11: # BOOL codec.encode_octet (int (value)) else: raise ValueError ("Invalid type code: %d" % typecode) def decodeValue (self, codec, typecode): if typecode == 1: data = codec.decode_octet () elif typecode == 2: data = codec.decode_short () elif typecode == 3: data = codec.decode_long () elif typecode == 4: data = codec.decode_longlong () elif typecode == 5: data = codec.decode_octet () elif typecode == 6: data = codec.decode_shortstr () elif typecode == 7: data = codec.decode_longstr () elif typecode == 8: # ABSTIME data = codec.decode_longlong () elif typecode == 9: # DELTATIME data = codec.decode_longlong () elif typecode == 10: # REF data = codec.decode_longlong () elif typecode == 11: # BOOL data = codec.decode_octet () else: raise ValueError ("Invalid type code: %d" % typecode) return data def parseSchema (self, cls, codec): className = codec.decode_shortstr () configCount = codec.decode_short () instCount = codec.decode_short () methodCount = codec.decode_short () eventCount = codec.decode_short () configs = [] insts = [] methods = {} events = [] configs.append (("id", 4, "", "", 1, 1, None, None, None, None, None)) insts.append (("id", 4, None, None)) for idx in range (configCount): ft = codec.decode_table () name = ft["name"] type = ft["type"] access = ft["access"] index = ft["index"] unit = None min = None max = None maxlen = None desc = None for key, value in ft.items (): if key == "unit": unit = value elif key == "min": min = value elif key == "max": max = value elif key == "maxlen": maxlen = value elif key == "desc": desc = value config = (name, type, unit, desc, access, index, min, max, maxlen) configs.append (config) for idx in range (instCount): ft = codec.decode_table () name = ft["name"] type = ft["type"] unit = None desc = None for key, value in ft.items (): if key == "unit": unit = value elif key == "desc": desc = value inst = (name, type, unit, desc) insts.append (inst) for idx in range (methodCount): ft = codec.decode_table () mname = ft["name"] argCount = ft["argCount"] if "desc" in ft: mdesc = ft["desc"] else: mdesc = None args = [] for aidx in range (argCount): ft = codec.decode_table () name = ft["name"] type = ft["type"] dir = ft["dir"].upper () unit = None min = None max = None maxlen = None desc = None default = None for key, value in ft.items (): if key == "unit": unit = value elif key == "min": min = value elif key == "max": max = value elif key == "maxlen": maxlen = value elif key == "desc": desc = value elif key == "default": default = value arg = (name, type, dir, unit, desc, min, max, maxlen, default) args.append (arg) methods[mname] = (mdesc, args) self.schema[(className,'C')] = configs self.schema[(className,'I')] = insts self.schema[(className,'M')] = methods self.schema[(className,'E')] = events if self.broker.schema_cb != None: self.broker.schema_cb[1] (self.broker.schema_cb[0], className, configs, insts, methods, events) def parseContent (self, cls, codec): if cls == 'C' and self.broker.config_cb == None: return if cls == 'I' and self.broker.inst_cb == None: return className = codec.decode_shortstr () if (className,cls) not in self.schema: return row = [] timestamps = [] timestamps.append (codec.decode_longlong ()) # Current Time timestamps.append (codec.decode_longlong ()) # Create Time timestamps.append (codec.decode_longlong ()) # Delete Time for element in self.schema[(className,cls)][:]: tc = element[1] name = element[0] data = self.decodeValue (codec, tc) row.append ((name, data)) if cls == 'C': self.broker.config_cb[1] (self.broker.config_cb[0], className, row, timestamps) elif cls == 'I': self.broker.inst_cb[1] (self.broker.inst_cb[0], className, row, timestamps) def parse (self, codec, opcode, cls): if opcode == 'S': self.parseSchema (cls, codec) elif opcode == 'C': self.parseContent (cls, codec) else: raise ValueError ("Unknown opcode: %c" % opcode); def __init__ (self, broker): self.broker = broker self.schema = {} class ManagedBroker: """An object of this class represents a connection (over AMQP) to a single managed broker.""" mExchange = "qpid.management" dExchange = "amq.direct" def setHeader (self, codec, opcode, cls = 0): codec.encode_octet (ord ('A')) codec.encode_octet (ord ('M')) codec.encode_octet (ord ('0')) codec.encode_octet (ord ('1')) codec.encode_octet (opcode) codec.encode_octet (cls) def checkHeader (self, codec): octet = chr (codec.decode_octet ()) if octet != 'A': return None octet = chr (codec.decode_octet ()) if octet != 'M': return None octet = chr (codec.decode_octet ()) if octet != '0': return None octet = chr (codec.decode_octet ()) if octet != '1': return None opcode = chr (codec.decode_octet ()) cls = chr (codec.decode_octet ()) return (opcode, cls) def publish_cb (self, msg): codec = Codec (StringIO (msg.content.body), self.spec) hdr = self.checkHeader (codec) if hdr == None: raise ValueError ("outer header invalid"); self.metadata.parse (codec, hdr[0], hdr[1]) msg.complete () def reply_cb (self, msg): codec = Codec (StringIO (msg.content.body), self.spec) hdr = self.checkHeader (codec) if hdr == None: msg.complete () return if hdr[0] != 'R': msg.complete () return sequence = codec.decode_long () status = codec.decode_long () sText = codec.decode_shortstr () data = self.sequenceManager.release (sequence) if data == None: msg.complete () return (userSequence, className, methodName) = data args = {} if status == 0: ms = self.metadata.schema[(className,'M')] arglist = None for mname in ms: (mdesc, margs) = ms[mname] if mname == methodName: arglist = margs if arglist == None: msg.complete () return for arg in arglist: if arg[2].find("O") != -1: args[arg[0]] = self.metadata.decodeValue (codec, arg[1]) if self.method_cb != None: self.method_cb[1] (self.method_cb[0], userSequence, status, sText, args) msg.complete () def __init__ (self, host = "localhost", port = 5672, username = "guest", password = "guest", specfile = "/usr/share/amqp/amqp.0-10-preview.xml"): self.spec = qpid.spec.load (specfile) self.client = None self.channel = None self.queue = None self.rqueue = None self.qname = None self.rqname = None self.metadata = ManagementMetadata (self) self.sequenceManager = SequenceManager () self.connected = 0 self.lastConnectError = None # Initialize the callback records self.status_cb = None self.schema_cb = None self.config_cb = None self.inst_cb = None self.method_cb = None self.host = host self.port = port self.username = username self.password = password def statusListener (self, context, callback): self.status_cb = (context, callback) def schemaListener (self, context, callback): self.schema_cb = (context, callback) def configListener (self, context, callback): self.config_cb = (context, callback) def methodListener (self, context, callback): self.method_cb = (context, callback) def instrumentationListener (self, context, callback): self.inst_cb = (context, callback) def method (self, userSequence, objId, className, methodName, args=None, packageName="qpid"): codec = Codec (StringIO (), self.spec); sequence = self.sequenceManager.reserve ((userSequence, className, methodName)) self.setHeader (codec, ord ('M')) codec.encode_long (sequence) # Method sequence id codec.encode_longlong (objId) # ID of object #codec.encode_shortstr (self.rqname) # name of reply queue # Encode args according to schema if (className,'M') not in self.metadata.schema: self.sequenceManager.release (sequence) raise ValueError ("Unknown class name: %s" % className) ms = self.metadata.schema[(className,'M')] arglist = None for mname in ms: (mdesc, margs) = ms[mname] if mname == methodName: arglist = margs if arglist == None: self.sequenceManager.release (sequence) raise ValueError ("Unknown method name: %s" % methodName) for arg in arglist: if arg[2].find("I") != -1: value = arg[8] # default if arg[0] in args: value = args[arg[0]] if value == None: self.sequenceManager.release (sequence) raise ValueError ("Missing non-defaulted argument: %s" % arg[0]) self.metadata.encodeValue (codec, value, arg[1]) msg = Content (codec.stream.getvalue ()) msg["content_type"] = "application/octet-stream" msg["routing_key"] = "method." + packageName + "." + className + "." + methodName msg["reply_to"] = self.spec.struct ("reply_to") msg["reply_to"]["exchange_name"] = "amq.direct" msg["reply_to"]["routing_key"] = self.rqname self.channel.message_transfer (destination="qpid.management", content=msg) def isConnected (self): return connected def start (self): print "Connecting to broker %s:%d" % (self.host, self.port) try: self.client = Client (self.host, self.port, self.spec) self.client.start ({"LOGIN": self.username, "PASSWORD": self.password}) self.channel = self.client.channel (1) response = self.channel.session_open (detached_lifetime=300) self.qname = "mgmt-" + base64.urlsafe_b64encode (response.session_id) self.rqname = "reply-" + base64.urlsafe_b64encode (response.session_id) self.channel.queue_declare (queue=self.qname, exclusive=1, auto_delete=1) self.channel.queue_declare (queue=self.rqname, exclusive=1, auto_delete=1) self.channel.queue_bind (exchange=ManagedBroker.mExchange, queue=self.qname, routing_key="mgmt.#") self.channel.queue_bind (exchange=ManagedBroker.dExchange, queue=self.rqname, routing_key=self.rqname) self.channel.message_subscribe (queue=self.qname, destination="mdest") self.channel.message_subscribe (queue=self.rqname, destination="rdest") self.queue = self.client.queue ("mdest") self.queue.listen (self.publish_cb) self.channel.message_flow_mode (destination="mdest", mode=1) self.channel.message_flow (destination="mdest", unit=0, value=0xFFFFFFFF) self.channel.message_flow (destination="mdest", unit=1, value=0xFFFFFFFF) self.rqueue = self.client.queue ("rdest") self.rqueue.listen (self.reply_cb) self.channel.message_flow_mode (destination="rdest", mode=1) self.channel.message_flow (destination="rdest", unit=0, value=0xFFFFFFFF) self.channel.message_flow (destination="rdest", unit=1, value=0xFFFFFFFF) self.connected = 1 except socket.error, e: print "Socket Error:", e[1] self.lastConnectError = e raise except: raise def stop (self): pass