jruby-jms 1.1.0-java

data/lib/jms/imports.rb

@@ -0,0 +1,21 @@
+# Import Java classes into JMS Namespace
+module JMS
+  java_import 'javax.jms.DeliveryMode'
+  java_import 'javax.jms.Message'
+  java_import 'javax.jms.BytesMessage'
+  java_import 'javax.jms.TextMessage'
+  java_import 'javax.jms.MapMessage'
+  java_import 'javax.jms.ObjectMessage'
+  java_import 'javax.jms.StreamMessage'
+  java_import 'javax.jms.Session'
+  java_import 'javax.jms.Destination'
+  java_import 'javax.jms.Queue'
+  java_import 'javax.jms.Topic'
+  java_import 'javax.jms.TemporaryQueue'
+  java_import 'javax.jms.TemporaryTopic'
+  java_import 'javax.jms.MessageConsumer'
+  java_import 'javax.jms.MessageProducer'
+  java_import 'javax.jms.QueueBrowser'
+  java_import 'javax.jms.MessageListener'
+  java_import 'javax.jms.ExceptionListener'
+end

data/lib/jms/logging.rb

@@ -0,0 +1,50 @@
+################################################################################
+#  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.
+################################################################################
+
+# Add Logging capabilities
+module JMS
+  
+  # Returns the logger being used by jruby-jms
+  # Unless previously set, it will try to use the Rails logger and if it
+  # is not present, it will return a new Ruby logger
+  def self.logger
+    @logger ||= (self.rails_logger || self.ruby_logger)
+  end
+
+  # Replace the logger for jruby-jms
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  # Use the ruby logger, but add needed trace level logging which will result
+  # in debug log entries
+  def self.ruby_logger(level=nil, target=STDOUT)
+    require 'logger'
+
+    l = ::Logger.new(target)
+    l.instance_eval "alias :trace :debug"
+    l.instance_eval "alias :trace? :debug?"
+    l.level = level || ::Logger::INFO
+    l
+  end
+
+  private
+  def self.rails_logger
+    (defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger) ||
+      (defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER.respond_to?(:debug) && RAILS_DEFAULT_LOGGER)
+  end
+
+end

data/lib/jms/map_message.rb

@@ -0,0 +1,91 @@
+################################################################################
+#  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.
+################################################################################
+
+#Interface javax.jms.MapMessage
+module JMS::MapMessage
+  # Since each is defined, add support for: inject, map, include?, and find_all?
+  # <=> also allows support for:  min, max, and sort
+  include Enumerable
+
+  # Return Map Message as a hash
+  def to_h
+    h = {}
+    each_pair {|key, value| h[key] = value}
+    h
+  end
+
+  # Return Map Message as a hash
+  def data
+    to_h
+  end
+
+  # Copy values from supplied hash into this MapMessage
+  # Converts Ruby types to Java native Data types as follows:
+  #   Fixnum   => long
+  #   Float    => double
+  #   Bignum   => long
+  #   true     => boolean
+  #   false    => boolean
+  #   nil      => null
+  #   Otherwise it calls ::to_s on the supplied data type
+  def data=(data)
+    data.each_pair do |key,val|
+      case
+      when val.class == Fixnum # 1
+        setLong(key.to_s,val)
+      when val.class == Float #1.1
+        setDouble(key.to_s,val)
+      when val.class == Bignum # 11111111111111111
+        setLong(key.to_s,val)
+      when (val.class == TrueClass) || (val.class == FalseClass)
+        setBoolean(key.to_s,val)
+      when val.class == NilClass
+        setObject(key.to_s,val)
+      else
+        setString(key.to_s,val.to_s)
+      end
+    end
+  end
+
+  # Return each name value pair
+  def each(&proc)
+    # When key and value are expected separately. Should actually be calling each_pair anyway
+    if proc.arity == 2
+      each_pair(proc)
+    else
+      enum = getMapNames
+      while enum.has_more_elements
+        key = enum.next_element
+        proc.call [key, getObject(key)]
+      end
+    end
+  end
+
+  # Return each name value pair
+  def each_pair(&proc)
+    enum = getMapNames
+    while enum.has_more_elements
+      key = enum.next_element
+      proc.call key, getObject(key)
+    end
+  end
+
+  # Does map include specified key
+  def include?(key)
+    # Ensure a Ruby true is returned
+    item_exists(key) == true
+  end
+end

data/lib/jms/message.rb

@@ -0,0 +1,285 @@
+################################################################################
+#  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.
+################################################################################
+
+# Extend JMS Message Interface with Ruby methods
+#
+# A Message is the item that can be put on a queue, or obtained from a queue.
+#
+# A Message consists of 3 major parts:
+#   - Header
+#     Accessible as attributes of the Message class
+#   - Properties
+#     Accessible via [] and []= methods
+#   - Data
+#     The actual data portion of the message
+#     See the specific message types for details on how to access the data
+#     portion of the message
+#
+# For further help on javax.jms.Message
+#   http://download.oracle.com/javaee/6/api/index.html?javax/jms/Message.html
+#
+# Interface javax.jms.Message
+module JMS::Message
+
+  # Methods directly exposed from the Java class:
+
+  # call-seq:
+  #   acknowledge
+  #
+  # Acknowledges all consumed messages of the session of this consumed message
+  #
+
+  # call-seq:
+  #   clear_body
+  #
+  #  Clears out the message body
+  #
+
+  # call-seq:
+  #   clear_properties
+  #
+  #  Clears out the properties of this message
+  #
+
+  # For Backward compatibility with JRuby prior to 1.6
+  # JRuby 1.6 now does all this for us. Thank you headius :)
+  unless self.instance_methods.include? :jms_delivery_mode
+
+    # Header Fields - Attributes of the message
+
+    # Returns the JMS Delivery Mode
+    # One of the following will be returned
+    #   JMS::DeliveryMode::PERSISTENT
+    #   JMS::DeliveryMode::NON_PERSISTENT
+    def jms_delivery_mode
+      getJMSDeliveryMode
+    end
+
+    # Set the JMS Delivery Mode
+    # Values can be
+    #   JMS::DeliveryMode::PERSISTENT
+    #   JMS::DeliveryMode::NON_PERSISTENT
+    def jms_delivery_mode=(mode)
+      raise "Sorry, due to incompatibility with JRuby 1.6, please call jms_delivery_mode_sym when using symbols" if mode.is_a? Symbol
+      self.setJMSDeliveryMode(mode)
+    end
+
+    # Is the message persistent?
+    def persistent?
+      getJMSDeliveryMode == JMS::DeliveryMode::PERSISTENT
+    end
+
+    # Returns the Message correlation ID as a String
+    # The resulting string may contain nulls
+    def jms_correlation_id
+      String.from_java_bytes(getJMSCorrelationIDAsBytes) if getJMSCorrelationIDAsBytes
+    end
+
+    # Set the Message correlation ID
+    #   correlation_id: String
+    # Also supports embedded nulls within the correlation id
+    def jms_correlation_id=(correlation_id)
+      setJMSCorrelationIDAsBytes(correlation_id.nil? ? nil : correlation_id.to_java_bytes)
+    end
+
+    # Returns the Message Destination
+    #  Instance of JMS::Destination
+    def jms_destination
+      getJMSDestination
+    end
+
+    # Set the Message Destination
+    #   jms_destination: Must be an instance of JMS::Destination
+    def jms_destination=(destination)
+      setJMSDestination(destination)
+    end
+
+    # Return the message expiration value as an Integer
+    def jms_expiration
+      getJMSExpiration
+    end
+
+    # Set the Message expiration value
+    #   expiration: Integer
+    def jms_expiration=(expiration)
+      setJMSExpiration(expiration)
+    end
+
+    # Returns the Message ID as a String
+    # The resulting string may contain embedded nulls
+    def jms_message_id
+      getJMSMessageID
+    end
+
+    # Set the Message correlation ID
+    #   message_id: String
+    # Also supports nulls within the message id
+    def jms_message_id=(message_id)
+      setJMSMessageID(message_id)
+    end
+
+    # Returns the Message Priority level as an Integer
+    def jms_priority
+      getJMSPriority
+    end
+
+    # Set the Message priority level
+    #   priority: Integer
+    def jms_priority=(priority)
+      setJMSPriority(priority)
+    end
+
+    # Indicates whether the Message was redelivered?
+    def jms_redelivered?
+      getJMSRedelivered
+    end
+
+    # Set whether the Message was redelivered
+    #   bool: Boolean
+    def jms_redelivered=(bool)
+      setJMSPriority(bool)
+    end
+
+    # Returns the Message reply to Destination
+    #  Instance of JMS::Destination
+    def jms_reply_to
+      getJMSReplyTo
+    end
+
+    # Set the Message reply to Destination
+    #   reply_to: Must be an instance of JMS::Destination
+    def jms_reply_to=(reply_to)
+      setJMSReplyTo(reply_to)
+    end
+
+    # Returns the Message timestamp as Java Timestamp Integer
+    #TODO Return Ruby Time object?
+    def jms_timestamp
+      getJMSTimestamp
+    end
+
+    # Set the Message timestamp as Java Timestamp Integer
+    #   timestamp: Must be an Java Timestamp Integer
+    #TODO Support Ruby Time
+    def jms_timestamp=(timestamp)
+      setJMSTimestamp(timestamp)
+    end
+
+    # Returns the Message type supplied by the client when the message was sent
+    def jms_type
+      getJMSType
+    end
+
+    # Sets the Message type
+    #   type: String
+    def jms_type=(type)
+      setJMSType(type)
+    end
+  end
+
+  # Return the JMS Delivery Mode as a Ruby symbol
+  #   :persistent
+  #   :non_persistent
+  #   nil if unknown
+  def jms_delivery_mode_sym
+    case jms_delivery_mode
+    when JMS::DeliveryMode::PERSISTENT
+      :persistent
+    when JMS::DeliveryMode::NON_PERSISTENT
+      :non_persistent
+    else
+      nil
+    end
+  end
+
+  # Set the JMS Delivery Mode from a Ruby Symbol
+  # Valid values for mode
+  #   :persistent
+  #   :non_persistent
+  def jms_delivery_mode_sym=(mode)
+    val = case mode
+    when :persistent
+      JMS::DeliveryMode::PERSISTENT
+    when :non_persistent
+      JMS::DeliveryMode::NON_PERSISTENT
+    else
+      raise "Unknown delivery mode symbol: #{mode}"
+    end
+    self.setJMSDeliveryMode(val)
+  end
+
+  # Return the attributes (header fields) of the message as a Hash
+  def attributes
+    {
+      :jms_correlation_id => jms_correlation_id,
+      :jms_delivery_mode_sym => jms_delivery_mode_sym,
+      :jms_destination => jms_destination.nil? ? nil : jms_destination.to_string,
+      :jms_expiration => jms_expiration,
+      :jms_message_id => jms_message_id,
+      :jms_priority => jms_priority,
+      :jms_redelivered => jms_redelivered?,
+      :jms_reply_to => jms_reply_to,
+      :jms_timestamp => jms_timestamp,
+      :jms_type => jms_type,
+    }
+  end
+
+  # Methods for manipulating the message properties
+
+  # Get the value of a property
+  def [](key)
+    getObjectProperty key.to_s
+  end
+
+  # Set a property
+  def []=(key, value)
+    setObjectProperty(key.to_s, value)
+  end
+
+  # Does message include specified property?
+  def include?(key)
+    # Ensure a Ruby true is returned
+    property_exists(key) == true
+  end
+
+  # Return Properties as a hash
+  def properties
+    h = {}
+    properties_each_pair {|k,v| h[k]=v}
+    h
+  end
+
+  # Set Properties from an existing hash
+  def properties=(h)
+    clear_properties
+    h.each_pair {|k,v| setObjectProperty(k.to_s, v)}
+    h
+  end
+
+  # Return each name value pair
+  def properties_each_pair(&proc)
+    enum = getPropertyNames
+    while enum.has_more_elements
+      key = enum.next_element
+      proc.call key, getObjectProperty(key)
+    end
+  end
+
+  def inspect
+    "#{self.class.name}: #{data}\nAttributes: #{attributes.inspect}\nProperties: #{properties.inspect}"
+  end
+
+end