qpid_management 1.0

data/lib/qpid_management/broker_object.rb

@@ -0,0 +1,126 @@
+# 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.
+#
+
+module Qpid
+  module Management
+    # Representation of an object in the broker retrieved via QMF
+    class BrokerObject
+      attr_reader :content
+
+      # Creates a new BrokerObject
+      # @param [BrokerAgent] agent the agent used to query the data from the broker
+      # @param [Hash] content the raw QMF response data from the broker
+      def initialize(agent, content)
+        @agent = agent
+        @content = content
+        @values = content['_values']
+      end
+
+      # Refreshes the information associated with this instance by requerying the broker
+      # @raise [ObjectDeletedError] if the object has been deleted
+      def refresh!
+        refreshed = @agent.named_object(self.class, id)
+        if refreshed
+          @content = refreshed.content
+          @values = @content['_values']
+        else
+          raise ObjectDeletedError
+        end
+      end
+
+      # Returns the full object id
+      # @return [String] the full object id
+      def id
+        @content['_object_id']['_object_name']
+      end
+
+      # Helper method to convert a Class to its QMF name counterpart. For
+      # example, QpidConfig::Connection will be converted to connection.
+      # @param [Class] clazz the Class to convert
+      # @return [String] the converted QMF name counterpart for this Class
+      def self.qmf_class(clazz)
+        clazz.name.split(/::/).last.downcase
+      end
+
+      # Returns the short object id, i.e. without the leading org.apache.qpid.broker:<class name>:
+      # @return [String] the short object id
+      def short_id
+        clazz = BrokerObject.qmf_class(self.class)
+        if id =~ /org.apache.qpid.broker:#{clazz}:(.*)/
+          return $1;
+        end
+        return nil
+      end
+
+      # Returns the time at which this object was created
+      # @return [Time] the time at which this object was created
+      def created_at
+        Time.at(content['_create_ts'] / 1000000000.0)
+      end
+
+      # Returns the time at which this object was deleted. Only ever applies to
+      # BrokerObject instances created from a QMF event.
+      # @return [Time] the time at which this object was deleted
+      def deleted_at
+        Time.at(content['_delete_ts'] / 1000000000.0)
+      end
+
+      # Returns the time at which this object was last updated
+      # @return [Time] the time at which this object was last updated
+      def updated_at
+        Time.at(content['_update_ts'] / 1000000000.0)
+      end
+      
+      # Exposes data from the QMF response
+      # @param [String] key the key to look up a value, e.g. msgDepth for a queue
+      # @return the value associated with the key, or nil if not found
+      def [](key)
+        return nil unless @values.has_key?(key)
+        value = @values[key]
+        if value.is_a?(Hash) and value.has_key?('_object_name')
+          full_name = value['_object_name']
+          colon = full_name.index(':')
+          unless colon.nil?
+            full_name = full_name[colon+1..-1]
+            colon = full_name.index(':')
+            return full_name[colon+1..-1] unless colon.nil?
+          end
+        end
+
+        return value
+      end
+
+      # Exposes data from the QMF response via methods, e.g. queue.msgDepth
+      def method_missing(method, *args, &block)
+        key = method.to_s
+        return self[key] if args.empty? and not self[key].nil?
+        super
+      end
+
+      def to_s
+        @values.to_s
+      end
+
+      # Invokes a QMF method
+      # @see BrokerAgent#invoke_method
+      def invoke_method(*args)
+        @agent.invoke_method(*args)
+      end
+    end
+  end
+end

data/lib/qpid_management/cluster.rb

@@ -0,0 +1,26 @@
+#
+# 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.
+#
+
+module Qpid
+  module Management
+    # Representation of a cluster
+    class Cluster < BrokerObject
+    end
+  end
+end

data/lib/qpid_management/connection.rb

@@ -0,0 +1,51 @@
+#
+# 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.
+#
+
+module Qpid
+  module Management
+    # Representation of a client connection. Properties include:
+    # - SystemConnection
+    # - address
+    # - authIdentity
+    # - bytesFromClient
+    # - bytesToClient
+    # - closing
+    # - federationLink
+    # - framesFromClient
+    # - framesToClient
+    # - incoming
+    # - msgsFromClient
+    # - msgsToClient
+    # - remoteParentPid
+    # - remotePid
+    # - remoteProcessName
+    # - remoteProperties
+    # - saslMechanism
+    # - saslSsf
+    # - shadow
+    # - userProxyAuth
+    # - vhostRef
+    class Connection < BrokerObject
+      # Closes this connection to the broker
+      def close
+        invoke_method('close', {}, "org.apache.qpid.broker:connection:#{address}")
+      end
+    end
+  end
+end

data/lib/qpid_management/errors.rb

@@ -0,0 +1,28 @@
+#
+# 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.
+#
+
+module Qpid
+  module Management
+    class ObjectNotFoundError < RuntimeError
+    end
+
+    class ObjectDeletedError < RuntimeError
+    end
+  end
+end

data/lib/qpid_management/exchange.rb

@@ -0,0 +1,44 @@
+#
+# 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.
+#
+
+module Qpid
+  module Management
+    # Representation of an exchange. Properties include:
+    # - arguments
+    # - autoDelete
+    # - bindingCount
+    # - bindingCountHigh
+    # - bindingCountLow
+    # - byteDrops
+    # - byteReceives
+    # - byteRoutes
+    # - durable
+    # - msgDrops
+    # - msgReceives
+    # - msgRoutes
+    # - name
+    # - producerCount
+    # - producerCountHigh
+    # - producerCountLow
+    # - type
+    # - vhostRef
+    class Exchange < BrokerObject
+    end
+  end
+end

data/lib/qpid_management/ha_broker.rb

@@ -0,0 +1,26 @@
+#
+# 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.
+#
+
+module Qpid
+  module Management
+    # Representation of an HA broker
+    class HaBroker < BrokerObject
+    end
+  end
+end

data/lib/qpid_management/link.rb

@@ -0,0 +1,35 @@
+#
+# 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.
+#
+
+module Qpid
+  module Management
+    # Representation of a link to a remote broker. Properties include:
+    # - connectionRef
+    # - durable
+    # - host
+    # - lastError
+    # - name
+    # - port
+    # - state
+    # - transport
+    # - vhostRef
+    class Link < BrokerObject
+    end
+  end
+end

data/lib/qpid_management/memory.rb

@@ -0,0 +1,34 @@
+#
+# 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.
+#
+
+module Qpid
+  module Management
+    # Representation of the broker's memory. Properties include:
+    # - malloc_arena
+    # - malloc_fordblks
+    # - malloc_hblkhd
+    # - malloc_hblks
+    # - malloc_keepcost
+    # - malloc_ordblks
+    # - malloc_uordblks
+    # - name
+    class Memory < BrokerObject
+    end
+  end
+end

data/lib/qpid_management/queue.rb

@@ -0,0 +1,97 @@
+#
+# 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.
+#
+
+module Qpid
+  module Management
+    # Representation of a queue. Properties include:
+    # - acquires
+    # - arguments
+    # - autoDelete
+    # - bindingCount
+    # - bindingCountHigh
+    # - bindingCountLow
+    # - byteDepth
+    # - byteFtdDepth
+    # - byteFtdDequeues
+    # - byteFtdEnqueues
+    # - bytePersistDequeues
+    # - bytePersistEnqueues
+    # - byteTotalDequeues
+    # - byteTotalEnqueues
+    # - byteTxnDequeues
+    # - byteTxnEnqueues
+    # - consumerCount
+    # - consumerCountHigh
+    # - consumerCountLow
+    # - discardsLvq
+    # - discardsOverflow
+    # - discardsPurge
+    # - discardsRing
+    # - discardsSubscriber
+    # - discardsTtl
+    # - durable
+    # - exclusive
+    # - flowStopped
+    # - flowStoppedCount
+    # - messageLatencyAvg
+    # - messageLatencyCount
+    # - messageLatencyMax
+    # - messageLatencyMin
+    # - msgDepth
+    # - msgFtdDepth
+    # - msgFtdDequeues
+    # - msgFtdEnqueues
+    # - msgPersistDequeues
+    # - msgPersistEnqueues
+    # - msgTotalDequeues
+    # - msgTotalEnqueues
+    # - msgTxnDequeues
+    # - msgTxnEnqueues
+    # - name
+    # - releases
+    # - reroutes
+    # - unackedMessages
+    # - unackedMessagesHigh
+    # - unackedMessagesLow
+    # - vhostRef
+    class Queue < BrokerObject
+      # Purges (removes) messages from this queue
+      # @param [Fixnum] message_count number of messages to remove from the queue, or 0 for all messages
+      # @param [Hash] filter an optional filter to use when removing messages
+      def purge(message_count, filter={})
+        invoke_method('purge', {'request' => message_count, 'filter' => filter}, "org.apache.qpid.broker:queue:#{name}")
+      end
+
+      # Reroutes messages from this queue to an exchange, either the queue's
+      # alternate exchange, or the specified exchange
+      # @param [Fixnum] message_count number of messages to reroute from the queue, or 0 for all messages
+      # @param [Boolean] use_alternate_exchange whether to use the queue's alternate exchange as the destination
+      # @param [String] exchange name of destination exchange
+      # @param [Hash] filter an optional filter to use when rerouting messages
+      def reroute(message_count, use_alternate_exchange, exchange, filter)
+        args = {'request' => message_count,
+                'useAltExchange' => use_alternate_exchange,
+                'exchange' => exchange,
+                'filter' => filter}
+
+        invoke_method('reroute', args, "org.apache.qpid.broker:queue:#{name}")
+      end
+    end
+  end
+end

data/lib/qpid_management/session.rb

@@ -0,0 +1,38 @@
+#
+# 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.
+#
+
+module Qpid
+  module Management
+    # Representation of a session to the broker. Properties include:
+    # - TxnCommits
+    # - TxnCount
+    # - TxnRejects
+    # - TxnStarts
+    # - attached
+    # - channelId
+    # - clientCredit
+    # - connectionRef
+    # - detachedLifespan
+    # - name
+    # - unackedMessages
+    # - vhostRef
+    class Session < BrokerObject
+    end
+  end
+end

data/lib/qpid_management/subscription.rb

@@ -0,0 +1,35 @@
+#
+# 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.
+#
+
+module Qpid
+  module Management
+    # Representation of a subscription. Properties include:
+    # - acknowledged
+    # - arguments
+    # - browsing
+    # - creditMode
+    # - delivered
+    # - exclusive
+    # - name
+    # - queueRef
+    # - sessionRef
+    class Subscription < BrokerObject
+    end
+  end
+end

data/lib/qpid_management.rb

@@ -0,0 +1,81 @@
+#
+# 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.
+#
+
+require 'qpid_management/broker_agent'
+require 'qpid_management/broker_object'
+require 'qpid_management/acl'
+require 'qpid_management/binding'
+require 'qpid_management/bridge'
+require 'qpid_management/broker'
+require 'qpid_management/cluster'
+require 'qpid_management/connection'
+require 'qpid_management/errors'
+require 'qpid_management/exchange'
+require 'qpid_management/ha_broker'
+require 'qpid_management/link'
+require 'qpid_management/memory'
+require 'qpid_management/queue'
+require 'qpid_management/session'
+require 'qpid_management/subscription'
+
+module Qpid
+  # The Qpid Management framework is a management framework for Qpid brokers
+  # that uses QMF2.
+  #
+  # ==== Example Usage
+  #
+  # Here is a simple example. It TODO.
+  #
+  #   require 'rubygems'
+  #   require 'qpid_messaging'
+  #   require 'qpid_management'
+  #
+  #   # create a connection and open it
+  #   conn = Qpid::Messaging::Connection.new(:url => "broker.myqpiddomain.com")
+  #   conn.open()
+  #
+  #   # create a broker agent
+  #   agent = Qpid::Management::BrokerAgent.new(conn)
+  #
+  #   # get a reference to the broker
+  #   broker = agent.broker
+  #
+  #   # print out all exchange names
+  #   puts broker.exchanges.map(&:name)
+  #
+  #   # print out info about a single exchange
+  #   amq_direct = broker.exchange('amq.direct')
+  #   puts amq_direct
+  #   puts amq_direct.msgDrops
+  #
+  #   # create an exchange
+  #   broker.add_exchange('topic', 'myexchange')
+  #
+  #   # print out all queue names
+  #   puts broker.queues.map(&:name)
+  #
+  #   # create a queue
+  #   broker.add_queue('myqueue')
+  #
+  #   # print out info about a single queue
+  #   myqueue = broker.queue('myqueue')
+  #   puts myqueue.msgDepth
+  module Management
+  end
+end

data/qpid_management.gemspec

@@ -0,0 +1,36 @@
+#
+# 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.
+#
+
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "qpid_management"
+  s.version     = "1.0"
+  s.authors     = ["Apache Qpid Project"]
+  s.email       = ["dev@qpid.apache.org"]
+  s.homepage    = "http://qpid.apache.org"
+  s.summary     = %q{Qpid management library}
+  s.description = %q{Qpid management library}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_runtime_dependency 'qpid_messaging'
+end