jruby-jms 0.9.0

data/HISTORY.md

@@ -0,0 +1,13 @@
+## 0.9.0 (2011-01-23)
+
+* Revised API with cleaner interface
+* Publish GEM
+
+## 0.8.0 (2011-01-22)
+
+* Release to the wild for general use
+
+## 2008, 2009, 2010
+
+* Previously known as jms4jruby
+* Running in production at an enterprise processing a million messages a day

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 2008, 2009, 2010, 2011 J. Reid Morrison, 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,276 @@
+jruby-jms
+=========
+
+* http://github.com/reidmorrison/jruby-jms
+
+### Current Activities & Backward Compatibility
+
+Currently reviewing Logging which uses Apache Commons logging by default.
+For now add the following Apache Commons and log4j libraries to your classpath
+* commons-logging-1.1.1.jar
+* log4j-1.2.16.jar
+
+Please read the source files for now for documentation. Looking into rdoc doc
+generation issue.
+
+There may still be some 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.
+
+Feedback is welcome and appreciated :)
+* Need input on Logging and any other tips and tricks on extending Interfaces
+** For example, currently cannot override Interface methods with JRuby versions
+   (See Session::create_session, which is Session::session at this time)
+* Looking for ideas on the best way to specify jar files so that they can be
+  'required' by jruby-jms rather than having to use the classpath
+* Need to get rdoc working for 
+
+### Introduction
+
+jruby-jms has been around in my toolbox since 2008. Since I was not an expert
+in JMS I have held off releasing to the wild. I believe it is now of sufficient 
+quality and usefulness to release into the wild. In fact it has been used
+in production at an enterprise site for 2 years now.
+
+jruby-jms attempts to "rubify" the Java JMS API without 
+compromising performance. It does this by sprinkling "Ruby-goodness" into the
+existing JMS Java interfaces, I.e. By adding Ruby methods to the existing 
+classes and interfaces. Since jruby-jms exposes the JMS
+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 JMS in a highly performant way. Also, in this way you are not
+limited to whatever the Ruby wrapper would have exposed, since the entire JMS
+API is available to you at any time.
+
+### Install
+
+  gem install jruby-jms
+
+### Simplification
+
+One of the difficulties with the regular JMS API is that it use completely
+separate classes for Topics and Queues in JMS 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 JMS class is used is taken care
+of by jruby-jms.
+
+Concepts & Terminology
+----------------------
+
+### Java Message Service (JMS) API
+
+The JMS 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.
+
+For more information on the JMS API: http://download.oracle.com/javaee/6/api/index.html?javax/jms/package-summary.html
+
+### Broker / Queue Manager
+
+Depending on which JMS 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 "server" through which all messages pass through.
+
+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.
+
+### Connection
+
+In order to connect to any broker the Client JMS application must create a
+connection. In traditional JMS a ConnectionFactory is used to create connections.
+In jruby-jms the JMS::Connection 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.
+
+### Queue
+
+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.
+
+### Topic
+
+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
+
+### Producer
+
+Producers write message to a queue or topic
+
+ActiveMQ Example:
+  require 'rubygems'
+
+  # Include Active MQ Jar files (Not required if already in classpath)
+  require '~/Applications/apache-activemq-5.4.2/activemq-all-5.4.2.jar'
+
+  # Include Apache Commons Logging Jar file (For now, if not already in classpath)
+  require '~/Applications/apache-activemq-5.4.2/lib/commons-logging-1.1.jar'
+  require '~/Applications/apache-activemq-5.4.2/lib/optional/log4j-1.2.14.jar'
+
+  # Include JMS after ActiveMQ
+  require 'jms'
+
+  # Connect to ActiveMQ
+  config = {
+    :factory => 'org.apache.activemq.ActiveMQConnectionFactory',
+    :broker_url => 'tcp://localhost:61616'
+  }
+
+  JMS::Connection.session(config) do |session|
+    session.producer(:q_name => 'ExampleQueue') do |producer|
+      producer.send(session.message("Hello World"))
+    end
+  end
+
+### Consumer
+
+Consumers read message from a queue or topic
+
+Example:
+  require 'rubygems'
+
+  # Include Active MQ Jar files (Not required if already in classpath)
+  require '~/Applications/apache-activemq-5.4.2/activemq-all-5.4.2.jar'
+
+  # Include Apache Commons Logging Jar file (For now, if not already in classpath)
+  require '~/Applications/apache-activemq-5.4.2/lib/commons-logging-1.1.jar'
+  require '~/Applications/apache-activemq-5.4.2/lib/optional/log4j-1.2.14.jar'
+
+  # Include JMS after ActiveMQ
+  require 'jms'
+
+  # Connect to ActiveMQ
+  config = {
+    :factory => 'org.apache.activemq.ActiveMQConnectionFactory',
+    :broker_url => 'tcp://localhost:61616'
+  }
+
+  JMS::Connection.session(config) do |session|
+    session.consume(:q_name => 'ExampleQueue', :timeout=>1000) do |message|
+      p message
+    end
+  end
+
+Overview
+--------
+
+jruby-jms is a complete JRuby API into the Java Messaging Specification (JMS) 
+followed by many JMS Providers.
+
+In order to communicate with a JMS provider jruby-jms needs the jar files in the
+CLASSPATH that are supplied by the JMS Provider.
+
+Threading
+---------
+
+A JMS::Connection 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.
+
+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.
+
+### Example
+
+Logging
+-------
+
+jruby-jms currently uses Apache Commons logging, but this is subject to changes
+since many users of jruby-jms will want to use the Rails logger
+
+Dependencies
+------------
+
+### JRuby
+
+jruby-jms has been tested against JRuby 1.5.1, but should work with any
+current JRuby version.
+
+### JMS
+
+Every JMS Provider has details on which jar files to include in your CLASSPATH
+for their JMS client to work. Some examples for connection settings are covered
+in the Connection.new documentation
+
+Development
+-----------
+
+Want to contribute to jruby-jms?
+
+First clone the repo and run the tests:
+
+    git clone git://github.com/reidmorrison/jruby-jms.git
+    cd jruby-jms
+    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-jms.git`
+* Home: <http://github.com/reidmorrison/jruby-jms>
+* Docs: <http://jruby-jms.github.com/jruby-jms/>
+* Bugs: <http://github.com/reidmorrison/jruby-jms/issues>
+* List: TBA
+* Gems: <http://gemcutter.org/gems/jruby-jms>
+
+This project uses [Semantic Versioning][sv].
+
+
+Author
+------
+
+Reid Morrison :: rubywmq@gmail.com :: @reidmorrison
+
+[1]: http://help.github.com/forking/
+[2]: http://github.com/reidmorrison/jruby-jms/issues
+[sv]: http://semver.org/
+
+License
+-------
+
+Copyright 2008, 2009, 2010, 2011  J. Reid Morrison
+
+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.