rubywmq 0.3.0-i386-mswin32-mq6

data/examples/files_to_q.cfg

@@ -0,0 +1,24 @@
+dev:
+  qmgr_options:
+    :q_mgr_name: REID
+  output_queue:
+    :q_name: TEST.QUEUE
+  put_options:
+    :new_msg_id: true
+  descriptor:
+    :format: MQSTR
+  source_directory: messages
+
+test:
+  qmgr_options:
+    :q_mgr_name: TEST.QMGR
+    :channel_name: SYSTEM.DEF.SVRCONN
+    :connection_name: remotehost(1414)
+  output_queue:
+    :q_name: TEST.QUEUE
+  put_options:
+    :new_msg_id: true
+  descriptor:
+    :format: MQSTR
+  source_directory: messages
+

data/examples/files_to_q.rb

@@ -0,0 +1,46 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, 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.
+################################################################################
+
+#
+# Example : files_to_q : Place all files in a directory to a queue
+#          Each file is written as a separate message
+#
+require 'find'
+require 'yaml'
+require 'wmq/wmq'
+
+# Call program passing environment name as first parameter
+#   The environment corresponds to an entry in the config file
+env = ARGV[0] || raise("Command line argument 'environment' is required")
+config = YAML::load_file('files_to_q.cfg')[env]
+
+message = WMQ::Message.new
+message.descriptor = config['descriptor'] || {}
+tstart = Time.now
+counter = 0
+WMQ::QueueManager.connect(config['qmgr_options']) do |qmgr|
+  qmgr.open_queue({:mode=>:output}.merge(config['output_queue'])) do |queue|
+    Find.find(config['source_directory']) do |path|
+      unless FileTest.directory?(path)
+        printf("%5d: #{path}\n",counter = counter + 1)
+        message.data = File.read(path)
+        queue.put({:message => message}.merge(config['put_options']))
+      end
+    end
+  end
+end
+duration = Time.now - tstart
+printf "Processed #{counter} messages in %.3f seconds. Average: %.3f messages/second\n", duration, counter/duration

data/examples/get_a.rb

@@ -0,0 +1,34 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, 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.
+################################################################################
+
+#
+# Sample : get() : Retrieve a single message from a queue
+#          If no messages are on the queue, message.data is nil
+#
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:input) do |queue|
+
+    message = WMQ::Message.new
+    if queue.get(:message => message)
+      puts "Data Received: #{message.data}"
+    else
+      puts 'No message available'
+    end
+  end
+end
+

data/examples/get_client.rb

@@ -0,0 +1,50 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, 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.
+################################################################################
+
+#
+# Sample : get() : Retrieve a single message from a queue
+#          If no messages are on the queue, message.data is nil
+#
+# The Client connection is determined by the :connection_name parameter supplied
+# to QueueManager::connect or QueueManager::new
+# 
+# If :connection_name is not present, a WebSphere MQ Server connection will be used
+# I.e. Local server connection
+# 
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(
+            :connection_name => 'localhost(1414)',        # Use MQ Client Library
+            :channel_name    => 'SYSTEM.DEF.SVRCONN',     # Optional, since this is the default value
+            :transport_type  => WMQ::MQXPT_TCP            # Optional, since this is the default value
+       ) do |qmgr|
+  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:input) do |queue|
+
+    message = WMQ::Message.new
+    if queue.get(:message => message)
+      puts "Data Received: #{message.data}"
+      
+      puts "Message Descriptor:"
+      p message.descriptor
+      
+      puts "Headers Received:"
+      message.headers.each {|header| p header}
+    else
+      puts 'No message available'
+    end
+  end
+end
+

data/examples/put1_a.rb

@@ -0,0 +1,24 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, 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.
+################################################################################
+
+#
+# Sample : put1() : Put a single message to a queue
+#
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.put(:q_name=>'TEST.QUEUE', :data => 'Hello World')
+end

data/examples/put1_b.rb

@@ -0,0 +1,32 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, 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.
+################################################################################
+
+#
+# Sample : put1() : Put a single message to a queue
+#
+#          Set the correlation id to a text string
+#
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+
+  message = WMQ::Message.new
+  message.data = 'Hello World'
+  message.descriptor[:correl_id] = 'My first message'
+
+  qmgr.put(:q_name=>'TEST.QUEUE', :message=>message)
+end
+

data/examples/put1_c.rb

@@ -0,0 +1,31 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, 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.
+################################################################################
+
+#
+# Sample : put() : Put a single request message to a queue
+#
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  message = WMQ::Message.new
+  message.data = 'Hello World'
+  
+  message.descriptor = {
+    :msg_type=> WMQ::MQMT_REQUEST,
+    :reply_to_q=>'TEST.REPLY.QUEUE'}
+  
+  qmgr.put(:q_name=>'TEST.QUEUE', :message => message)
+end

data/examples/put_a.rb

@@ -0,0 +1,34 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, 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.
+################################################################################
+
+#
+# Sample : put() : Put a single message to a queue
+#          Open the queue so that multiple puts can be performed
+#
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
+
+    # First message
+    queue.put(:data => 'Hello World')
+
+    # Second message
+    #   This message will have new message and correlation id's
+    queue.put(:data => 'Hello Again')
+  end
+end
+

data/examples/put_b.rb

@@ -0,0 +1,42 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, 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.
+################################################################################
+
+#
+# Sample : put() : Put two Messages to a queue
+#          Open the queue so that multiple puts can be performed
+#          Ensure that all messages have the same correlation id
+#
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
+
+    message = WMQ::Message.new
+
+    # First message
+    #   Results in a WMQ generated msg_id and empty correl_id
+    message.data = 'Hello World'
+    queue.put(:message => message)
+
+    # Second message
+    #   new_msg_id will cause the second message to have a new message id
+    #   otherwise both messages will have the same message and correlation id's
+    #   This message will have the same correlation id as the first message (empty)
+    message.data = 'Hello Again'
+    p message.descriptor
+    queue.put(:message => message, :new_msg_id => true)
+  end
+end

data/examples/put_dlh.rb

@@ -0,0 +1,40 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, 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.
+################################################################################
+
+#
+# Sample : put() : Put a message to a queue with a dead letter header
+#          Open the queue so that multiple puts can be performed
+#
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
+    message = WMQ::Message.new
+    message.data = 'Hello World'
+    
+    message.headers = [
+     {:header_type =>:dead_letter_header,
+      :reason      => WMQ::MQRC_UNKNOWN_REMOTE_Q_MGR,
+      :dest_q_name =>'ORIGINAL_QUEUE_NAME',
+      :dest_q_mgr_name =>'BAD_Q_MGR'}
+    ]
+    
+    message.descriptor[:format] = WMQ::MQFMT_STRING
+    
+    queue.put(:message=>message)
+  end
+end
+

data/examples/put_dynamic_q.rb

@@ -0,0 +1,37 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, 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.
+################################################################################
+
+#
+# Sample : put() : Put a single message to a queue
+#          Create the queue if it does not already exist
+#
+#   Note : The queue name is that of the model queue
+#          The dynamic_q_name is the actual queue name
+#
+#   This sample is more usefull if the model queue was a Permanent Dynamic one.
+#   That way the queue would remain after termination of this code.
+#   In this sample the queue will disappear when this program terminates
+#
+require 'wmq/wmq'
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.open_queue(:q_name => 'SYSTEM.DEFAULT.MODEL.QUEUE',
+                  :dynamic_q_name => 'TEST.QUEUE.SAMPLE',
+                  :mode  => :output
+                  ) do |queue|
+    queue.put(:data => 'Hello World')
+  end
+end

data/examples/put_rfh.rb

@@ -0,0 +1,66 @@
+################################################################################
+#  Copyright 2006 J. Reid Morrison. Dimension Solutions, 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.
+################################################################################
+
+#
+# Sample : put() : Put a message to a queue with a Refernce header
+#          Open the queue so that multiple puts can be performed
+#
+require 'wmq/wmq'
+
+# The Rules Format header (MQRFH) allows a list of name value pairs to be sent along
+# with a WMQ message. These name value pairs are represented as follows on the "wire":
+#   Name1 Value1 Name2 Value2 Name3 Value3
+#   
+# Ruby WMQ converts the above string of data into a Ruby hash by
+# using the name as the key, as follows:
+# data = {
+#    'Name1' => 'Value1',
+#    'Name2' => 'Value2',
+#    'Name3' => 'Value3'
+# }
+# 
+# Since a name can consist of any character except null, it is stored as a String
+# 
+# Note: It is possible to send or receive the same Name with multiple values using an array.
+#   E.g.   Name1 Value1 Name2 Value2 Name1 Value3
+#   Becomes:
+# data = {
+#    'Name1' => ['Value1', 'Value3'],
+#    'Name2' => 'Value2'
+# }
+# 
+# Note: Since a Hash does not preserve order, reading a Rules Format Header and then writing
+#       it out immediately again could result in re-ordering of the name value pairs.
+#   
+
+WMQ::QueueManager.connect(:q_mgr_name=>'REID') do |qmgr|
+  qmgr.open_queue(:q_name=>'TEST.QUEUE', :mode=>:output) do |queue|
+    message = WMQ::Message.new
+    message.data = 'Hello World'
+    
+    message.headers = [
+     {:header_type =>:rf_header,
+      :name_value => {'name1' => 'value1', 
+                      'name2' => 'value2', 
+                      'name3' => ['value 3a', 'value 3b']} 
+     }]
+    
+    message.descriptor[:format] = WMQ::MQFMT_STRING
+    
+    queue.put(:message=>message)
+  end
+end
+