jmx4r 0.0.1 → 0.0.2

data/README.txt

@@ -1 +1,18 @@
-jmx4r is a JMX library for JRuby
+jmx4r is a JMX library for JRuby.
+
+It can be used to write simple Ruby scripts running on JRuby[http://jruby.org]
+to manage remote Java applications (e.g. JBoss[http://www.jboss.org],
+Tomcat[http://tomcat.apache.org/]) using 
+JMX[http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/].
+
+== Examples 
+
+To trigger a garbage collection on a Java application:
+
+  require 'rubygems'
+  require 'jmx4r'
+  
+  JMX::MBean.establish_connection :host => "localhost", :port => 3000
+  memory = JMX::MBean.find_by_name "java.lang:type=Memory"
+  memory.gc
+

data/Rakefile

@@ -6,7 +6,7 @@ require "rubygems"
 
 dir     = File.dirname(__FILE__)
 lib     = File.join(dir, "lib", "jmx4r.rb")
-version = "0.0.1"
+version = "0.0.2"
 
 task :default => [:test]
 
@@ -22,6 +22,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.main     = "README.txt"
   rdoc.rdoc_dir = "doc/html"
   rdoc.title    = "jmx4r Documentation"
+  rdoc.options << "-S"
 end
 
 spec = Gem::Specification.new do |spec|
@@ -44,7 +45,7 @@ spec = Gem::Specification.new do |spec|
   spec.rubyforge_project = "jmx4r"
   spec.homepage          = "http://code.google.com/p/jmx4r/"
   spec.description       = <<END_DESC
-TODO
+jmx4r is a JMX library for JRuby
 END_DESC
 end
 
@@ -57,6 +58,6 @@ desc "Show library's code statistics"
 task :stats do
   require 'code_statistics'
   CodeStatistics.new( ["jmx4r", "lib"], 
-                      ["Functionals", "examples"], 
+                      ["Examples", "examples"], 
                       ["Units", "test"] ).to_s
 end

data/lib/jconsole.rb

@@ -1,14 +1,21 @@
 
 module JConsole
-    def JConsole.start(port=3000) 
+    def JConsole.start(args={})
+        port = args[:port] || 3000
+        pwd_file = args[:pwd_file]
+        access_file = args[:access_file]
+
         cmd =<<-EOCMD.split("\n").join(" ")
             jconsole
             -J-Dcom.sun.management.jmxremote 
             -J-Dcom.sun.management.jmxremote.port=#{port} 
             -J-Dcom.sun.management.jmxremote.ssl=false 
-            -J-Dcom.sun.management.jmxremote.authenticate=false
+            -J-Dcom.sun.management.jmxremote.authenticate=#{!pwd_file.nil?}
         EOCMD
-
+        if pwd_file
+          cmd << " -J-Dcom.sun.management.jmxremote.password.file=#{pwd_file}" 
+          cmd << " -J-Dcom.sun.management.jmxremote.access.file=#{access_file}"
+        end 
         Thread.start { system cmd } 
         sleep 2
     end

data/lib/jmx4r.rb

@@ -64,9 +64,17 @@ module JMX
         def self.establish_connection(args={})
             host = args[:host] || "localhost"
             port = args[:port] || 3000
+            username = args[:username]
+            password = args[:password]
+
             @@mbsc ||= begin
                 url = "service:jmx:rmi:///jndi/rmi://#{host}:#{port}/jmxrmi"
-                connector = JMXConnectorFactory::connect JMXServiceURL.new(url), HashMap.new
+                env = HashMap.new
+                if !username.nil? and username.length > 0
+                  credentials = [username, password]
+                  env.put JMXConnector::CREDENTIALS, credentials.to_java(:String)
+                end
+                connector = JMXConnectorFactory::connect JMXServiceURL.new(url), env 
                 connector.getMBeanServerConnection
             end
         end

data/test/mbean_base.rb

@@ -0,0 +1,44 @@
+require 'java'
+
+class MBeanBase < java.lang.Object
+  include_package 'javax.management'
+  include DynamicMBean
+
+  attr_reader :attributes
+
+  def initialize
+    @attributes = []
+  end 
+  
+  def getMBeanInfo
+    begin
+      mbean_attrs = @attributes.map do |attr|
+        MBeanAttributeInfo.new attr.to_s, attr.to_s, "java.lang.String", true, false, false
+      end
+      MBeanInfo.new(self.class.to_s, self.class.to_s,
+                  mbean_attrs.to_java('javax.management.MBeanAttributeInfo'),
+                  #[].to_java('javax.management.MBeanAttributeInfo'), 
+                  [].to_java('javax.management.MBeanConstructorInfo'),
+                  [].to_java('javax.management.MBeanOperationInfo'),
+                  [].to_java('javax.management.MBeanNotificationInfo'))
+    rescue 
+      puts $!
+    end
+  end
+end
+
+class TestMBean < MBeanBase
+  #mbean_attr_reader :hello
+
+  def initialize
+    super
+    @hello = "world"
+  end
+end
+
+require 'remote_server'
+server = RemoteServer.new
+server.start
+mbean = TestMBean.new
+mbean.attributes << :hello
+server.connector_server.getMBeanServer.register_mbean mbean, ObjectName.new("jmx4r:type=Test")

data/test/remote_server.rb

@@ -0,0 +1,33 @@
+require 'java'
+include_class 'javax.management.ObjectName'
+
+class RemoteServer
+  include_package 'java.rmi.registry'
+  include_package 'java.lang.management'
+  include_package 'javax.management.remote'
+  include_package 'javax.management'
+
+  attr_reader :connector_server
+
+  def start(port=3000)
+
+    LocateRegistry.createRegistry(port);
+
+    mbs = ManagementFactory.platform_mbean_server
+    url = JMXServiceURL.new "service:jmx:rmi:///jndi/rmi://:#{port}/jmxrmi"
+    @connector_server = JMXConnectorServerFactory.newJMXConnectorServer url, nil , mbs
+    @connector_server.start
+  end
+
+  def stop
+    @connector_server.stop
+  end
+end
+
+include_class 'javax.management.StandardMBean'
+
+module Test
+  def hello
+    puts "hello"
+  end
+end

data/test/tc_auth.rb

@@ -0,0 +1,54 @@
+require "test/unit"
+
+require "jmx4r"
+require "jconsole"
+
+class TestAuthentication < Test::Unit::TestCase
+
+  def setup
+    @username = "jmx4r.user"
+    @password = "jmx4r.password"
+
+    pwd_path = "/tmp/jmx4r.password"
+    @pwd_file = File.new(pwd_path, "w")
+    @pwd_file.puts "#{@username} #{@password}"
+    @pwd_file.close
+    
+    # pwd file must be readable only by user
+    # but somehow File.chmod is not working
+    # with JRuby
+    `chmod 0600 #{@pwd_file.path}`
+    
+    access_path = "/tmp/jmx4r.access"
+    @access_file = File.new(access_path, "w")
+    @access_file.puts "#{@username} readwrite"
+    @access_file.close
+    # access file must be readable only by user
+    `chmod 0600 #{@access_file.path}`
+
+    JConsole::start :pwd_file => @pwd_file.path, :access_file => @access_file.path
+  end
+
+  def teardown
+    JMX::MBean.remove_connection
+    JConsole::stop
+    File.delete @pwd_file.path if File.file? @pwd_file.path
+    File.delete @access_file.path if File.file? @access_file.path
+  end
+
+  def test_establish_auth_connection_with_correct_credentials
+    JMX::MBean.establish_connection :username => @username, :password => @password 
+  end
+
+  def test_establish_auth_connection_with_incorrect_credentials
+    assert_raise(NativeException) {
+      JMX::MBean.establish_connection :username => "not a valid user name", :password => @password
+    }
+  end
+
+  def test_establish_auth_connection_with_no_credentials
+    assert_raise(NativeException) {
+      JMX::MBean.establish_connection
+    }
+  end
+end

data/test/tc_connection.rb

@@ -27,8 +27,7 @@ class TestConnection < Test::Unit::TestCase
     end
 
     def test_establish_connection_with_custom_port
-        JConsole::start 3001
+        JConsole::start :port => 3001
         JMX::MBean.establish_connection :port => 3001
     end
-
 end

data/test/toto.rb

@@ -0,0 +1,15 @@
+require 'java'
+
+class A < java.lang.Object
+  def A.dsl_method(*args)
+    puts args.join(', ')
+  end
+end
+
+class B < A
+  dsl_method :a, :b
+end
+
+b = B.new
+
+

data/test/ts_all.rb

@@ -1,4 +1,5 @@
 require "test/unit"
 
 require "tc_connection"
+require "tc_auth"
 require "tc_attributes"

metadata

@@ -3,9 +3,9 @@ homepage: http://code.google.com/p/jmx4r/
 extensions: []
 executables: []
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 post_install_message: 
-date: 2007-06-24 22:00:00 +00:00
+date: 2007-06-26 22:00:00 +00:00
 files: 
 - examples/class_loading.rb
 - examples/jvm_mngmt.rb
@@ -15,7 +15,11 @@ files:
 - lib/jmx4r.rb
 - test/tc_connection.rb
 - test/tc_attributes.rb
+- test/remote_server.rb
 - test/ts_all.rb
+- test/tc_auth.rb
+- test/mbean_base.rb
+- test/toto.rb
 - Rakefile
 - README.txt
 - LICENSE.txt
@@ -45,7 +49,7 @@ specification_version: 1
 test_files: 
 - test/ts_all.rb
 dependencies: []
-description: TODO
+description: jmx4r is a JMX library for JRuby
 authors: 
 - Jeff Mesnil
 email: jmesnil@gmail.com