jmx 0.5 → 0.6

data/Manifest.txt

@@ -1,6 +1,6 @@
 Manifest.txt
 Rakefile
-README.txt
+README.md
 LICENSE.txt
 lib/jmx
 lib/jmx.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

@@ -1,4 +1,4 @@
-MANIFEST = FileList["Manifest.txt", "Rakefile", "README.txt", "LICENSE.txt", "lib/**/*", "samples/*","test/**/*"]
+MANIFEST = FileList["Manifest.txt", "Rakefile", "README.md", "LICENSE.txt", "lib/**/*", "samples/*","test/**/*"]
 
 file "Manifest.txt" => :manifest
 task :manifest do

data/lib/jmx/dynamic_mbean.rb

@@ -109,67 +109,86 @@ class RubyDynamicMBean
   # TODO: preserve any original method_added?
   # TODO: Error handling here when it all goes wrong?
   def self.method_added(name) #:nodoc:
-    return if local_hash[:op].nil?
-    local_hash[:op].name = name
-    operations << local_hash[:op].to_jmx
-    local_hash[:op] = nil
+    return if metadata[:op].nil?
+    metadata[:op].name = name
+    operations << metadata[:op].to_jmx
+    metadata[:op] = nil
   end
 
-  def self.attributes #:nodoc:
-    local_hash[:attrs] ||= []
+  # 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
   
-  def self.operations #:nodoc:
-    local_hash[:ops] ||= []
+  # All operations in this class
+  def self.operations
+    metadata[:ops] ||= []
   end
 
-  def self.define_getter(name, type)
+  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(instance_variable_get('@' + name))
+      javax.management.Attribute.new name, value_proc.call(__send__(reader))
     end
   end
 
-  def self.define_setter(name, type)
+  def self.define_setter(name, type, writer)
     value_converter = JMX::JavaTypeAware.to_ruby(type)
 
-    define_method("jmx_set_#{name.downcase}") do |value| 
-      instance_variable_set '@' + name, value_converter.call(value)
-    end    
+    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)
+  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
-    attr_accessor name
-    define_getter name, type
-    define_setter name, type
+    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)
+  def self.r_attribute(name, type, description, reader=nil)
     name = name.to_s
     attributes << JMX::Attribute.new(name, type, description, true, false).to_jmx
-    attr_reader name
-    define_getter name, type
+    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)
+  def self.w_attribute(name, type, description, writer=nil)
     name = name.to_s
     attributes << JMX::Attribute.new(name, type, description, false, true).to_jmx
-    attr_writer name
-    define_setter name, type
+    define_setter name, type, writer
   end
 
   # Use the operation method to declare the start of an operation
@@ -182,7 +201,7 @@ class RubyDynamicMBean
   #++
   def self.operation(description)
     # Wait to error check until method_added so we can know method name
-    local_hash[:op] = JMX::Operation.new description
+    metadata[:op] = JMX::Operation.new description
   end
 
   # Used to declare a parameter (you can declare more than one in succession) that
@@ -192,7 +211,7 @@ class RubyDynamicMBean
   #     def start
   #     end
   def self.parameter(type, name=nil, description=nil)
-    local_hash[:op].parameters << JMX::Parameter.new(type, name, description)
+    metadata[:op].parameters << JMX::Parameter.new(type, name, description)
   end
 
   # Used to declare the return type of the operation
@@ -202,18 +221,19 @@ class RubyDynamicMBean
   #     def set_name
   #     end
   def self.returns(type)
-    local_hash[:op].return_type = type
+    metadata[:op].return_type = type
   end
   
   # Thread local storage for the derived bean
-  def self.local_hash
-    Thread.current[self.name] ||= {}
+  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.operations.to_java MBeanOperationInfo
-    attributes = self.class.attributes.to_java MBeanAttributeInfo
+    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
 

data/lib/jmx/version.rb

@@ -1,3 +1,3 @@
 module JMX
-  VERSION = "0.5"
+  VERSION = "0.6"
 end

data/test/jmx_attribute_test.rb

@@ -20,6 +20,10 @@ class MyAttributeDynamicBean < RubyDynamicMBean
   def fetch_number_write_only
     @number_write_only
   end
+
+  def my_reader
+    42
+  end
 end
 
 
@@ -74,6 +78,5 @@ class JMXAttributeTest < Test::Unit::TestCase
     assert_equal("red", @madb.name)
     assert_equal(3, @madb.fetch_number_write_only)
   end
-  
 end
 

data/test/jmx_client_test.rb

@@ -1,5 +1,3 @@
-# In order to run these tests you must be running GFv2
-
 $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 
 require 'test/unit'

data/test/jmx_server_test.rb

@@ -1,7 +1,3 @@
-# 
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
- 
 
 $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 
@@ -11,6 +7,9 @@ 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"
@@ -38,6 +37,31 @@ class MyDynamicMBean < RubyDynamicMBean
   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
@@ -50,42 +74,56 @@ class JMXServerTest < Test::Unit::TestCase
     @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
-    dyna = MyDynamicMBean.new("domain.MySuperBean", "Heh")
-    domain = @server.default_domain
-    @server.register_mbean dyna, "#{domain}:type=MyDynamicMBean"
-    
-    # Get bean from client connector connection
-    bean = @client["#{domain}:type=MyDynamicMBean"]
-    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]))
-
-    assert_nil(bean.name)
-    bean.name = "Name"
-    assert_equal("Name", bean.name)
-  end
-
-  def test_ruby_mbean_twice
-    dyna = MyDynamicMBean.new("domain.MySuperBean", "Heh")
-    domain = @server.default_domain
-    @server.unregister_mbean "#{domain}:type=MyDynamicMBean"
-    @server.register_mbean dyna, "#{domain}:type=MyDynamicMBean"        
-    # Get bean from client connector connection
-    bean = @client["#{domain}:type=MyDynamicMBean"]
-    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]))
+    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

@@ -2,7 +2,7 @@
 name: jmx
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "0.5"
+  version: "0.6"
 platform: ruby
 authors: 
   - Thomas Enebo & Jay McGaffigan
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-18 00:00:00 -05:00
+date: 2011-03-23 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -22,12 +22,11 @@ extensions: []
 
 extra_rdoc_files: 
   - Manifest.txt
-  - README.txt
   - LICENSE.txt
 files: 
   - Manifest.txt
   - Rakefile
-  - README.txt
+  - README.md
   - LICENSE.txt
   - lib/jmx.rb
   - lib/rmi.rb

data/README.txt

@@ -1,29 +0,0 @@
-= 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.
-
-http://jruby-extras.rubyforge.org/jmx/
-
-== FEATURES/PROBLEMS:
-
-* Use '-J-Dcom.sun.management.jmxremote' to make jruby process accessible from a jruby command-line
-
-== SYNOPSIS:
-
-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