jruby-hornetq 0.2.0.alpha

data/HISTORY.md

@@ -0,0 +1,5 @@
+
+
+## 0.0.1 (2011-01-18)
+
+* Alpha release.

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 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 2011 Clarity Services, Inc.
+
+   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.md

@@ -0,0 +1,249 @@
+jruby-hornetq
+=============
+
+* http://github.com/ClarityServices/jruby-hornetq
+
+### WARNING: Alpha code!!
+
+This code should only be used for prototyping at this time, since breaking
+changes are made between every release. Once the code goes to V1.0.0 we will
+make every effort to not break the existing interface in any way.
+
+Feedback is welcome and appreciated :)
+
+### Introduction
+
+jruby-hornetq attempts to "rubify" the HornetQ Java libraries without 
+compromising performance. It does this by sprinkling "Ruby-goodness" into the
+existing HornetQ Java classes and interfaces, I.e. By adding Ruby methods to
+the existing classes and interfaces. Since jruby-hornetq exposes the HornetQ
+Java classes directly there is no performance impact that would have been
+introduced had the entire API been wrapped in a Ruby layer.
+
+In this way, using regular Ruby constructs a Ruby program can easily
+interact with HornetQ in a highly performant way
+
+### Install
+
+  gem install jruby-hornetq
+
+### Important
+
+jruby-hornetq exposes the HornetQ Core API, not its JMS API. There are
+several reasons for choosing the HornetQ Core API over its JMS API:
+* The Core API supports the use of Addresses, not just Queues
+* The Core API exposes more capabilities than the JMS API (E.g. Management APIs)
+* The HornetQ team recommend the Core API for performance
+* The HornetQ JMS API is just another wrapper on top of its Core API
+
+To use the JMS API, see the jruby-jms project. (Not yet released into the wild,
+let me know if you want it :) )
+
+HornetQ
+-------
+
+For information on the HornetQ messaging and queuing system, see:
+
+Concepts & Terminology
+----------------------
+
+### Queue
+
+In order to read messages a consumer needs to the read messages from a queue.
+The queue is defined prior to the message being sent and is used to hold the
+messages. The consumer does not have to be running in order to receive messages.
+
+### Address
+
+In traditional messaging and queuing systems there is only a queue when both
+read and writing messages. With the advent of AMQP and in HornetQ we now have 
+the concept of an Address which is different from a Queue.
+
+An Address can be thought of the address we would put on an envelope before
+mailing it. We do not have to have any knowlegde of the USPS infrastructure
+to mail the letter. In HornetQ we Address a message and in HornetQ the Address
+is routed to one or more Queues.
+
+### Durable
+
+Messages in HornetQ can be marked as durable which means they will be persisted
+to disk to prevent message loss in the event of a power failure or other system
+failure. This does however mean that every durable message does incur the
+overhead of a disk write every time it is read or written (produced or consumed).
+
+### Broker
+
+HornetQ is a broker based architecture which requires the use of one or more
+centralized brokers. A broker is much like the "server" through which all 
+messages pass through.
+
+An in-vm broker can be used for passing messages around within a Java
+Virtual Machine (JVM) instance without making network calls. Highly recommended
+for passing messages between threads in the same JVM.
+
+### Consumer
+
+### Producer
+
+### Asynchronous Messaging
+
+It is recommended to keep the state of the message flow in the message itself.
+
+### Synchronous Messaging
+
+### Messaging Patterns
+
+### Message Priority
+
+
+Overview
+--------
+
+jruby-hornetq is primarily intended to make it easy to use the HornetQ client
+core API. It also supports running the HornetQ broker for scenarios such as
+in-vm messaging.
+
+The examples below address some of the messaging patterns that are used in 
+messaging and queuing.
+
+Producer-Consumer
+-----------------
+
+Producer: Write messages to a queue:
+
+  ....
+
+Consumer: Read message from a queue: 
+  ....
+
+Client-Server
+-------------
+
+
+Threading
+---------
+
+A factory instance can be shared between threads, whereas a session and any
+artifacts created by the session should only be used by one thread at a time.
+
+For consumers, it is recommended to create a session for each thread and leave
+that thread blocked on ClientConsumer::receive
+A timeout can be used if the thread needs to do any other work. At this time
+it is Not recommended to use ClientConsumer::receive_immediate across
+multiple threads due to known issues in HornetQ with this API.
+
+### Example
+
+Logging
+-------
+
+Dependencies
+------------
+
+### JRuby
+
+jruby-hornetq has been tested against JRuby 1.5.1, but should work with any
+current JRuby version.
+
+### HornetQ
+
+The libraries required for the HornetQ Client and to start a simple Core API
+only Broker are included with the Gem.
+
+### GenePool
+ 
+GenePool is used to implement session pooling
+
+Running the Broker
+------------------
+
+Not only does jruby-hornetq make it easy to work with HornetQ from JRuby as a
+client, it also supports using JRuby to launch a Broker instance
+
+### Example Usage
+
+#### Starting up a standalone hornetq server:
+
+  bin/hornetq_server examples/standalone_server.yml
+
+#### Starting up a backup/live combination
+
+  bin/hornetq_server examples/backup_server.yml
+  bin/hornetq_server examples/live_server.yml
+
+Development
+-----------
+
+Want to contribute to jruby-hornetq?
+
+First clone the repo and run the tests:
+
+    git clone git://github.com/reidmorrison/jruby-hornetq.git
+    cd jruby-hornetq
+    jruby -S rake test
+
+Feel free to ping the mailing list with any issues and we'll try to resolve it.
+
+
+Contributing
+------------
+
+Once you've made your great commits:
+
+1. [Fork][1] Resque
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create an [Issue][2] with a link to your branch
+5. That's it!
+
+You might want to checkout our [Contributing][cb] wiki page for information
+on coding standards, new features, etc.
+
+
+Mailing List
+------------
+
+TBA
+
+Meta
+----
+
+* Code: `git clone git://github.com/reidmorrison/jruby-hornetq.git`
+* Home: <http://github.com/reidmorrison/jruby-hornetq>
+* Docs: <http://jruby-hornetq.github.com/jruby-hornetq/>
+* Bugs: <http://github.com/reidmorrison/jruby-hornetq/issues>
+* List: TBA
+* Gems: <http://gemcutter.org/gems/jruby-hornetq>
+
+This project uses [Semantic Versioning][sv].
+
+
+Authors
+-------
+
+Reid Morrison :: rubywmq@gmail.com :: @reidmorrison
+Brad Pardee :: bpardee@gmail.com
+
+[1]: http://help.github.com/forking/
+[2]: http://github.com/reidmorrison/jruby-hornetq/issues
+[sv]: http://semver.org/
+
+License
+-------
+
+Copyright 2011 Clarity Services, Inc.
+
+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.
+
+jruby-hornetq includes files from HornetQ, which is also licensed under
+the Apache License, Version 2.0: http://www.jboss.org/hornetq

data/Rakefile

@@ -0,0 +1,23 @@
+raise "jruby-hornetq must be built with JRuby: try again with `jruby -S rake'" unless defined?(JRUBY_VERSION)
+
+require 'rake/clean'
+require 'date'
+require 'java'
+
+desc "Build gem"
+task :gem  do |t|
+  gemspec = Gem::Specification.new do |s|
+    s.name = 'jruby-hornetq'
+    s.version = '0.2.0.alpha'
+    s.author = 'Reid Morrison'
+    s.email = 'rubywmq@gmail.com'
+    s.homepage = 'http://www.reidmorrison.com/'
+    s.date = Date.today.to_s
+    s.description = 'JRuby-HornetQ is a Java and Ruby library that exposes the HornetQ Java API in a ruby friendly way. For JRuby only.'
+    s.summary = 'JRuby interface into HornetQ'
+    s.files = FileList["./**/*"].exclude('*.gem', './nbproject/*').map{|f| f.sub(/^\.\//, '')}
+    s.has_rdoc = true
+    s.add_dependency "gene_pool", "~> 1.1.1"
+  end
+  Gem::Builder.new(gemspec).build
+end

data/bin/hornetq_server

@@ -0,0 +1,70 @@
+#!/usr/bin/env jruby
+
+require 'yaml'
+
+raise 'Environment variable HORNETQ_HOME not set' unless ENV['HORNETQ_HOME']
+require "#{ENV['HORNETQ_HOME']}/lib/hornetq-core.jar"
+require "#{ENV['HORNETQ_HOME']}/lib/netty.jar"
+
+unless ARGV[0]
+  $stderr.puts "Usage: hornetq_server <yml-file>"
+  exit 1
+end
+yaml = YAML.load_file(ARGV[0])
+data_directory = yaml['data_directory'] || './data'
+host = yaml['host'] || 'localhost'
+port = yaml['port'] || 5445
+
+config = Java::org.hornetq.core.config.impl.ConfigurationImpl.new
+config.persistence_enabled = false
+config.security_enabled = false
+config.paging_directory = "#{data_directory}/paging"
+config.bindings_directory = "#{data_directory}/bindings"
+config.journal_directory = "#{data_directory}/journal"
+config.journal_min_files = 10
+config.large_messages_directory = "#{data_directory}/large-messages"
+
+if Java::org.hornetq.core.journal.impl.AIOSequentialFileFactory.isSupported
+  config.journal_type = Java::org.hornetq.core.server.JournalType::ASYNCIO
+else
+  puts("AIO wasn't located on this platform, it will fall back to using pure Java NIO. If your platform is Linux, install LibAIO to enable the AIO journal");
+  config.journal_type = Java::org.hornetq.core.server.JournalType::NIO
+end
+
+netty_acceptor_class_name = Java::org.hornetq.core.remoting.impl.netty.NettyAcceptorFactory.java_class.name
+netty_connector_class_name = Java::org.hornetq.core.remoting.impl.netty.NettyConnectorFactory.java_class.name
+
+transport_conf_params = java.util.HashMap.new
+transport_conf_params.put('host', host)
+transport_conf_params.put('port', java.lang.Integer.new(port))
+transport_conf = Java::org.hornetq.api.core.TransportConfiguration.new(netty_acceptor_class_name, transport_conf_params);
+
+transport_conf_set = java.util.HashSet.new
+transport_conf_set.add(transport_conf)
+
+config.acceptor_configurations = transport_conf_set
+
+if yaml['backup']
+  puts "backup"
+  config.backup = true
+  config.shared_store = false
+elsif yaml['backup_host']
+  puts "live"
+  backup_params = java.util.HashMap.new
+  backup_params.put('host', yaml['backup_host'])
+  backup_port = yaml['backup_port'] || 5445
+  backup_params.put('port', java.lang.Integer.new(backup_port))
+  #backup_params.put('reconnectAttempts', -1)
+  backup_connector_conf = Java::org.hornetq.api.core.TransportConfiguration.new(netty_connector_class_name, backup_params);
+  
+  connector_conf_map = java.util.HashMap.new
+  connector_conf_map.put('backup-connector', backup_connector_conf)
+  
+  config.connector_configurations = connector_conf_map
+  config.backup_connector_name = 'backup-connector'
+else
+  puts 'standalone'
+end
+
+server = Java::org.hornetq.core.server.HornetQServers.newHornetQServer(config)
+server.start

data/examples/backup_server.yml

@@ -0,0 +1,4 @@
+backup: true
+data_directory: ../data_backup
+host: 0.0.0.0
+port: 5446

data/examples/batch_client.rb

@@ -0,0 +1,124 @@
+#
+# HornetQ Batch Requestor:
+#      Submit a batch of requests and wait for replies
+#
+
+# Allow examples to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'yaml'
+require 'hornetq'
+require 'sync'
+
+total_count = (ARGV[0] || 100).to_i
+batching_size = (ARGV[1] || 10).to_i
+timeout = (ARGV[2] || 10000).to_i
+request_address = 'jms.queue.ExampleQueue'
+
+config = YAML.load_file(File.dirname(__FILE__) + '/hornetq.yml')['development']
+
+class BatchClient
+  def initialize(session, request_address)
+    @producer = session.create_producer(request_address)
+    reply_queue = "#{request_address}.#{Java::java.util::UUID.randomUUID.toString}"
+    begin
+      session.create_temporary_queue(reply_queue, reply_queue)
+    rescue NativeException => exc
+      p exc
+    end
+    @consumer = session.create_consumer(reply_queue)
+    @session = session
+    session.start
+    
+    @counter_sync = Sync.new
+    @counter = 0
+  end
+  
+  # Increment Message Counter
+  def inc_counter(total_count=1)
+    @counter_sync.synchronize(:EX) { @counter += total_count }
+  end
+
+  # Decrement Message counter
+  def dec_counter(total_count=1)
+    @counter_sync.synchronize(:EX) { @counter -= total_count }
+  end
+  
+  # Return the current message count
+  def counter
+    @counter_sync.synchronize(:SH) { @counter }
+  end
+  
+  # Send x messages
+  def send(total_count)
+    #print "Sending #{total_count} messages"
+    start_time = Time.now
+    total_count.times do |i|
+      message = @session.create_message(HornetQClient::Message::TEXT_TYPE,false)
+      message.reply_to_queue_name = @consumer.queue_name
+      message << "Request Current Time. #{i}"
+      @producer.send(message)
+      print "."
+      #puts "Sent:#{message}"
+    end
+    duration = Time.now - start_time
+    #printf "\nSend %5d msg, %5.2f s, %10.2f msg/s\n", total_count, duration, total_count/duration
+  end
+  
+  # Receive Reply messages
+  def receive
+    print "Receiving messages"
+    begin
+      while reply = @consumer.receive
+        print '@'
+        #        puts "Received:#{reply}, [#{reply.body}]"
+        inc_counter(1)
+        reply.acknowledge
+      end
+    rescue Exception => exc
+      p exc
+    end
+  end
+  
+  def close
+    @producer.close
+    @consumer.close
+    @session.delete_queue(@consumer.queue_name)
+  end
+end
+
+# Create a HornetQ session
+HornetQClient::Factory.create_session(config) do |session|
+  batching_size = total_count if batching_size > total_count
+  
+  client = BatchClient.new(session, request_address)
+  
+  # Start receive thread
+  receive_thread = Thread.new {client.receive}
+  
+  times = (total_count/batching_size).to_i
+  puts "Performing #{times} loops"
+  count = 0
+  times.times do |i|
+    client.send(batching_size)
+    count += batching_size
+    # Wait for at least 80% of responses
+    loop do
+      #puts "Waiting for receive"
+      sleep 0.1
+      received_count = client.counter
+      #puts "\nReceived #{received_count} messages"
+      if received_count >= 0.8 * count
+        puts ""
+        break 
+      end
+    end
+  end
+  
+  while client.counter < total_count
+    sleep 0.1
+    print "*"
+  end
+  client.close
+end