jmx4r 0.0.3 → 0.0.4

data/Rakefile

@@ -6,7 +6,7 @@ require "rubygems"
 
 dir     = File.dirname(__FILE__)
 lib     = File.join(dir, "lib", "jmx4r.rb")
-version = "0.0.3"
+version = "0.0.4"
 
 task :default => [:test]
 
@@ -17,7 +17,7 @@ Rake::TestTask.new do |test|
 end
 
 Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_files.include( "README.txt", "LICENSE.txt",
+  rdoc.rdoc_files.include( "README.txt", "LICENSE.txt", "AUTHORS.txt", 
                            "lib/" )
   rdoc.main     = "README.txt"
   rdoc.rdoc_dir = "doc/html"

data/examples/class_loading.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env jruby
 require 'rubygems'
 require 'jmx4r'
 

data/examples/memory.rb

@@ -4,18 +4,18 @@ require 'jmx4r'
 
 def display header, memory_usage
   puts header
-  memory_usage.composite_type.key_set.each do |type|
-    puts "\t#{type} : #{memory_usage.get type}"
+  memory_usage.sort.each do |key, value|
+    puts "\t#{key} : #{value}"
   end
 end
 memory = JMX::MBean.find_by_name "java.lang:type=Memory"
 
 display "Heap Memory Usage", memory.heap_memory_usage
-display "Non Heap Memory Usage", memory.heap_memory_usage
+display "Non Heap Memory Usage", memory.non_heap_memory_usage
 
 if ARGV.length == 1 and ARGV[0] == "gc"
   puts "trigger a garbage collection"
   memory.gc
   display "Heap Memory Usage", memory.heap_memory_usage
-  display "Non Heap Memory Usage", memory.heap_memory_usage   
+  display "Non Heap Memory Usage", memory.non_heap_memory_usage   
 end

data/examples/memory_on_many_nodes.rb

@@ -25,8 +25,8 @@ def display_memory_usages (ports)
 
   ports.each do |port|
     memory = JMX::MBean.find_by_name "java.lang:type=Memory", :port => port
-    heap_used = memory.heap_memory_usage.get("used")
-    non_heap_used = memory.non_heap_memory_usage.get("used")
+    heap_used = memory.heap_memory_usage["used"]
+    non_heap_used = memory.non_heap_memory_usage["used"]
     puts "| localhost:#{port} |#{heap_used.to_s.rjust(15)} |#{non_heap_used.to_s.rjust(15)} |"
   end
 

data/lib/jconsole.rb

@@ -4,6 +4,8 @@
 # is used as the target remote Java application manageable by JMX 
 # (we do not used it for its JMX capability, just because it is a ready to 
 # use Java application available with every JDK).
+#
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
 module JConsole
   
   # Start a new instance of jconsole which is accessible on port 3000.

data/lib/jmx4r.rb

@@ -15,10 +15,17 @@ class String
 end
 
 module JMX
+  require 'open_data_helper'
+  require 'jruby'
+
   class MBean
-    include_package 'javax.management'
-    include_package 'javax.management.remote'
     include_class 'java.util.HashMap'
+    include_class 'javax.management.Attribute'
+    include_class 'javax.management.ObjectName'
+    include_class 'javax.management.remote.JMXConnector'
+    include_class 'javax.management.remote.JMXConnectorFactory'
+    include_class 'javax.management.remote.JMXServiceURL'
+    JThread = java.lang.Thread
 
     attr_reader :object_name, :operations, :attributes
 
@@ -100,26 +107,50 @@ module JMX
     # Create a connection to a remote MBean server.
     # 
     # The args accepts 4 keys:
-    # [:host]     the host of the MBean server (defaults to "localhost")
-    # [:port]     the port of the MBean server (defaults to 3000)
-    # [:username] the name of the user (if the MBean server requires authentication).
-    #             No default
-    # [:password] the password of the user (if the MBean server requires authentication).
-    #             No default    
+    #
+    # [:host]        the host of the MBean server (defaults to "localhost")
+    # [:port]        the port of the MBean server (defaults to 3000)
+    # [:username]    the name of the user (if the MBean server requires authentication).
+    #                No default
+    # [:password]    the password of the user (if the MBean server requires authentication).
+    #                No default
+    # [:credentials] custom credentials (if the MBean server requires authentication).
+    #                No default. It has precedence over :username and :password (i.e. if
+    #                :credentials is specified, :username & :password are ignored)   
+    #
     def self.create_connection(args={})
       host= args[:host] || "localhost"
       port = args[:port] || 3000
       username = args[:username]
       password = args[:password]
+      credentials = args[:credentials]
       
       url = "service:jmx:rmi:///jndi/rmi://#{host}:#{port}/jmxrmi"
+      
+      unless credentials
+        if !username.nil? and username.length > 0
+          user_password_credentials = [username, password]
+          credentials = user_password_credentials.to_java(:String)
+        end
+      end
+      
       env = HashMap.new
-      if !username.nil? and username.length > 0
-        credentials = [username, password]
-        env.put JMXConnector::CREDENTIALS, credentials.to_java(:String)
+      env.put(JMXConnector::CREDENTIALS, credentials) if credentials
+
+      # the context class loader is set to JRuby's classloader when
+      # creating the JMX Connection so that classes loaded using 
+      # JRuby "require" (and not from its classpath) can also be 
+      # accessed (see issue #6)
+      begin
+        context_class_loader = JThread.current_thread.context_class_loader
+        JThread.current_thread.context_class_loader = JRuby.runtime.getJRubyClassLoader
+        
+        connector = JMXConnectorFactory::connect JMXServiceURL.new(url), env
+        connector.getMBeanServerConnection
+      ensure
+        # ... and we reset the previous context class loader
+        JThread.current_thread.context_class_loader = context_class_loader
       end
-      connector = JMXConnectorFactory::connect JMXServiceURL.new(url), env
-      connector.getMBeanServerConnection
     end
 
     # Returns an array of MBeans corresponding to all the MBeans
@@ -128,7 +159,11 @@ module JMX
     #
     # The args accepts the same keys than #create_connection and an 
     # additional one:
+    #
     # [:connection] a MBean server connection (as returned by #create_connection)
+    #               No default. It has precedence over :host and :port (i.e if
+    #               :connection is specified, :host and :port are ignored)
+    #
     def self.find_all_by_name(name, args={})
       object_name = ObjectName.new(name)
       mbsc = args[:connection] || MBean.connection(args)

data/lib/open_data_helper.rb

@@ -0,0 +1,30 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+#
+# This file adds methods to CompositeData proxies so that they can behave like
+# regular (read-only) Ruby Hash
+require 'java'
+
+JavaUtilities.extend_proxy('javax.management.openmbean.CompositeDataSupport') do
+  include Enumerable
+  def each
+    self.get_composite_type.key_set.each do |k|
+      yield(k,self.get(k))
+    end
+    self
+  end
+
+  def key?(k)
+    self.contains_key k
+  end
+  alias has_key? key?
+  alias include? key?
+  alias member? key?
+  
+  def keys
+    self.get_composite_type.key_set
+  end
+  
+  def [](key)
+    self.get key
+  end
+end

data/test/tc_attributes.rb

@@ -1,3 +1,5 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+
 require "test/unit"
 
 require "jmx4r"

data/test/tc_auth.rb

@@ -1,3 +1,5 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+
 require "test/unit"
 
 require "jmx4r"
@@ -39,6 +41,13 @@ class TestAuthentication < Test::Unit::TestCase
   def test_establish_auth_connection_with_correct_credentials
     JMX::MBean.establish_connection :username => @username, :password => @password 
   end
+  
+  # test that using the :credentials key to pass the username/password
+  # credentials is working the same way than passing :username/:password
+  def test_establish_auth_connection_with_custom_credentials
+    credentials = [@username, @password].to_java(:String)
+    JMX::MBean.establish_connection :credentials => credentials
+  end
 
   def test_establish_auth_connection_with_invalid_username
     assert_raise(NativeException) {

data/test/tc_composite_data.rb

@@ -0,0 +1,57 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+
+require "test/unit"
+
+require "jmx4r"
+require "jconsole"
+
+class TestCompositeData < Test::Unit::TestCase
+  def setup
+    JConsole::start
+    memory = JMX::MBean.find_by_name "java.lang:type=Memory"
+    # heap_memory_usage is a CompositeData
+    @heap = memory.heap_memory_usage
+  end
+
+  def teardown
+    @heap = nil
+    JMX::MBean.remove_connection
+    JConsole::stop
+  end
+  
+  # use #map to check that CompositeData includes Enumerable
+  def test_enumerable_composite_data
+    expected_headers = ["init", "committed", "used", "max"].sort
+    headers = @heap.map { |k, v| k }.sort
+    assert_equal expected_headers, headers
+  end
+
+  def test_composite_data_keys
+    expected_headers = ["init", "committed", "used", "max"].sort
+    headers = @heap.keys.sort
+    assert_equal expected_headers, headers
+  end
+
+  def test_composite_data_key_aliases
+    assert @heap.key?("used")
+    assert @heap.has_key?("used")
+    assert @heap.include?("used")
+    assert @heap.member?("used")
+  end
+  
+  def test_composite_data_as_hash
+    used = @heap.get "used"
+    used_from_hash = @heap["used"]
+    assert_equal used, used_from_hash
+  end  
+
+  def test_composite_data_as_hash_with_known_key
+    assert_equal true, @heap.key?("used")
+    used = @heap["used"]
+  end
+  
+  def test_composite_data_as_hash_with_unknown_key
+    assert_equal false, @heap.key?("unknown")
+    assert_raise(NativeException) { @heap["unknown"] }
+  end
+end

data/test/tc_connection.rb

@@ -1,3 +1,5 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+
 require "test/unit"
 
 require "jmx4r"

data/test/tc_multiple_connections.rb

@@ -1,3 +1,5 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+
 require "test/unit"
 
 require "jmx4r"

data/test/ts_all.rb

@@ -1,6 +1,9 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+
 require "test/unit"
 
 require "tc_connection"
 require "tc_auth"
 require "tc_multiple_connections"
 require "tc_attributes"
+require "tc_composite_data"

metadata

@@ -3,9 +3,9 @@ homepage: http://code.google.com/p/jmx4r/
 extensions: []
 executables: []
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 post_install_message: 
-date: 2007-07-02 22:00:00 +00:00
+date: 2007-07-26 22:00:00 +00:00
 files: 
 - examples/class_loading.rb
 - examples/jvm_mngmt.rb
@@ -14,8 +14,10 @@ files:
 - examples/memory_on_many_nodes.rb
 - lib/jconsole.rb
 - lib/jmx4r.rb
+- lib/open_data_helper.rb
 - test/tc_attributes.rb
 - test/tc_auth.rb
+- test/tc_composite_data.rb
 - test/tc_connection.rb
 - test/tc_multiple_connections.rb
 - test/ts_all.rb