jmx4r 0.0.1

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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.

data/README.txt

@@ -0,0 +1 @@
+jmx4r is a JMX library for JRuby

data/Rakefile

@@ -0,0 +1,62 @@
+require "rake/testtask"
+require "rake/rdoctask"
+require "rake/gempackagetask"
+
+require "rubygems"
+
+dir     = File.dirname(__FILE__)
+lib     = File.join(dir, "lib", "jmx4r.rb")
+version = "0.0.1"
+
+task :default => [:test]
+
+Rake::TestTask.new do |test|
+  test.libs       << "test"
+  test.test_files =  ["test/ts_all.rb"]
+  test.verbose    = false
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.include( "README.txt", "LICENSE.txt",
+                           "lib/" )
+  rdoc.main     = "README.txt"
+  rdoc.rdoc_dir = "doc/html"
+  rdoc.title    = "jmx4r Documentation"
+end
+
+spec = Gem::Specification.new do |spec|
+  spec.name     = "jmx4r"
+  spec.version  = version 
+  spec.platform = Gem::Platform::RUBY
+  spec.summary  = "jmx4r is a JMX library for JRuby"
+  spec.files    = Dir.glob("{examples,lib,test}/**/*.rb") + ["Rakefile"]
+
+  spec.test_suite_file  =  "test/ts_all.rb"
+  spec.has_rdoc         =  true
+  spec.extra_rdoc_files =  %w{README.txt LICENSE.txt}
+  spec.rdoc_options     << '--title' << 'jmx4r Documentation' <<
+                           '--main'  << 'README.txt'
+
+  spec.require_path      = 'lib'
+
+  spec.author            = "Jeff Mesnil"
+  spec.email             = "jmesnil@gmail.com"
+  spec.rubyforge_project = "jmx4r"
+  spec.homepage          = "http://code.google.com/p/jmx4r/"
+  spec.description       = <<END_DESC
+TODO
+END_DESC
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+desc "Show library's code statistics"
+task :stats do
+  require 'code_statistics'
+  CodeStatistics.new( ["jmx4r", "lib"], 
+                      ["Functionals", "examples"], 
+                      ["Units", "test"] ).to_s
+end

data/examples/class_loading.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'jmx4r'
+
+class_loading = JMX::MBean.find_by_name "java.lang:type=ClassLoading"
+
+# implicite way...
+class_loading.attributes.keys.each { |attr| puts "#{attr}: #{class_loading.send attr}"}
+
+puts "--"
+
+# ... or explicite
+puts "loaded class count: #{class_loading.loaded_class_count}"
+puts "total loaded class count: #{class_loading.total_loaded_class_count}"
+puts "unloaded class count: #{class_loading.unloaded_class_count}"
+puts "verbose: #{class_loading.verbose}"

data/examples/jvm_mngmt.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env jruby
+require 'jmx4r'
+
+#JMX::MBean.establish_connection :host => "localhost", :port => 3000
+
+logging = JMX::MBean.find_by_name "java.util.logging:type=Logging"
+logging.logger_names.each do |logger_name|
+    logging.set_logger_level logger_name, "INFO"
+end
+
+memory = JMX::MBean.find_by_name "java.lang:type=Memory"
+memory.verbose = true
+memory.gc

data/examples/logging.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env jruby
+
+require 'jmx4r'
+
+logging = JMX::MBean.find_by_name "java.util.logging:type=Logging"
+puts "--"
+logging.logger_names.sort.each do |logger|
+    level = logging.get_logger_level logger
+    puts "#{logger} #{level}"
+end
+puts "--"
+
+if ARGV.length == 1
+   level = ARGV[0]
+   puts "set all loggers to #{level}"
+   logging.logger_names.each do |logger|
+       logging.set_logger_level logger, level
+   end    
+end
+
+if ARGV.length == 2
+   logger = ARGV[0]
+   level = ARGV[1]
+   puts "set #{logger} to #{level}"
+   logging.set_logger_level logger, level
+end

data/examples/memory.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env jruby
+
+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}"
+    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
+
+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   
+end

data/lib/jconsole.rb

@@ -0,0 +1,32 @@
+
+module JConsole
+    def JConsole.start(port=3000) 
+        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
+        EOCMD
+
+        Thread.start { system cmd } 
+        sleep 2
+    end
+
+    def JConsole.stop()
+        jconsole_pid = `ps a -o pid,command | grep -w jconsole |  grep -v grep | grep -v ruby | cut -c -5`
+        `kill #{jconsole_pid}` if jconsole_pid != ""
+        sleep 2
+    end
+end
+
+if ARGV.length == 1
+    case ARGV[0]
+    when "start"
+        JConsole::start
+        puts "started jconsole"
+    when "stop"
+        JConsole::stop
+        puts "stopped jconsole"
+    end
+end

data/lib/jmx4r.rb

@@ -0,0 +1,92 @@
+require 'java'
+
+class String
+    # Transform a CamelCase String to a snake_case String.
+    #--
+    # Code has been taken from ActiveRecord
+    def snake_case
+        self.to_s.gsub(/::/, '/').
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            tr("-", "_").
+            downcase
+    end
+end
+
+module JMX
+    class MBean
+        include_package 'javax.management'
+        include_package 'javax.management.remote'
+        include_class 'java.util.HashMap'
+
+        attr_reader :object_name, :operations, :attributes
+
+        def initialize(object_name)
+            @mbsc = MBean.establish_connection
+            @object_name = object_name
+            info = @mbsc.getMBeanInfo @object_name
+            @attributes = Hash.new
+            info.attributes.each do | mbean_attr |
+                @attributes[mbean_attr.name.snake_case] = mbean_attr.name
+                self.class.instance_eval do 
+                    define_method mbean_attr.name.snake_case do
+                        @mbsc.getAttribute @object_name, "#{mbean_attr.name}"
+                    end
+                end
+                if mbean_attr.isWritable
+                    self.class.instance_eval do
+                        define_method "#{mbean_attr.name.snake_case}=" do |value| 
+                            attr = Attribute.new mbean_attr.name, value
+                            @mbsc.setAttribute @object_name, attr
+                        end
+                    end
+                end
+            end
+            @operations = Hash.new
+            info.operations.each do |mbean_op|
+                param_types = mbean_op.signature.map {|param| param.type}
+                @operations[mbean_op.name.snake_case] = [mbean_op.name, param_types]
+            end
+        end
+
+        def method_missing(method, *args, &block)
+            if @operations.keys.include?(method.to_s)
+                op_name, param_types = @operations[method.to_s]
+                @mbsc.invoke @object_name,
+                    op_name,
+                    args.to_java(:Object),
+                    param_types.to_java(:String)
+            else
+                super
+            end
+        end
+
+        def self.establish_connection(args={})
+            host = args[:host] || "localhost"
+            port = args[:port] || 3000
+            @@mbsc ||= begin
+                url = "service:jmx:rmi:///jndi/rmi://#{host}:#{port}/jmxrmi"
+                connector = JMXConnectorFactory::connect JMXServiceURL.new(url), HashMap.new
+                connector.getMBeanServerConnection
+            end
+        end
+
+        def self.remove_connection
+            @@mbsc = nil
+        end
+
+        def self.mbsc 
+            establish_connection
+        end
+
+        def self.find_all_by_name(name)
+            object_name = ObjectName.new(name)
+            object_names = MBean.mbsc.queryNames(object_name, nil)
+            object_names.map { |on| MBean.new(on) }
+        end
+
+        def self.find_by_name(name)
+            MBean.new ObjectName.new(name)
+        end
+    end
+end

data/test/tc_attributes.rb

@@ -0,0 +1,34 @@
+require "test/unit"
+
+require "jmx4r"
+require "jconsole"
+
+class TestAttribute < Test::Unit::TestCase
+    def setup
+        JConsole::start
+        @memory = JMX::MBean.find_by_name "java.lang:type=Memory"
+    end
+
+    def teardown
+        JMX::MBean.remove_connection
+        JConsole::stop
+    end
+
+    def test_unknwown_attribute
+        assert_raise(NoMethodError) { @memory.unknown_attribute }
+    end
+
+    def test_readable_attribute
+        assert_equal false, @memory.verbose
+    end
+
+    def test_writable_attribute
+        assert_equal false, @memory.verbose
+        @memory.verbose = true
+        assert_equal true, @memory.verbose
+    end
+
+    def test_non_writable_attribute
+        assert_raise(NoMethodError) { @memory.object_pending_finalization_count = -1 }
+    end
+end

data/test/tc_connection.rb

@@ -0,0 +1,34 @@
+require "test/unit"
+
+require "jmx4r"
+require "jconsole"
+
+class TestConnection < Test::Unit::TestCase
+    def teardown
+        JMX::MBean.remove_connection
+        JConsole::stop
+    end
+
+    def test_establish_connection_with_bad_port
+        assert_raise(NativeException) { 
+             JMX::MBean.establish_connection :port => 9999
+        }
+    end
+
+    def test_establish_connection_with_bad_host
+        assert_raise(NativeException) { 
+             JMX::MBean.establish_connection :host => "not a valid host"
+        }
+    end
+
+    def test_establish_connection
+        JConsole::start
+        JMX::MBean.establish_connection
+    end
+
+    def test_establish_connection_with_custom_port
+        JConsole::start 3001
+        JMX::MBean.establish_connection :port => 3001
+    end
+
+end

data/test/ts_all.rb

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

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+homepage: http://code.google.com/p/jmx4r/
+extensions: []
+executables: []
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+post_install_message: 
+date: 2007-06-24 22:00:00 +00:00
+files: 
+- examples/class_loading.rb
+- examples/jvm_mngmt.rb
+- examples/logging.rb
+- examples/memory.rb
+- lib/jconsole.rb
+- lib/jmx4r.rb
+- test/tc_connection.rb
+- test/tc_attributes.rb
+- test/ts_all.rb
+- Rakefile
+- README.txt
+- LICENSE.txt
+rubygems_version: 0.9.4
+rdoc_options: 
+- --title
+- jmx4r Documentation
+- --main
+- README.txt
+signing_key: 
+cert_chain: 
+name: jmx4r
+has_rdoc: true
+platform: ruby
+summary: jmx4r is a JMX library for JRuby
+default_executable: 
+bindir: bin
+required_ruby_version: !ruby/object:Gem::Version::Requirement
+  version: 
+  requirements: 
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 0.0.0
+require_paths: 
+- lib
+specification_version: 1
+test_files: 
+- test/ts_all.rb
+dependencies: []
+description: TODO
+authors: 
+- Jeff Mesnil
+email: jmesnil@gmail.com
+extra_rdoc_files: 
+- README.txt
+- LICENSE.txt
+requirements: []
+rubyforge_project: jmx4r
+autorequire: