tobias-jmx 0.8

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Thomas E Enebo <enebo@acm.org>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,14 @@
+Manifest.txt
+Rakefile
+README.md
+LICENSE.txt
+lib/jmx
+lib/jmx.rb
+lib/rmi.rb
+lib/jmx/dynamic_mbean.rb
+lib/jmx/server.rb
+lib/jmx/version.rb
+samples/memory.rb
+test/jmx_attribute_test.rb
+test/jmx_client_test.rb
+test/jmx_server_test.rb

data/README.md

@@ -0,0 +1,29 @@
+# JMX
+
+## DESCRIPTION:
+
+JMX is a library which allows you to access JMX MBeans as a client or create
+your own MBeans as a Ruby class.
+
+## FEATURES/PROBLEMS:
+
+* Use '-J-Dcom.sun.management.jmxremote' to make jruby process accessible from a jruby command-line
+
+## SYNOPSIS:
+
+Connect to same JVM as client script and look at Memory MBean
+
+   require 'jmx'
+
+   client = JMX.simple_connect(:port => 9999)
+
+   memory = client["java.lang:type=Memory"]
+   puts memory.attributes
+
+## REQUIREMENTS:
+
+* JRuby
+
+## INSTALL:
+
+* jruby -S gem install jmx

data/Rakefile

@@ -0,0 +1,27 @@
+MANIFEST = FileList["Manifest.txt", "Rakefile", "README.md", "LICENSE.txt", "lib/**/*", "samples/*","test/**/*"]
+
+file "Manifest.txt" => :manifest
+task :manifest do
+  File.open("Manifest.txt", "w") {|f| MANIFEST.each {|n| f << "#{n}\n"} }
+end
+Rake::Task['manifest'].invoke # Always regen manifest, so Hoe has up-to-date list of files
+
+$LOAD_PATH << 'lib'
+require 'jmx/version'
+begin
+  require 'hoe'
+  Hoe.new("tobias-jmx", JMX::VERSION) do |p|
+    p.rubyforge_name = "jruby-extras"
+    p.url = "http://github.com/enebo/jmxjr"
+    p.author = "Thomas Enebo & Jay McGaffigan"
+    p.email = "tom.enebo@gmail.com"
+    p.summary = "Package for interacting/creating Java Management Extensions"
+    p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+    p.description = "Install this gem and require 'jmx' to load the library."
+  end.spec.dependencies.delete_if { |dep| dep.name == "hoe" }
+rescue LoadError
+  puts "You need Hoe installed to be able to package this gem"
+rescue => e
+  p e.backtrace
+  puts "ignoring error while loading hoe: #{e.to_s}"
+end

data/lib/jmx.rb

@@ -0,0 +1,218 @@
+include Java
+
+require 'rmi'
+require 'jmx/dynamic_mbean'
+require 'jmx/server'
+
+java_import java.util.ArrayList
+java_import javax.management.Attribute
+java_import javax.management.MBeanInfo
+java_import javax.management.DynamicMBean
+
+module JMX
+  java_import javax.management.ObjectName
+  class ObjectName
+    def [](key)
+      get_key_property(key.to_s)
+    end
+  
+    def info(server)
+      server.getMBeanInfo(self)
+    end
+  end
+end
+
+module javax::management::openmbean::CompositeData
+  include Enumerable
+
+  def [](key)
+    get(key.to_s)
+  end
+
+  def method_missing(name, *args)
+    self[name]
+  end
+
+  def each
+    get_composite_type.key_set.each { |key| yield key }
+  end
+
+  def each_pair
+    get_composite_type.key_set.each { |key| yield key, get(key) }
+  end
+end
+
+module JMX
+  ##
+  # Connect to a MBeanServer
+  # opts can contain several values
+  #   :host - The hostname where the server resides (def: localhost)
+  #   :port - Which port the server resides at (def: 8686)
+  #   :url_path - path part of JMXServerURL (def: /jmxrmi)
+  #   :user - User to connect as (optional)
+  #   :password - Password for user (optional)
+  def self.connect(opts = {})
+    host = opts[:host] || 'localhost'
+    port = opts[:port] || 8686
+    url_path = opts[:url_path] || "/jmxrmi"
+    url = "service:jmx:rmi:///jndi/rmi://#{host}:#{port}#{url_path}"
+
+    if opts[:user]
+      JMX::MBeanServer.new url, opts[:user], opts[:password]
+    else
+      JMX::MBeanServer.new url
+    end
+  end
+
+  ##
+  # sad little simple server setup so you can connect up to it.
+  # 
+  def self.simple_server(opts = {})
+    port = opts[:port] || 8686
+    url_path = opts[:url_path] || "/jmxrmi"
+    url = "service:jmx:rmi:///jndi/rmi://localhost:#{port}#{url_path}"
+    $registry = RMIRegistry.new port
+    @connector = JMX::MBeanServerConnector.new(url, JMX::MBeanServer.new).start
+  end
+
+  # Holder for beans created from retrieval (namespace protection [tm]).
+  # This also gives MBeans nicer names when inspected
+  module MBeans
+    ##
+    # Create modules in this namespace for each package in the Java fully
+    # qualified name and return the deepest module along with the Java class
+    # name back to the caller.
+    def self.parent_for(java_class_fqn)
+      java_class_fqn.split(".").inject(MBeans) do |parent, segment|
+        # Note: We are boned if java class name is lower cased
+        return [parent, segment] if segment =~ /^[A-Z]/
+
+        segment.capitalize!
+        unless parent.const_defined? segment
+          parent.const_set segment, Module.new
+        else 
+          parent.const_get segment
+        end
+      end
+
+    end
+  end
+
+  # Create a Ruby proxy based on the MBean represented by the object_name
+  class MBeanProxy
+    # Generate a friendly Ruby proxy for the MBean represented by object_name
+    def self.generate(server, object_name)
+      parent, class_name = MBeans.parent_for object_name.info(server).class_name
+
+      if parent.const_defined? class_name
+        proxy = parent.const_get(class_name)
+      else
+        proxy = Class.new MBeanProxy
+        parent.const_set class_name, proxy
+      end
+
+      proxy.new(server, object_name)
+    end
+
+    def initialize(server, object_name)
+      @server, @object_name = server, object_name
+      @info = @server.getMBeanInfo(@object_name)
+
+      define_attributes
+      define_operations
+    end
+
+    def attributes
+      @attributes ||= @info.attributes.inject([]) { |s,attr| s << attr.name }
+    end
+
+    def operations
+      @operations ||= @info.operations.inject([]) { |s,op| s << op.name }
+    end
+
+    # Get MBean attribute specified by name.  If it is just a plain attribute then
+    # unwrap the attribute and just return the value.
+    def [](name)
+      attribute = @server.getAttribute(@object_name, name.to_s)
+      return attribute.value if attribute.kind_of? javax.management.Attribute
+      attribute
+    end
+
+    # Set MBean attribute specified by name to value
+    def []=(name, value) 
+      @server.setAttribute @object_name, javax.management.Attribute.new(name.to_s, value)
+    end
+
+    def add_notification_listener(filter=nil, handback=nil, &listener)
+      @server.addNotificationListener @object_name, listener, filter, handback
+    end
+
+    def remove_notification_listener(listener)
+      @server.removeNotificationListener @object_name, listener
+    end
+
+    private
+
+    def safe_define_method(method_name, &block)
+      method_name = "mbean_#{method_name}" if respond_to?(method_name) || method_name == 'initialize'
+      self.class.__send__(:define_method, method_name, &block)
+    end
+    
+    # Define ruby friendly methods for attributes.  For odd attribute names or names
+    # that you want to call with the actual attribute name you can call aref/aset
+    def define_attributes
+      @info.attributes.each do |attr|
+        rname = underscore(attr.name)
+        safe_define_method(rname) { self[attr.name] } if attr.readable?
+        safe_define_method(rname + "=") {|v| self[attr.name] = v } if attr.writable?
+      end
+    end
+
+    def define_operations
+      @info.operations.each do |op|
+        safe_define_method(op.name) do |*args|
+          jargs, jtypes = java_args(op.signature, args)
+          @server.invoke @object_name, op.name, jargs, jtypes
+        end
+      end
+    end
+
+    # Given the signature and the parameters supplied do these signatures match.
+    # Repackage these parameters as Java objects in a primitive object array.
+    def java_args(signature, params)
+      return nil if params.nil?
+
+      jtypes = []
+      jargs = []
+      params.each_with_index do |param, i|
+        type = signature[i].get_type
+        jtypes << type
+        required_type = JavaClass.for_name(type)
+        
+        java_arg = param.to_java(:object)
+
+        if (param.kind_of? Array)
+          java_arg = param.inject(ArrayList.new) {|l, element| l << element }
+        end
+        
+        jargs << java_arg
+
+        arg_type = java_arg.java_class
+        
+        raise TypeError.new("parameter #{signature[i].name} expected to be #{required_type}, but was #{arg_type}") if !required_type.assignable_from? arg_type
+      end
+      [jargs.to_java, jtypes.to_java(:string)]
+    end
+
+    # Convert a collection of java objects to their Java class name equivalents
+    def java_types(params)
+      return nil if params.nil?
+
+      params.map {|e| e.class.java_class.name }.to_java(:string)
+    end
+
+    def underscore(string)
+      string.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
+    end
+  end
+end

data/lib/jmx/dynamic_mbean.rb

@@ -0,0 +1,270 @@
+module JMX
+  java_import javax.management.MBeanParameterInfo
+  java_import javax.management.MBeanOperationInfo
+  java_import javax.management.MBeanAttributeInfo
+  java_import javax.management.MBeanInfo
+
+  # Module that is used to bridge java to ruby and ruby to java types.
+  module JavaTypeAware
+    # Current list of types we understand  If it's not in this list we are 
+    # assuming that we are going to convert to a java.object
+    SIMPLE_TYPES = {
+      :int => ['java.lang.Integer', lambda {|param| param.to_i}],
+      :list => ['java.util.List', lambda {|param| param.to_a}],
+      :long => ['java.lang.Long', lambda {|param| param.to_i}],
+      :float => ['java.lang.Float', lambda {|param| param.to_f}],
+      :map => ['java.util.Map', lambda {|param| param}],
+      :set => ['java.util.Set', lambda {|param| param}],
+      :string => ['java.lang.String', lambda {|param| param.to_s}],
+      :void => ['java.lang.Void', lambda {|param| nil}]
+    }
+
+    def to_java_type(type_name)
+      SIMPLE_TYPES[type_name][0] || type_name
+    end
+
+    #TODO: I'm not sure this is strictly needed, but funky things can happen if you 
+    # are expecting your attributes (from the ruby side) to be ruby types and they are java types.
+    def to_ruby(type_name)
+      SIMPLE_TYPES[type_name][1] || lambda {|param| param}
+    end
+
+    module_function :to_java_type, :to_ruby
+  end
+
+  class Parameter
+    include JavaTypeAware 
+
+    def initialize(type, name, description)
+      @type, @name, @description = type, name, description
+    end
+
+    def to_jmx
+      MBeanParameterInfo.new @name.to_s, to_java_type(@type), @description
+    end
+  end
+
+  class Operation < Struct.new(:description, :parameters, :return_type, :name, :impact)
+    include JavaTypeAware
+
+    def initialize(description)
+      super
+      self.parameters, self.impact, self.description = [], MBeanOperationInfo::UNKNOWN, description
+    end
+
+    def to_jmx
+      java_parameters = parameters.map { |parameter| parameter.to_jmx }
+      MBeanOperationInfo.new name.to_s, description, java_parameters.to_java(javax.management.MBeanParameterInfo), to_java_type(return_type), impact
+    end
+  end    
+  
+  class Attribute < Struct.new(:name, :type, :description, :is_reader, :is_writer, :is_iser)
+    include JavaTypeAware
+    
+    def initialize(name, type, description, is_rdr, is_wrtr)
+      super
+      self.description, self.type, self.name = description, type, name
+      self.is_reader,self.is_writer, self.is_iser = is_rdr, is_wrtr, false
+    end
+
+    def to_jmx
+      MBeanAttributeInfo.new(name.to_s, to_java_type(type), description, is_reader, is_writer, is_iser) 
+    end
+  end
+end
+
+#  The Ruby-Java JMX utilities work throughout the DynamicMBean concept.  Creators of Ruby based MBeans must inherit this
+# class (<tt>RubyDynamicMBean</tt>) in their own bean classes and then register them with a JMX mbean server.  
+#  Here is an example:
+#       class MyMBean < RuybDynamicMBean
+#         rw_attribute :status, :string, "Status information for this process"
+#         
+#         operation "Shutdown this process"
+#         parameter :string, "user_name", "Name of user requesting shutdown"
+#         returns :string
+#         def shutdown(user_name)
+#            "shutdown requests more time"
+#         end
+#       end
+# Once you have defined your bean class you can start declaring attributes and operations.  
+# Attributes come in three flavors: read, write, and read write.  Simmilar to the <tt>attr*</tt>
+# helpers, there are helpers that are used to create management attributes. Use +r_attribute+,
+# +w_attribute+, and +rw_attribute+ to declare attributes, and the +operation+, +returns+, 
+# and +parameter+ helpers to define a management operation.
+# Creating attributes with the *_attribute convention ALSO creates ruby accessors 
+# (it invokes the attr_accessor/attr_reader/attr_writer ruby helpers) to create ruby methods 
+# like: user_name= and username.  So in your ruby code you can treat the attributes 
+# as "regular" ruby accessors
+class RubyDynamicMBean
+  java_import javax.management.AttributeList
+  java_import javax.management.MBeanOperationInfo
+  java_import javax.management.MBeanAttributeInfo
+  java_import javax.management.MBeanInfo
+  include JMX::JavaTypeAware
+  
+  def self.inherited(cls)
+    cls.send(:include, javax.management.DynamicMBean)
+  end
+
+  # TODO: preserve any original method_added?
+  # TODO: Error handling here when it all goes wrong?
+  def self.method_added(name) #:nodoc:
+    return if metadata[:op].nil?
+    metadata[:op].name = name
+    operations << metadata[:op].to_jmx
+    metadata[:op] = nil
+  end
+
+  # All attributes in this class
+  def self.attributes
+    metadata[:attrs] ||= []
+  end
+
+  # All attributes up the inheritance chain
+  def self.all_attributes
+    ancestors.inject([]) do |sum, clazz|
+      sum.concat(clazz.attributes) if clazz.respond_to? :attributes
+      sum
+    end
+  end
+
+  # All operations up the inheritance chain
+  def self.all_operations
+    ancestors.inject([]) do |sum, clazz|
+      sum.concat(clazz.operations) if clazz.respond_to? :operations
+      sum
+    end
+  end
+  
+  # All operations in this class
+  def self.operations
+    metadata[:ops] ||= []
+  end
+
+  def self.define_getter(name, type, reader)
+    # FIXME: Our to_java_type needs to do something saner
+    java_type = begin; to_java_type(type); rescue; nil; end
+    value_proc = java_type ? proc { |value| java_type.new value } : proc { |value| Java.ruby_to_java value }
+
+    reader = name.to_s unless reader
+    attr_reader reader unless instance_methods.include?(reader)
+    define_method("jmx_get_#{name.downcase}") do
+      javax.management.Attribute.new name, value_proc.call(__send__(reader))
+    end
+  end
+
+  def self.define_setter(name, type, writer)
+    value_converter = JMX::JavaTypeAware.to_ruby(type)
+
+    writer = name.to_s + '=' unless writer
+    attr_writer name.to_s unless instance_methods.include?(writer)
+    define_method("jmx_set_#{name.downcase}") do |value|
+      __send__ writer, value_converter.call(value)
+    end
+  end
+  
+  # the <tt>rw_attribute</tt> method is used to declare a JMX read write attribute. See the +JavaSimpleTypes+
+  # module for more information about acceptable types usage: 
+  #     rw_attribute :attribute_name, :string, "Description displayed in a JMX console"
+  def self.rw_attribute(name, type, description, reader=nil, writer=nil)
+    name = name.to_s
+    attributes << JMX::Attribute.new(name, type, description, true, true).to_jmx
+    define_getter name, type, reader
+    define_setter name, type, writer
+  end
+
+  # the <tt>r_attribute</tt> method is used to declare a JMX read only attribute. See the +JavaSimpleTypes+ 
+  # module for more information about acceptable types usage: 
+  #     r_attribute :attribute_name, :string, "Description displayed in a JMX console"
+  def self.r_attribute(name, type, description, reader=nil)
+    name = name.to_s
+    attributes << JMX::Attribute.new(name, type, description, true, false).to_jmx
+    define_getter name, type, reader
+  end
+  
+  # the <tt>w_attribute</tt> method is used to declare a JMX write only attribute. See the +JavaSimpleTypes+ 
+  # module for more information about acceptable types usage: 
+  #     w_attribute :attribute_name, :string, "Description displayed in a JMX console"
+  def self.w_attribute(name, type, description, writer=nil)
+    name = name.to_s
+    attributes << JMX::Attribute.new(name, type, description, false, true).to_jmx
+    define_setter name, type, writer
+  end
+
+  # Use the operation method to declare the start of an operation
+  # It takes as an argument the description for the operation
+  #     operation "Used to start the service"
+  #     def start
+  #     end
+  #--
+  # Last operation wins if more than one
+  #++
+  def self.operation(description)
+    # Wait to error check until method_added so we can know method name
+    metadata[:op] = JMX::Operation.new description
+  end
+
+  # Used to declare a parameter (you can declare more than one in succession) that
+  # is associated with the currently declared operation.
+  #     operation "Used to update the name of a service"
+  #     parameter :string, "name", "Set the new name of the service"
+  #     def start
+  #     end
+  def self.parameter(type, name=nil, description=nil)
+    metadata[:op].parameters << JMX::Parameter.new(type, name, description)
+  end
+
+  # Used to declare the return type of the operation
+  #     operation "Used to update the name of a service"
+  #     parameter :string, "name", "Set the new name of the service"
+  #     returns :void
+  #     def set_name
+  #     end
+  def self.returns(type)
+    metadata[:op].return_type = type
+  end
+  
+  # Thread local storage for the derived bean
+  def self.metadata
+    @@metadata ||= {}
+    @@metadata[object_id] ||= {}
+  end
+
+  # when creating a dynamic MBean we need to provide it with a name and a description.
+  def initialize(name, description)
+    operations = self.class.all_operations.to_java MBeanOperationInfo
+    attributes = self.class.all_attributes.to_java MBeanAttributeInfo
+    @info = MBeanInfo.new name, description, attributes, nil, operations, nil
+  end
+
+  # Retrieve the value of the requested attribute (where attribute is a javax.management.Attribute class)
+  def getAttribute(attribute)
+    __send__("jmx_get_" + attribute.downcase)
+  end
+  
+  def getAttributes(attributes)
+    attributes.inject(AttributeList.new) { |attrs, attribute| attrs.add(getAttribute(attribute)); attrs } 
+  end
+  
+  def getMBeanInfo
+    @info
+  end
+  
+  def invoke(actionName, params=nil, signature=nil)
+    __send__(actionName, *params)
+  end
+
+  def setAttribute(attribute)
+    __send__("jmx_set_#{attribute.name.downcase}", attribute.value)   
+  end
+  
+  def setAttributes(attributes)  
+    attributes.each { |attribute| setAttribute attribute}
+  end
+  
+  def toString
+    "#@info.class_name: #@info.description"
+  end
+  alias_method :to_s, :toString
+  alias_method :inspect, :toString
+end

data/lib/jmx/server.rb

@@ -0,0 +1,131 @@
+module JMX
+  # The MBeanServer represents a connection to an MBean server
+  # rather than an actual MBean server.  Depending upon how 
+  # this object is constructed you can either talk to the 
+  # PlatformMBeanServer or any "remote" MBean server.
+  #--
+  # Represents both MBeanServer and MBeanServerConnection
+  #++ 
+  class MBeanServer
+    java_import javax.management.Attribute
+    java_import javax.management.MBeanServerFactory
+    java_import javax.management.remote.JMXConnectorFactory
+    java_import javax.management.remote.JMXServiceURL
+
+    attr_accessor :server
+    @@classes = {}
+
+    # when creatinga  new MBeanServer you can optionally specify a location, username, and password
+    # if specify these values (or at least the location) the MBeanServer instance will connect to 
+    # an existing (and remote ) MBean server and register the mbeans there.
+    # otherwise the server will connect to to the local Platform MBean Server.
+    def initialize(location=nil, username=nil, password=nil)
+      if (location)
+        env = username ? 
+          {"jmx.remote.credentials" => [username, password].to_java(:string)} :
+          nil
+        url = JMXServiceURL.new location
+        @server = JMXConnectorFactory.connect(url, env).getMBeanServerConnection
+      else
+        @server = java.lang.management.ManagementFactory.getPlatformMBeanServer
+        #@server = MBeanServerFactory.createMBeanServer
+      end
+    end
+
+    def [](object_name)
+      name = make_object_name object_name
+
+      unless @server.isRegistered(name)
+        raise NoSuchBeanError.new("No name: #{object_name}") 
+      end
+
+      #### TODO: Why?
+      @server.getObjectInstance name
+      MBeanProxy.generate(@server, name)
+    end
+
+    def []=(class_name, object_name)
+      name = make_object_name object_name
+
+      @server.createMBean class_name, name, nil, nil
+
+      MBeanProxy.generate(@server, name)
+    end
+
+    def default_domain
+      @server.getDefaultDomain
+    end
+
+    def domains
+      @server.domains
+    end
+
+    def mbean_count
+      @server.getMBeanCount
+    end
+
+    def query_names(name=nil, query=nil)
+      object_name = name.nil? ? nil : make_object_name(name)
+
+      @server.query_names(object_name, query)
+    end
+    
+    def unregister_mbean(object_name)
+      name = make_object_name object_name
+      @server.unregisterMBean(name)
+      
+    end
+
+    def register_mbean(object, object_name)
+      name = make_object_name object_name
+      @server.registerMBean(object, name)
+      MBeanProxy.generate(@server, name)
+    end
+    
+    def self.find(agent_id=nil)
+      MBeanServerFactory.findMBeanServer(agent_id)
+    end
+
+    private
+
+    def make_object_name(object_name)
+      return object_name if object_name.kind_of? ObjectName
+
+      ObjectName.new object_name
+    rescue
+      raise ArgumentError.new("Invalid ObjectName #{$!.message}")
+    end
+  end
+
+  class NoSuchBeanError < RuntimeError
+  end
+
+  class MBeanServerConnector
+    java_import javax.management.remote.JMXServiceURL
+    java_import javax.management.remote.JMXConnectorServerFactory
+
+    def initialize(location, server)
+      @url = JMXServiceURL.new location
+      @server = JMXConnectorServerFactory.newJMXConnectorServer @url, nil, server.server
+
+      if block_given?
+	start
+        yield
+        stop
+      end
+    end
+
+    def active?
+      @server.isActive
+    end
+
+    def start
+      @server.start
+      self
+    end
+
+    def stop
+      @server.stop if active?
+    end
+  end
+end

data/lib/jmx/version.rb

@@ -0,0 +1,3 @@
+module JMX
+  VERSION = "0.8"
+end

data/lib/rmi.rb

@@ -0,0 +1,21 @@
+include Java
+
+java_import java.rmi.registry.LocateRegistry
+java_import java.rmi.registry.Registry
+java_import java.rmi.server.UnicastRemoteObject
+
+class RMIRegistry
+  def initialize(port = Registry::REGISTRY_PORT)
+    start(port)
+  end
+
+  def start(port)
+    @registry = LocateRegistry.createRegistry port
+
+  end
+
+  def stop
+    UnicastRemoteObject.unexportObject @registry, true
+  end
+end
+

data/samples/memory.rb

@@ -0,0 +1,29 @@
+require 'jmx'
+
+def in_mb(value)
+  format "%0.2f Mb" % (value.to_f / (1024 * 1024))
+end
+
+server = JMX.simple_server
+client = JMX.connect
+memory = client["java.lang:type=Memory"]
+
+Thread.new do
+  puts "Enter 'gc' to garbage collect or anything else to quit"
+  while (command = gets.chomp)
+    break if command != "gc"
+    memory.gc
+  end
+
+  server.stop
+  exit 0
+end
+
+while (true)
+  heap = in_mb(memory.heap_memory_usage.used)
+  non_heap = in_mb(memory.non_heap_memory_usage.used)
+
+  puts "Heap: #{heap}, Non-Heap: #{non_heap}"
+  sleep(2)
+end
+

data/test/jmx_attribute_test.rb

@@ -0,0 +1,82 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'jmx'
+
+# These tests are for verifying that at a Ruby-level (on server-side) it is still possible 
+# to interact with dynamic mbeans as you expect.  *_attributes are backed by ordinary
+# Ruby instance variables of the same name.
+
+class MyAttributeDynamicBean < RubyDynamicMBean
+  rw_attribute :name, :string, "My sample attribute"
+  r_attribute :number_read_only, :int, "My sample integer based attribute that is read only"
+  w_attribute :number_write_only, :int, "My sample integer based attribute that is write only"
+
+  # Give us a way to change the attribute for testing
+  def set_number_read_only(value)
+    @number_read_only = value
+  end
+  
+  def fetch_number_write_only
+    @number_write_only
+  end
+
+  def my_reader
+    42
+  end
+end
+
+
+class JMXAttributeTest < Test::Unit::TestCase
+
+  def setup
+    @madb = MyAttributeDynamicBean.new("test.MyTestBean","Mwahahahahahah")    
+  end
+  
+  #make sure we didn't break anything from a ruby perspective
+  def test_can_create_bean_and_access_accessor_type_methods
+    @madb.set_number_read_only 4
+    assert_nil(@madb.name)
+    @madb.name = "Name"
+    assert_equal("Name", @madb.name)
+    assert_equal(4, @madb.number_read_only)
+    @madb.number_write_only = 4
+    assert_equal(4, @madb.fetch_number_write_only)    
+    assert_raise(NoMethodError) { @madb.number_write_only }    
+  end
+
+  def test_get_attributes_via_dynamicmbeaninterface
+    @madb.set_number_read_only 4
+    @madb.name = "Name"
+
+    assert_equal(@madb.name, @madb.getAttribute("name").get_value.to_s)
+    assert_equal(@madb.number_read_only, @madb.getAttribute("number_read_only").get_value)    
+    atts = ["name", "number_read_only"]
+    retrieved = @madb.getAttributes(atts)
+    assert_equal(2, retrieved.length)
+    #TODO: assertion comparing the types in teh array to java types
+  end
+  
+  def test_set_attributes_via_dynamicbeaninterface
+    @madb.name = "blue"
+    red = java.lang.String.new("red")
+    attribute = javax.management.Attribute.new("name", red)
+    @madb.setAttribute(attribute)
+
+    assert_equal("String", @madb.name.class.to_s )
+    assert_equal("red", @madb.name)
+  end
+  
+  def test_set_multiple_attributes_via_dynamicbeaninterface
+    @madb.name = "blue"
+    three = java.lang.Integer.new(3)
+    red = java.lang.String.new("red")
+    attribute1 = javax.management.Attribute.new("name", red)
+    attribute2 = javax.management.Attribute.new("number_write_only", three)
+    
+    @madb.setAttributes([attribute1, attribute2])    
+    assert_equal("red", @madb.name)
+    assert_equal(3, @madb.fetch_number_write_only)
+  end
+end
+

data/test/jmx_client_test.rb

@@ -0,0 +1,86 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'rmi'
+require 'jmx'
+
+PORT = 9999
+$registry = RMIRegistry.new PORT
+
+class JMXConnectorClientTest < Test::Unit::TestCase
+  URL = "service:jmx:rmi:///jndi/rmi://localhost:#{PORT}/jmxrmi"
+  
+  def setup
+    @connector = JMX::MBeanServerConnector.new(URL, JMX::MBeanServer.new)
+    @connector.start
+    @client = JMX::connect(:port => PORT)
+  end
+  
+  def teardown
+    @connector.stop
+  end
+
+  def test_invalid_mbean_name
+    assert_raises(ArgumentError) { @client["::::::"] }
+  end
+  
+  def test_get_mbean
+    memory = @client["java.lang:type=Memory"]
+    
+    assert_not_nil memory, "Could not acquire memory mbean"
+
+    # Attr form
+    heap = memory[:HeapMemoryUsage]
+    assert_not_nil heap
+    assert(heap[:used] > 0, "No heap used?  Impossible!")
+
+    # underscored form
+    heap = memory.heap_memory_usage
+    assert_not_nil heap
+    assert(heap.used > 0, "No heap used?  Impossible!")
+  end
+
+  def test_set_mbean
+    memory = @client["java.lang:type=Memory"]
+    original_verbose = memory.verbose
+    memory.verbose = !original_verbose
+    assert(memory.verbose != original_verbose, "Could not change verbose")
+
+    memory[:Verbose] = original_verbose
+    assert(memory[:Verbose] == original_verbose, "Could not change back verbose")
+  end
+
+  def test_attributes
+    memory = @client["java.lang:type=Memory"]
+    assert(memory.attributes.include?("HeapMemoryUsage"), "HeapMemoryUsage not found")
+  end
+
+  def test_operations
+    memory = @client["java.lang:type=Memory"]
+    assert(memory.operations.include?("gc"), "gc not found")
+  end
+
+
+  def test_simple_operation
+    memory = @client["java.lang:type=Memory"]
+
+    heap1 = memory[:HeapMemoryUsage][:used]
+    memory.gc
+    heap2 = memory[:HeapMemoryUsage][:used]
+
+    assert(heap1.to_i >= heap2.to_i, "GC did not collect")
+  end
+  
+  def test_query_names
+    names = @client.query_names("java.lang:type=MemoryPool,*")
+    assert(names.size > 0, "No memory pools. Impossible!")
+   
+    a_memory_pool_bean = @client[names.to_array[0]]
+    assert_not_nil a_memory_pool_bean, "Name must resolve to something"
+
+    usage = a_memory_pool_bean[:Usage]
+    assert_not_nil usage, "Memory pools have usage"
+    
+    assert_not_nil usage[:used], "Some memory is used"
+  end
+end

data/test/jmx_server_test.rb

@@ -0,0 +1,129 @@
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'rmi'
+require 'jmx'
+
+class MyDynamicMBean < RubyDynamicMBean
+  rw_attribute :name, :string, "My sample attribute"
+  r_attribute :explicit_reader, :int, "Sample int with writer", :my_reader
+  w_attribute :explicit_writer, :int, "Sample int with writer", :my_writer
+  rw_attribute :explicit_both, :int, "Sample int with writer", :my_read, :my_write
+
+  operation "Doubles a value"
+  parameter :int, "a", "Value to double"
+  returns :int
+  def double(a)
+    a + a
+  end
+
+  operation "Doubles a string"
+  parameter :string, "a", "Value to double" 
+  returns :string  
+  def string_double(a)
+    a + a
+  end
+  
+  operation "Give me foo"
+  returns :string
+  def foo
+    "foo"
+  end
+  
+  operation "Concatentates a list"
+  parameter :list, "list", "List to concatenate"
+  returns :string
+  def concat(list)
+    list.inject("") { |memo, element| memo << element.to_s }
+  end
+
+  def my_reader
+    42
+  end
+
+  def my_writer(value)
+    @name = value.to_s
+  end
+
+  def my_read
+    @frogger
+  end
+
+  def my_write(value)
+    @frogger = value
+  end
+end
+
+class MyExtendedDynamicMBean < MyDynamicMBean
+  operation "Triples a value"
+  parameter :int, "a", "Value to triple"
+  returns :int
+  def triple(a)
+    a + a + a
+  end
+end
+
+class JMXServerTest < Test::Unit::TestCase
+  PORT = 9999
+  URL = "service:jmx:rmi:///jndi/rmi://localhost:#{PORT}/jmxrmi"
+  
+  def setup
+    @registry = RMIRegistry.new PORT
+    @server = JMX::MBeanServer.new
+    @connector = JMX::MBeanServerConnector.new(URL, @server)
+    @connector.start
+    @client = JMX::connect(:port => PORT)
+    reg_mbean
+  end
+
+  def reg_mbean
+    dyna = MyDynamicMBean.new("domain.MySuperBean", "Heh")
+    @domain = @server.default_domain
+    @server.register_mbean dyna, "#{@domain}:type=MyDynamicMBean"
+    @bean = @client["#{@domain}:type=MyDynamicMBean"]
+  end
+
+  def unreg_mbean
+    @server.unregister_mbean "#{@domain}:type=MyDynamicMBean"
+  end
+
+  def teardown
+    @connector.stop
+    @registry.stop
+    unreg_mbean
+  end
+  
+  
+  def test_ruby_mbean
+    assert_equal("foo", @bean.foo)
+    assert_equal(6, @bean.double(3))
+    assert_raise(TypeError) { puts @bean.double("HEH") }
+    assert_equal("hehheh", @bean.string_double("heh"))
+    assert_equal("123", @bean.concat([1,2,3]))
+  end
+
+  def test_ruby_mbean_attribtues
+    assert_nil(@bean.name)
+    @bean.name = "Name"
+    assert_equal("Name", @bean.name)
+
+    assert_equal(42, @bean.explicit_reader)
+    @bean.explicit_writer = 69
+    # explicit_writer changes attribute name as a side-effect
+    assert_equal("69", @bean.name)
+
+    @bean.explicit_both = 1
+    assert_equal(1, @bean.explicit_both)
+  end
+
+  def test_extended_mbean
+    dyna = MyExtendedDynamicMBean.new("domain.MySuperBean", "Heh")
+    @server.register_mbean dyna, "#{@domain}:type=MyExtendedDynamicMBean"
+    @bean = @client["#{@domain}:type=MyExtendedDynamicMBean"]
+
+    assert_equal(12, @bean.triple(4))
+
+    @server.unregister_mbean "#{@domain}:type=MyExtendedDynamicMBean"
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: tobias-jmx
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.8"
+platform: ruby
+authors: 
+  - Thomas Enebo & Jay McGaffigan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-29 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Install this gem and require 'jmx' to load the library.
+email: tom.enebo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - Manifest.txt
+  - LICENSE.txt
+files: 
+  - Manifest.txt
+  - Rakefile
+  - README.md
+  - LICENSE.txt
+  - lib/jmx.rb
+  - lib/rmi.rb
+  - lib/jmx/dynamic_mbean.rb
+  - lib/jmx/server.rb
+  - lib/jmx/version.rb
+  - samples/memory.rb
+  - test/jmx_attribute_test.rb
+  - test/jmx_client_test.rb
+  - test/jmx_server_test.rb
+  - .gemtest
+has_rdoc: true
+homepage: http://github.com/enebo/jmxjr
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --main
+  - README.txt
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: jruby-extras
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: Package for interacting/creating Java Management Extensions
+test_files: []
+