torquebox-messaging 2.3.2-java → 3.0.0.beta1-java

data/lib/torquebox/messaging/echo_processor.rb

@@ -15,6 +15,7 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
+# @api private
 module Torquebox
   module Messaging
     # A message processor that echos any messages sent to it back to

data/lib/torquebox/messaging/edn_message.rb

@@ -15,23 +15,12 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
-require 'edn'
-
 module TorqueBox
   module Messaging
     class EdnMessage < Message
       ENCODING = :edn
       JMS_TYPE = :text
-
-      def encode(message)
-        @jms_message.text = message.to_edn
-      end
-
-      def decode
-        EDN.read(@jms_message.text) unless @jms_message.text.nil?
-      end
     end
-
     Message.register_encoding( EdnMessage )
   end
 end

data/lib/torquebox/messaging/future_responder.rb

@@ -28,10 +28,10 @@ module TorqueBox
       # @param [Integer] message_ttl The time-to-live used on messages
       #   to prevent them from staying in the queue indefinately if
       #   the result is never accessed.
-      def initialize(response_queue, correlation_id, message_ttl = 600_000)
+      def initialize(response_queue, correlation_id, message_ttl = nil)
         @queue = response_queue
         @correlation_id = correlation_id
-        @message_ttl = message_ttl
+        @message_ttl = message_ttl || 600_000
       end
 
       # Signal that processing has started.

data/lib/torquebox/messaging/json_message.rb

@@ -20,31 +20,7 @@ module TorqueBox
     class JSONMessage < Message
       ENCODING = :json
       JMS_TYPE = :text
-
-      def require_json
-        # We can't ship our own json, as it may collide with the gem
-        # requirement for the app.
-        if !defined?( JSON )
-          begin
-            require 'json'
-          rescue LoadError => ex
-            raise RuntimeError.new( "Unable to load the json gem. Verify that is installed and in your Gemfile (if using Bundler)" )
-          end
-        end
-      end
-      
-      def encode(message)
-        require_json 
-        @jms_message.text = JSON.fast_generate( message ) unless message.nil?
-      end
-
-      def decode
-        require_json 
-        JSON.parse( @jms_message.text, :symbolize_names => true ) unless @jms_message.text.nil?
-      end
-
     end
-
     Message.register_encoding( JSONMessage )
   end
 end

data/lib/torquebox/messaging/marshal_base64_message.rb

@@ -15,30 +15,12 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
-require 'base64'
-
 module TorqueBox
   module Messaging
     class MarshalBase64Message < Message
       ENCODING = :marshal_base64
       JMS_TYPE = :text
-      
-      def encode(message)
-        unless message.nil?
-          marshalled = Marshal.dump( message )
-          @jms_message.text = Base64.encode64( marshalled )
-        end
-      end
-
-      def decode
-        unless @jms_message.text.nil?
-          serialized = Base64.decode64( @jms_message.text )
-          Marshal.restore( serialized )
-        end
-      end
-
     end
-
     Message.register_encoding( MarshalBase64Message )
   end
 end

data/lib/torquebox/messaging/marshal_message.rb

@@ -15,6 +15,8 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
+require 'torquebox/codecs'
+
 module TorqueBox
   module Messaging
     class MarshalMessage < Message
@@ -22,10 +24,7 @@ module TorqueBox
       JMS_TYPE = :bytes
       
       def encode(message)
-        unless message.nil?
-          marshalled = Marshal.dump( message )
-          @jms_message.write_bytes( marshalled.to_java_bytes )
-        end
+        @jms_message.write_bytes(TorqueBox::Codecs.encode(message, ENCODING).to_java_bytes)
       end
 
       def decode
@@ -33,7 +32,7 @@ module TorqueBox
           bytes = Java::byte[length].new
           @jms_message.read_bytes( bytes )
           @jms_message.reset
-          Marshal.restore( String.from_java_bytes( bytes ) )
+          TorqueBox::Codecs.decode(String.from_java_bytes(bytes), ENCODING)
         end
       end
 

data/lib/torquebox/messaging/message.rb

@@ -15,6 +15,8 @@
 # Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 # 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 
+require 'torquebox/codecs'
+
 module TorqueBox
   module Messaging
     class Message
@@ -80,6 +82,14 @@ module TorqueBox
         super || @jms_message.respond_to?(symbol, include_private)
       end
 
+      def encode(message)
+        @jms_message.text = TorqueBox::Codecs.encode(message, self.class::ENCODING)
+      end
+
+      def decode
+        TorqueBox::Codecs.decode(@jms_message.text, self.class::ENCODING)
+      end
+
       class << self
         alias :__new__ :new
 

data/lib/torquebox/messaging/message_processor.rb

@@ -25,9 +25,18 @@ module TorqueBox
       attr_accessor :message
 
       def initialize
-        @message = nil 
+        @message = nil
+        @proxy = nil
       end
-      
+
+      def initialize_proxy(group)
+        @proxy = MessageProcessorProxy.new(group)
+      end
+
+      def method_missing(method, *args, &block)
+        @proxy.send( method, *args, &block )
+      end
+
       def on_message(body)
         throw "Your subclass must implement on_message(body)"
       end
@@ -39,12 +48,162 @@ module TorqueBox
       def process!(message)
         @message = message
         begin
-          on_message( message.decode )
+          value = on_message(message.decode)
+          reply(value) if synchronous?
         rescue Exception => e
           on_error( e ) 
         end 
       end
 
+      def reply(value)
+        TorqueBox::Messaging::Queue.new(@message.jms_message.jms_destination.queue_name).publish(value, :correlation_id => @message.jms_message.jms_message_id)
+      end
+
+      class << self
+
+        # List all available message processors for current application.
+        #
+        # @return [Array<TorqueBox::Messaging::MessageProcessorProxy>] List of
+        #         proxy objets to read and manage state of selected message
+        #         processor
+        def list
+          processors = []
+
+          TorqueBox::MSC.get_services(/^#{messaging_service_name.canonical_name}\.\".*\"$/) do |service|
+            processors << MessageProcessorProxy.new(service.value)
+          end
+
+          processors
+        end
+
+        # Lookup a message processor by its destination and class name.
+        #
+        # @param [String] The destination name (queue, topic) to which
+        #         a message processor is bound.
+        #
+        # @param [String] The class name of the message processor
+        #         implementation.
+        def lookup(destination_name, class_name)
+          sn = messaging_service_name.append("#{destination_name}.#{class_name}")
+
+          # Try to find a message procesor for specified parameters
+          group = TorqueBox::ServiceRegistry::lookup(sn)
+
+          return MessageProcessorProxy.new(group) if group
+
+          # Ooops, no processor is found. Most probably wrong data.
+          return nil
+        end
+
+        protected
+
+        def messaging_service_name
+          TorqueBox::MSC.deployment_unit.service_name.append('torquebox').append('messaging')
+        end
+      end
+    end
+
+    class MessageProcessorProxy
+      def initialize(group)
+        @group = group
+
+        raise "Cannot create MessageProcessorProxy for non-existing MessageProcessorGroup" if @group.nil?
+      end
+
+      attr_reader :destination_name, :class_name
+
+      # Updates the concurrency,
+      #
+      # @note This method sets the concurrency and changes immediately
+      #       the number of consumers for specified destination.
+      def concurrency=(size)
+        raise "Setting concurrency for '#{name}' to value < 0 is not allowed. You tried '#{size}'." if size < 0
+
+        return size if size == @group.concurrency
+
+        @group.update_concurrency(size)
+
+        concurrency
+      end
+
+      # Returns the concurrency
+      #
+      # @return Integer
+      def concurrency
+        @group.concurrency
+      end
+
+      # Returns the group name
+      #
+      # @return String
+      def name
+        @group.name
+      end
+
+      # Returns the destination (queue or topic) name
+      #
+      # @return String
+      def destination_name
+        @group.destination_name
+      end
+
+      # Returns the message processor implementation
+      # class name
+      #
+      # @return String
+      def class_name
+        @group.message_processor_class.name
+      end
+
+      # Returns the message selector
+      #
+      # If there is no message selector specified,
+      # returns empty string
+      #
+      # @return String
+      def message_selector
+        @group.message_selector
+      end
+
+      # Returns true if the message processor is a durable
+      # subscriber, false otherwise
+      #
+      # @return Boolean
+      def durable?
+        @group.durable
+      end
+
+      # Returns true if the message processor is synchronous,
+      # false otherwise
+      #
+      # @return Boolean
+      def synchronous?
+        @group.synchronous
+      end
+
+      # Returns true if the message processor is started,
+      # false otherwise
+      #
+      # @return Boolean
+      def started?
+        @group.status.eql?("STARTED")
+      end
+
+      # Starts the message processor
+      #
+      def start
+        @group.start
+      end
+
+      # Stops the message processor
+      #
+      def stop
+        @group.stop
+      end
+
+      def to_s
+        "<MessageProcessorProxy: #{name}>"
+      end
     end
   end
 end

data/lib/torquebox/messaging/processor_middleware/chain.rb

@@ -17,6 +17,7 @@
 
 module TorqueBox
   module Messaging
+    # @api private
     module ProcessorMiddleware
       class Chain
 

data/lib/torquebox/messaging/processor_middleware/default_middleware.rb

@@ -20,6 +20,7 @@ require 'torquebox/messaging/processor_middleware/with_transaction'
 
 module TorqueBox
   module Messaging
+    # @api private
     module ProcessorMiddleware
       module DefaultMiddleware
 

data/lib/torquebox/messaging/processor_middleware/with_transaction.rb

@@ -19,6 +19,7 @@ require 'torquebox/transactions'
 
 module TorqueBox
   module Messaging
+    # @api private
     module ProcessorMiddleware
       class WithTransaction
 

data/lib/torquebox/messaging/queue.rb

@@ -22,22 +22,36 @@ module TorqueBox
   module Messaging
     class Queue < Destination
 
-      def self.start( name, options={} )
-        selector = options.fetch( :selector, "" )
-        durable  = options.fetch( :durable,  true )
-        jndi     = options.fetch( :jndi,     [].to_java(:string) )
-        TorqueBox::ServiceRegistry.lookup("jboss.messaging.default.jms.manager") do |server|
-          server.createQueue( false, name, selector, durable, jndi )
-        end
-        new( name )
-      end
+      class << self
+
+        # Creates the queue, starts and return a Queue object.
+        #
+        # @param name The name of the queue
+        # @param options Optional parameters (a Hash), including:
+        # @option options [String] :selector The selector for the queue
+        # @option options [Boolean] :durable If the queue should be durable
+        # @option options [Boolean] :exported If the queue should be visible in remote JNDI lookups
+        # @return [Queue] if the service is created and started
+        # @return [nil] if the service is not created in the specified time (30 s)
+        def start(name, options={})
+          selector = options.fetch(:selector, "")
+          durable = options.fetch(:durable, true)
+          exported = options.fetch(:exported, false)
+
+          with_destinationizer do |destinationizer|
+            latch = destinationizer.create_queue(name, durable, selector, exported)
+            return nil unless TorqueBox::Messaging::Destination.wait_for_latch(latch)
+          end
 
-      def stop
-        TorqueBox::ServiceRegistry.lookup("jboss.messaging.default.jms.manager") do |server|
-          server.destroyQueue( name )
+          new(name, options)
         end
       end
 
+      # Publishes a message and waits for the reply
+      #
+      # @param message The message to publish
+      # @param options Optional parameters (a Hash)
+      # @return Replied message
       def publish_and_receive(message, options={})
         result = nil
         with_session do |session|
@@ -47,6 +61,11 @@ module TorqueBox
         result
       end
 
+      # Waits for a message and replies
+      #
+      # @param options Optional parameters (a Hash)
+      # @param block The block to handle the received message. The return value of the block will be send back to the queue.
+      # @return [void]
       def receive_and_publish(options={}, &block)
         with_session do |session|
           session.receive_and_publish(self, normalize_options(options), &block)
@@ -67,6 +86,8 @@ module TorqueBox
       # if there are connected consumers.
       #
       # When executed on a paused queue, nothing happens.
+      #
+      # @return [void]
       def pause
         with_queue_control do |control|
           control.pause
@@ -75,6 +96,8 @@ module TorqueBox
 
       # Resumes a queue after it was paused.
       # When executed on a active queue, nothing happens.
+      #
+      # @return [void]
       def resume
         with_queue_control do |control|
           control.resume
@@ -83,61 +106,207 @@ module TorqueBox
 
       # Removes messages from the queue.
       #
-      # Accepts optional :filter parameter to remove only
-      # selected messages from the queue. By default
-      # *all* messages will be removed.
-      #
-      # The :filter parameter is a String where you define
-      # expressions in a SQL92-like syntax based on properties
-      # set on the messages.
-      #
-      # Example:
+      # @param filter [String] Expression in a SQL92-like syntax based on properties set on the messages. If not set all messages will be removed.
       #
-      # type = 'tomatoe' OR type = 'garlic'
+      # @example Remove messages with type property set
       #
-      # This will remove messages with :type property set
-      # to 'tomatoe' or 'garlic'
+      #   @queue.remove_messages("type = 'tomatoe' OR type = 'garlic'")
       #
-      # This function returns number of removed messages.
+      # @return [Integer] Number of removed messages
       def remove_messages(filter = nil)
         with_queue_control do |control|
           control.remove_messages(filter)
         end
       end
 
-      # Counts messages in the queue.
+      # Removes message from the queue by its id.
       #
-      # Accepts optional :filter parameter to count only
-      # selected messages in the queue. By default
-      # all messages will be counted.
+      # @param id [String] ID of the message
+      # @return [Boolean] true if the message was removed, false otherwise.
+      def remove_message(id)
+        with_queue_control do |control|
+          control.remove_message(id)
+        end
+      end
+
+      # Counts messages in the queue.
       #
-      # The :filter parameter is a String where you define
-      # expressions in a SQL92-like syntax based on properties
-      # set on the messages.
+      # @param filter [String] Expression in a SQL92-like syntax based on properties set on the messages. If not set all messages will be counted.
       #
-      # Example:
+      # @example Count messages with :type property set to 'tomatoe' or 'garlic'
       #
-      # type = 'tomatoe' OR type = 'garlic'
+      #   @queue.count_messages("type = 'tomatoe' OR type = 'garlic'")
       #
-      # This will count messages with :type property set
-      # to 'tomatoe' or 'garlic'
+      # @return [Fixnum] The number of counted messages
       def count_messages(filter = nil)
         with_queue_control do |control|
           control.count_messages(filter)
         end
       end
 
-      # Retrieves the JMSQueueControl implenetation for current
-      # queue.
-      def with_queue_control
-        TorqueBox::ServiceRegistry.lookup("jboss.messaging.default") do |server|
-          yield server.management_service.get_resource("jms.queue.#{_dump(nil)}")
+      # Expires messages from the queue.
+      #
+      # @param filter [String] Expression in a SQL92-like syntax based on properties set on the messages. If not set all messages will be expired.
+      #
+      # @return [Fixnum] The number of expired messages
+      def expire_messages(filter = nil)
+        with_queue_control do |control|
+          control.expire_messages(filter)
+        end
+      end
+
+      # Expires message from the queue by its id.
+      #
+      # @return [Boolean] Returns true if the message was expired, false otherwise.
+      def expire_message(id)
+        with_queue_control do |control|
+          control.expire_message(id)
+        end
+      end
+
+      # Sends message to dead letter address.
+      #
+      # @return [Boolean] Returns true if the message was sent, false otherwise.
+      def send_message_to_dead_letter_address(id)
+        with_queue_control do |control|
+          control.send_message_to_dead_letter_address(id)
+        end
+      end
+
+      # Sends messages to dead letter address.
+      #
+      # @param filter [String] Expression in a SQL92-like syntax based on properties set on the messages. If not set all messages will be send.
+      #
+      # @return [Fixnum] The number of sent messages
+      def send_messages_to_dead_letter_address(filter = nil)
+        with_queue_control do |control|
+          control.send_messages_to_dead_letter_address(filter)
+        end
+      end
+
+      # Returns the consumer count connected to the queue.
+      #
+      # @return [Fixnum] The number of consumers
+      def consumer_count
+        with_queue_control do |control|
+          control.consumer_count
+        end
+      end
+
+      # Returns the scheduled messages count for this queue.
+      #
+      # @return [Fixnum] The number of scheduled messages
+      def scheduled_messages_count
+        with_queue_control do |control|
+          control.scheduled_count
+        end
+      end
+
+      # Moves messages from the queue to another queue specified in the
+      # +queue_name+ parameter. Optional +reject_duplicates+ parameter
+      # specifies if the duplicates should be rejected.
+      #
+      # @param queue_name [String] The name of the queue to move the messages to
+      # @param filter [String] Parameter to limit messages to move. If provided nil or empty string, *all messages* will be moved.
+      # @param reject_duplicates [Boolean] Specifies if the duplicates should be rejected
+      # @return [Fixnum] The number of moved messages
+      def move_messages(queue_name, filter = nil, reject_duplicates = false)
+        with_queue_control do |control|
+          control.move_messages(filter, queue_name, reject_duplicates)
         end
       end
 
+      # Moves message for specific id from the queue to another queue
+      # specified in the queue_name parameter.
+      #
+      # @param queue_name [String] The name of the queue to move the messages to
+      # @param id [String] Message ID
+      # @param reject_duplicates [Boolean] Specifies if the duplicates should be rejected
+      # @return [Boolean] true if the message was moved,false otherwise
+      def move_message(queue_name, id, reject_duplicates = false)
+        with_queue_control do |control|
+          control.move_message(id, queue_name, reject_duplicates)
+        end
+      end
+
+      # Returns current expiry address.
+      #
+      # @return [String] Current expiry address. Please note that the destination contains 'jms.queue' or 'jms.topic' prefixes.
+      def expiry_address
+        with_queue_control do |control|
+          control.expiry_address
+        end
+      end
+
+      # Sets the expiry address.
+      #
+      # Please note that you need to provide the
+      # *full address* containing the destination name and
+      # jms.queue or jms.topic prefixes, for example:
+      #
+      # @example Set the destination to /queues/customexpire
+      #
+      #   @queue.expiry_address = "jms.queue./queues./customexpire"
+      #
+      # @example Set the destination to /topics/customexpire
+      #
+      #   @queue.expiry_address = "jms.topic./topics./customexpire"
+      #
+      # @return [String] Current expiry address
+      def expiry_address=(address)
+        with_queue_control do |control|
+          control.set_expiry_address(address)
+        end
+
+        expiry_address
+      end
+
+      # Returns current dead letter address.
+      #
+      # @return [String] Current dead letter address. Please note that the destination contains 'jms.queue' or 'jms.topic' prefixes,
+      def dead_letter_address
+        with_queue_control do |control|
+          control.dead_letter_address
+        end
+      end
+
+      # Sets the dead letter address.
+      #
+      # Please note that you need to provide the
+      # *full address* containing the destination name and
+      # +jms.queue+ or +jms.topic+ prefixes, for example:
+      #
+      # @example Set the destination to /queues/customdead
+      #
+      #   @queue.dead_letter_address = "jms.queue./queues./customdead"
+      #
+      # @example Set the destination to /topics/customdead
+      #
+      #   @queue.dead_letter_address = "jms.topic./topics./customdead"
+      #
+      # @return [String] Current dead letter address
+      def dead_letter_address=(address)
+        with_queue_control do |control|
+          control.set_dead_letter_address(address)
+        end
+
+        dead_letter_address
+      end
+
+
       def to_s
         "[Queue: #{super}]"
       end
+
+      # @api private
+      #
+      # Retrieves the JMSQueueControl implementation for current
+      # queue.
+      def with_queue_control
+        TorqueBox::ServiceRegistry.lookup("jboss.messaging.default") do |server|
+          yield server.management_service.get_resource("jms.queue.#{@name}")
+        end
+      end
     end
   end
 end