RubyGems - jruby-jms - Versions diffs - 0.10.2 → 0.11.0 - Mend

jruby-jms 0.10.2 → 0.11.0

Files changed (70) hide show

data/HISTORY.md +15 -0
data/README.md +27 -28
data/Rakefile +7 -1
data/doc/classes/JMS.html +265 -0
data/doc/classes/JMS/BytesMessage.html +215 -0
data/doc/classes/JMS/Connection.html +1145 -0
data/doc/classes/JMS/MapMessage.html +333 -0
data/doc/classes/JMS/Message.html +1085 -0
data/doc/classes/JMS/MessageConsumer.html +316 -0
data/doc/classes/JMS/MessageListenerImpl.html +262 -0
data/doc/classes/JMS/ObjectMessage.html +170 -0
data/doc/classes/JMS/OracleAQConnectionFactory.html +184 -0
data/doc/classes/JMS/QueueBrowser.html +155 -0
data/doc/classes/JMS/Session.html +947 -0
data/doc/classes/JMS/SessionPool.html +411 -0
data/doc/classes/JMS/TextMessage.html +194 -0
data/doc/created.rid +1 -0
data/doc/files/README_md.html +440 -0
data/doc/files/lib/jms/bytes_message_rb.html +122 -0
data/doc/files/lib/jms/connection_rb.html +140 -0
data/doc/files/lib/jms/imports_rb.html +108 -0
data/doc/files/lib/jms/logging_rb.html +129 -0
data/doc/files/lib/jms/map_message_rb.html +122 -0
data/doc/files/lib/jms/message_consumer_rb.html +122 -0
data/doc/files/lib/jms/message_listener_impl_rb.html +122 -0
data/doc/files/lib/jms/message_rb.html +122 -0
data/doc/files/lib/jms/object_message_rb.html +122 -0
data/doc/files/lib/jms/oracle_a_q_connection_factory_rb.html +122 -0
data/doc/files/lib/jms/queue_browser_rb.html +122 -0
data/doc/files/lib/jms/session_pool_rb.html +108 -0
data/doc/files/lib/jms/session_rb.html +164 -0
data/doc/files/lib/jms/text_message_rb.html +122 -0
data/doc/files/lib/jms_rb.html +131 -0
data/doc/fr_class_index.html +39 -0
data/doc/fr_file_index.html +42 -0
data/doc/fr_method_index.html +120 -0
data/doc/index.html +24 -0
data/doc/rdoc-style.css +208 -0
data/examples/advanced/session_pool.rb +37 -0
data/examples/client-server/replier.rb +29 -0
data/examples/client-server/requestor.rb +40 -0
data/examples/jms.yml +85 -9
data/examples/performance/consumer.rb +6 -8
data/examples/performance/producer.rb +10 -10
data/examples/producer-consumer/browser.rb +24 -0
data/examples/{consumer.rb → producer-consumer/consumer.rb} +5 -4
data/examples/producer-consumer/consumer_async.rb +30 -0
data/examples/{producer.rb → producer-consumer/producer.rb} +5 -3
data/examples/publish-subscribe/publish.rb +24 -0
data/examples/publish-subscribe/subscribe.rb +31 -0
data/lib/jms/bytes_message.rb +52 -0
data/lib/jms/connection.rb +170 -162
data/lib/jms/imports.rb +21 -0
data/lib/jms/logging.rb +17 -1
data/lib/jms/{javax_jms_map_message.rb → map_message.rb} +2 -2
data/lib/jms/message.rb +285 -0
data/lib/jms/{javax_jms_message_consumer.rb → message_consumer.rb} +6 -3
data/lib/jms/{message_listener.rb → message_listener_impl.rb} +3 -3
data/lib/jms/{javax_jms_object_message.rb → object_message.rb} +1 -1
data/lib/jms/oracle_a_q_connection_factory.rb +35 -0
data/lib/jms/{javax_jms_queue_browser.rb → queue_browser.rb} +5 -4
data/lib/jms/{javax_jms_session.rb → session.rb} +23 -25
data/lib/jms/session_pool.rb +148 -0
data/lib/jms/{javax_jms_text_message.rb → text_message.rb} +1 -1
data/test/connection_test.rb +31 -29
data/test/jms.yml +8 -9
data/test/message_test.rb +29 -29
data/test/session_test.rb +39 -39
metadata +62 -22
data/lib/jms/javax_jms_message.rb +0 -264

data/doc/created.rid ADDED Viewed

	@@ -0,0 +1 @@
1	+ Tue, 19 Apr 2011 10:13:57 -0400

data/doc/files/README_md.html ADDED Viewed

@@ -0,0 +1,440 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: README.md</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>README.md</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>README.md
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Mon Apr 18 10:06:20 -0400 2011</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+## jruby-jms
+</p>
+<ul>
+<li><a
+href="http://github.com/reidmorrison/jruby-jms">github.com/reidmorrison/jruby-jms</a>
+</li>
+</ul>
+<p>
+### Current Activities &amp; Backward Compatibility
+</p>
+<p>
+The API is relatively stable at this point and I do not expect any breaking
+changes at this point.
+</p>
+<p>
+There may still be some minor changes to the API to make things better
+and/or simpler. Once the code goes to V1.0.0 I will make every effort to
+not break the existing interface in any way.
+</p>
+<p>
+### Feedback is welcome and appreciated :)
+</p>
+<p>
+### Introduction
+</p>
+<p>
+jruby-jms attempts to &quot;rubify&quot; the Java <a
+href="../classes/JMS.html">JMS</a> API without compromising performance. It
+does this by sprinkling &quot;Ruby-goodness&quot; into the existing <a
+href="../classes/JMS.html">JMS</a> Java interfaces, I.e. By adding Ruby
+methods to the existing classes and interfaces. Since jruby-jms exposes the
+<a href="../classes/JMS.html">JMS</a> Java classes directly there is no
+performance impact that would have been introduced had the entire API been
+wrapped in a Ruby layer.
+</p>
+<p>
+In this way, using regular Ruby constructs a Ruby program can easily
+interact with <a href="../classes/JMS.html">JMS</a> in a highly performant
+way. Also, in this way you are not limited to whatever the Ruby wrapper
+would have exposed, since the entire <a href="../classes/JMS.html">JMS</a>
+API is available to you at any time.
+</p>
+<p>
+The initial internal use version of JRuby-<a
+href="../classes/JMS.html">JMS</a> was created in 2008. It has been in use
+in production since 2009.
+</p>
+<p>
+### Install
+</p>
+<pre>
+    jgem install jruby-jms
+</pre>
+<p>
+### Simplification
+</p>
+<p>
+One of the difficulties with the regular <a
+href="../classes/JMS.html">JMS</a> API is that it use completely separate
+classes for Topics and Queues in <a href="../classes/JMS.html">JMS</a> 1.1.
+This means that once a program writes to a Queue for example, that without
+changing the program it could not be changed to write to a topic. Also a
+consumer on a topic or a queue are identical. jruby-jms fixes this issue by
+allowing you to have a Consumer or Producer that is independent of whether
+it is producing or consuming to/from or a Topic or a Queue. The complexity
+of which <a href="../classes/JMS.html">JMS</a> class is used is taken care
+of by jruby-jms.
+</p>
+<p>
+## Concepts &amp; Terminology
+</p>
+<p>
+### Java Message Service (<a href="../classes/JMS.html">JMS</a>) API
+</p>
+<p>
+The <a href="../classes/JMS.html">JMS</a> API is a standard interface part
+of Java EE 6 as a way for programs to send and receive messages through a
+messaging and queuing system.
+</p>
+<p>
+For more information on the <a href="../classes/JMS.html">JMS</a> API: <a
+href="http://download.oracle.com/javaee/6/api/index.html?javax/jms/package-summary.html">download.oracle.com/javaee/6/api/index.html?javax/jms/package-summary.html</a>
+</p>
+<p>
+### Broker / Queue Manager
+</p>
+<p>
+Depending on which <a href="../classes/JMS.html">JMS</a> provider you are
+using they refer to their centralized server as either a Broker or Queue
+Manager. The Broker or Queue Manager is the centralized &quot;server&quot;
+through which all messages pass through.
+</p>
+<p>
+Some Brokers support an in-vm broker instance so that messages can be
+passed between producers and consumers within the same Java Virtual Machine
+(JVM) instance. This removes the need to make any network calls. Highly
+recommended for passing messages between threads in the same JVM.
+</p>
+<p>
+### Connection
+</p>
+<p>
+In order to connect to any broker the Client <a
+href="../classes/JMS.html">JMS</a> application must create a connection. In
+traditional <a href="../classes/JMS.html">JMS</a> a ConnectionFactory is
+used to create connections. In jruby-jms the <a
+href="../classes/JMS/Connection.html">JMS::Connection</a> takes care of the
+complexities of dealing with the factory class, just pass the required
+parameters to Connection.new at it takes care of the rest.
+</p>
+<p>
+### Queue
+</p>
+<p>
+A queue used for holding messages. 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.
+</p>
+<p>
+### Topic
+</p>
+<p>
+Instead of sending messages to a single queue, a topic can be used to
+publish messages and allow multiple consumers to register for messages that
+match the topic they are interested in
+</p>
+<p>
+### Producer
+</p>
+<p>
+Producers write messages to queues or topics
+</p>
+<p>
+ActiveMQ Example:
+</p>
+<pre>
+    require 'rubygems'
+    require 'jms'
+    # Connect to ActiveMQ
+    config = {
+      :factory =&gt; 'org.apache.activemq.ActiveMQConnectionFactory',
+      :broker_url =&gt; 'tcp://localhost:61616',
+      :require_jars =&gt; [
+        &quot;~/Applications/apache-activemq-5.5.0/activemq-all-5.5.0.jar&quot;,
+        &quot;~/Applications/apache-activemq-5.5.0/lib/optional/slf4j-log4j12-1.5.11.jar&quot;,
+        &quot;~/Applications/apache-activemq-5.5.0/lib/optional/log4j-1.2.14.jar&quot;
+      ]
+    }
+    JMS::Connection.session(config) do |session|
+      session.producer(:queue_name =&gt; 'ExampleQueue') do |producer|
+        producer.send(session.message(&quot;Hello World&quot;))
+      end
+    end
+</pre>
+<p>
+### Consumer
+</p>
+<p>
+Consumers read message from a queue or topic
+</p>
+<p>
+ActiveMQ Example:
+</p>
+<pre>
+    require 'rubygems'
+    require 'jms'
+    # Connect to ActiveMQ
+    config = {
+      :factory =&gt; 'org.apache.activemq.ActiveMQConnectionFactory',
+      :broker_url =&gt; 'tcp://localhost:61616',
+      :require_jars =&gt; [&quot;~/Applications/apache-activemq-5.4.2/activemq-all-5.4.2.jar&quot;]
+    }
+    JMS::Connection.session(config) do |session|
+      session.consume(:queue_name =&gt; 'ExampleQueue', :timeout=&gt;1000) do |message|
+        p message
+      end
+    end
+</pre>
+<p>
+## Overview
+</p>
+<p>
+jruby-jms is a complete JRuby API into the Java Messaging Specification (<a
+href="../classes/JMS.html">JMS</a>) V1.1 followed by several <a
+href="../classes/JMS.html">JMS</a> Providers.
+</p>
+<p>
+## Threading
+</p>
+<p>
+A <a href="../classes/JMS/Connection.html">JMS::Connection</a> instance can
+be shared between threads, whereas a session, consumer, producer, and any
+artifacts created by the session should only be used by one thread at a
+time.
+</p>
+<p>
+For consumers, it is recommended to create a session for each thread and
+leave that thread blocked on Consumer.receive. Or, even better use
+Connection.on_message which will create a session, within which any message
+received from the specified queue or topic match will be passed to the
+block.
+</p>
+<p>
+## Logging
+</p>
+<p>
+jruby-jms detects the logging available in the current environment. When
+running under Rails it will use the Rails logger, otherwise the standard
+Ruby logger. The logger can also be replaced by calling Connection.logger=
+</p>
+<p>
+## Dependencies
+</p>
+<p>
+### <a href="../classes/JMS.html">JMS</a> V1.1 Provider
+</p>
+<p>
+In order to communicate with a <a href="../classes/JMS.html">JMS</a> V 1.1
+provider jruby-jms needs the jar files supplied by the <a
+href="../classes/JMS.html">JMS</a> provider. As in the examples above the
+jar files can be specified in the configuration element :require_jars.
+Otherwise, the jars must be explicitly required in the Ruby code:
+</p>
+<pre>
+  `require &quot;~/Applications/apache-activemq-5.4.2/activemq-all-5.4.2.jar&quot;`
+</pre>
+<p>
+### JRuby
+</p>
+<p>
+jruby-jms has been tested against JRuby 1.5.1 and 1.6.1, but should work
+with any current JRuby version.
+</p>
+<p>
+## Development
+</p>
+<p>
+Want to contribute to jruby-jms?
+</p>
+<p>
+First clone the repo and run the tests:
+</p>
+<pre>
+    git clone git://github.com/reidmorrison/jruby-jms.git
+    cd jruby-jms
+    jruby -S rake test
+</pre>
+<p>
+Feel free to submit any issues and we&#8216;ll try to resolve it.
+</p>
+<p>
+## Contributing
+</p>
+<p>
+Once you&#8216;ve made your great commits:
+</p>
+<ol>
+<li>[Fork](<a
+href="http://help.github.com/forking">help.github.com/forking</a>/)
+jruby-jms
+</li>
+<li>Create a topic branch - `git checkout -b my_branch`
+</li>
+<li>Push to your branch - `git push origin my_branch`
+</li>
+<li>Create an [Issue](<a
+href="http://github.com/reidmorrison/jruby-jms/issues">github.com/reidmorrison/jruby-jms/issues</a>)
+with a link to your branch
+</li>
+<li>That&#8216;s it!
+</li>
+</ol>
+<p>
+## Meta
+</p>
+<ul>
+<li>Code: `git clone git://github.com/reidmorrison/jruby-jms.git`
+</li>
+<li>Home: &lt;<a
+href="http://github.com/reidmorrison/jruby-jms">github.com/reidmorrison/jruby-jms</a>&gt;
+</li>
+<li>Bugs: &lt;<a
+href="http://github.com/reidmorrison/jruby-jms/issues">github.com/reidmorrison/jruby-jms/issues</a>&gt;
+</li>
+<li>Gems: &lt;<a
+href="http://rubygems.org/gems/jruby-jms">rubygems.org/gems/jruby-jms</a>&gt;
+</li>
+</ul>
+<p>
+This project uses [Semantic Versioning](<a
+href="http://semver.org">semver.org</a>/).
+</p>
+<p>
+## Author
+</p>
+<table>
+<tr><td valign="top">Reid Morrison :: rubywmq@gmail.com :</td><td>@reidmorrison
+</td></tr>
+</table>
+<p>
+## License
+</p>
+<p>
+Copyright 2008 - 2011 J. Reid Morrison
+</p>
+<p>
+Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
+you may not use this file except in compliance with the License. You may
+obtain a copy of the License at
+</p>
+<pre>
+    http://www.apache.org/licenses/LICENSE-2.0
+</pre>
+<p>
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an &quot;AS IS&quot; 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.
+</p>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/files/lib/jms/bytes_message_rb.html ADDED Viewed

@@ -0,0 +1,122 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: bytes_message.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>bytes_message.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/jms/bytes_message.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Fri Apr 15 15:56:42 -0400 2011</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Copyright 2008, 2009, 2010, 2011 J. Reid Morrison
+</p>
+<p>
+Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
+you may not use this file except in compliance with the License. You may
+obtain a copy of the License at
+</p>
+<pre>
+    http://www.apache.org/licenses/LICENSE-2.0
+</pre>
+<p>
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an &quot;AS IS&quot; 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.
+</p>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>