trinidad_lifecycle_extension 0.1.0 → 0.2.0

data/README

@@ -6,10 +6,6 @@ Trinidad's server context as well as each application context that runs on top
 of Trinidad.
 
 
-[WARNING] This extension is completely experimental and has not been tested nor
-published yet.
-
-
 Configuration
 =============
 
@@ -24,6 +20,24 @@ Trinidad will try to load each class into that directory and add it to the
 approrpiated context regarding where the extension will be configured, into the
 server section or into the web_app section.
 
+This extension also allows to enable the jmx monitoring capabilities of Tomcat.
+The configuration that Tomcat needs can be set as JAVA_OPTS properties or
+through the Trinidad's configuration file:
+
+extensions:
+  lifecycle:
+    jmx:
+      port: 9000 # not required, 8181 by default
+      authenticate: true # not required, false by default
+      ssl_enabled: #not required
+      ssl_cypher_suites: #not required
+      ssl_auth: # not required
+      password_file: # not required
+      access_file: #not required
+
+See the Tomcat's documention for a complete references of the options:
+
+  http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html
 
 How to write a lifecycle listener
 =================================

data/lib/trinidad_lifecycle_extension.rb

@@ -5,7 +5,12 @@ require 'trinidad/extensions'
 module Trinidad
   module Extensions
     module Lifecycle
-      VERSION = '0.1.0'
+      VERSION = '0.2.0'
+
+      DEFAULT_JMX_OPTIONS = {
+        :port => '8181',
+        :authenticate => false
+      }
 
       def init_listeners(context, path, mod_name)
         Dir.glob("#{path}/*.rb").each do |listener|
@@ -31,7 +36,35 @@ module Trinidad
       include Lifecycle
 
       def configure(tomcat)
-        init_listeners(tomcat.server, @options[:path], 'Trinidad::Lifecycle::Server')
+        if @options.has_key?(:path)
+          init_listeners(tomcat.server, @options[:path], 'Trinidad::Lifecycle::Server')
+        end
+        if @options.has_key?(:jmx)
+          export_jmx_settings
+
+          require File.expand_path('../../trinidad-libs/tomcat-catalina-jmx-remote', __FILE__)
+          tomcat.server.add_lifecycle_listener(org.apache.catalina.mbeans.JmxRemoteLifecycleListener.new)
+        end
+      end
+
+      def export_jmx_settings
+        options = DEFAULT_JMX_OPTIONS.merge(@options[:jmx] || {})
+
+        set_property("com.sun.management.jmxremote", "true")
+        set_property("com.sun.management.jmxremote.port", options[:port])
+
+        set_property("com.sun.management.jmxremote.ssl", options[:ssl_enabled])
+        set_property("com.sun.management.jmxremote.ssl.enabled.protocols", options[:ssl_protocols])
+        set_property("com.sun.management.jmxremote.ssl.enabled.cipher.suites", options[:ssl_cypher_suites])
+        set_property("com.sun.management.jmxremote.ssl.need.client.auth", options[:ssl_auth])
+        set_property("com.sun.management.jmxremote.authenticate", options[:authenticate])
+        set_property("com.sun.management.jmxremote.password.file", options[:password_file])
+        set_property("com.sun.management.jmxremote.access.file", options[:access_file])
+      end
+
+      private
+      def set_property(name, option)
+        java.lang.System.set_property(name, option) if option
       end
     end
 

data/spec/trinidad_lifecycle_extension_spec.rb

@@ -18,6 +18,29 @@ describe 'Trinidad lifecycle extension' do
       subject.configure(@tomcat)
       @tomcat.server.findLifecycleListeners().should have(1).listener
     end
+
+    it "adds the jmx lifecycle listener when the jmx option is true" do
+      ext = Trinidad::Extensions::LifecycleServerExtension.new({:jmx => nil})
+      ext.configure(@tomcat)
+      @tomcat.server.findLifecycleListeners().should have(1).listener
+    end
+
+    it "exports jmx option when is enabled" do
+      ext = Trinidad::Extensions::LifecycleServerExtension.new({:jmx => nil})
+      ext.configure(@tomcat)
+
+      java.lang.System.get_property("com.sun.management.jmxremote").should == 'true'
+      java.lang.System.get_property("com.sun.management.jmxremote.port").should == '8181'
+    end
+
+    it "exports custom jmx option when it exists" do
+      ext = Trinidad::Extensions::LifecycleServerExtension.new({
+        :jmx => {:ssl_enabled => 'true'}
+      })
+      ext.configure(@tomcat)
+
+      java.lang.System.get_property("com.sun.management.jmxremote.ssl").should == 'true'
+    end
   end
 
   context "when it's a webapp extension" do

data/trinidad_lifecycle_extension.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'trinidad_lifecycle_extension'
-  s.version           = '0.1.0'
-  s.date              = '2010-09-12'
+  s.version           = '0.2.0'
+  s.date              = '2010-09-26'
   s.rubyforge_project = 'trinidad_lifecycle_extension'
 
   ## Make sure your summary is short. The description may be as long
@@ -59,6 +59,7 @@ Gem::Specification.new do |s|
     spec/spec.opts
     spec/spec_helper.rb
     spec/trinidad_lifecycle_extension_spec.rb
+    trinidad-libs/tomcat-catalina-jmx-remote.jar
     trinidad_lifecycle_extension.gemspec
   ]
   # = MANIFEST =

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: trinidad_lifecycle_extension
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - David Calavera
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-12 00:00:00 +02:00
+date: 2010-09-26 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -37,6 +36,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/trinidad_lifecycle_extension_spec.rb
+- trinidad-libs/tomcat-catalina-jmx-remote.jar
 - trinidad_lifecycle_extension.gemspec
 has_rdoc: true
 homepage: http://github.com/calavera/trinidad_lifecycle_extension
@@ -52,7 +52,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -61,7 +60,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"