rubywmq 0.3.0-i386-mswin32-mq5.3

data/lib/wmq/wmq_const_admin.rb

@@ -0,0 +1,273 @@
+################################################################################
+#  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.
+################################################################################
+#
+#  WARNING: DO NOT MODIFY THIS FILE
+#
+#  This file was generated by generate_const.rb.
+#
+################################################################################
+module WMQ
+# Admin constants from cmqc.h
+
+# Object Types
+   MQOT_Q                         = 1
+   MQOT_NAMELIST                  = 2
+   MQOT_PROCESS                   = 3
+   MQOT_STORAGE_CLASS             = 4
+   MQOT_Q_MGR                     = 5
+   MQOT_CHANNEL                   = 6
+   MQOT_AUTH_INFO                 = 7
+   MQOT_CF_STRUC                  = 10
+   MQOT_RESERVED_1                = 999
+   MQOT_ALL                       = 1001
+   MQOT_ALIAS_Q                   = 1002
+   MQOT_MODEL_Q                   = 1003
+   MQOT_LOCAL_Q                   = 1004
+   MQOT_REMOTE_Q                  = 1005
+   MQOT_SENDER_CHANNEL            = 1007
+   MQOT_SERVER_CHANNEL            = 1008
+   MQOT_REQUESTER_CHANNEL         = 1009
+   MQOT_RECEIVER_CHANNEL          = 1010
+   MQOT_CURRENT_CHANNEL           = 1011
+   MQOT_SAVED_CHANNEL             = 1012
+   MQOT_SVRCONN_CHANNEL           = 1013
+   MQOT_CLNTCONN_CHANNEL          = 1014
+
+# Security Identifier Types
+   MQSIDT_NONE                    = 'x00'
+   MQSIDT_NT_SECURITY_ID          = 'x01'
+   MQSIDT_WAS_SECURITY_ID         = 'x02'
+
+# Channel Types
+   MQCHT_SENDER                   = 1
+   MQCHT_SERVER                   = 2
+   MQCHT_RECEIVER                 = 3
+   MQCHT_REQUESTER                = 4
+   MQCHT_ALL                      = 5
+   MQCHT_CLNTCONN                 = 6
+   MQCHT_SVRCONN                  = 7
+   MQCHT_CLUSRCVR                 = 8
+   MQCHT_CLUSSDR                  = 9
+   MQQT_LOCAL                     = 1
+   MQQT_MODEL                     = 2
+   MQQT_ALIAS                     = 3
+   MQQT_REMOTE                    = 6
+   MQQT_CLUSTER                   = 7
+   MQCQT_LOCAL_Q                  = 1
+   MQCQT_ALIAS_Q                  = 2
+   MQCQT_REMOTE_Q                 = 3
+   MQCQT_Q_MGR_ALIAS              = 4
+   MQQT_ALL                       = 1001
+   MQQDT_PREDEFINED               = 1
+   MQQDT_PERMANENT_DYNAMIC        = 2
+   MQQDT_TEMPORARY_DYNAMIC        = 3
+   MQQDT_SHARED_DYNAMIC           = 4
+   MQQA_GET_INHIBITED             = 1
+   MQQA_GET_ALLOWED               = 0
+   MQQA_PUT_INHIBITED             = 1
+   MQQA_PUT_ALLOWED               = 0
+   MQQA_SHAREABLE                 = 1
+   MQQA_NOT_SHAREABLE             = 0
+   MQQA_BACKOUT_HARDENED          = 1
+   MQQA_BACKOUT_NOT_HARDENED      = 0
+   MQMDS_PRIORITY                 = 0
+   MQMDS_FIFO                     = 1
+   MQTC_OFF                       = 0
+   MQTC_ON                        = 1
+   MQTT_NONE                      = 0
+   MQTT_FIRST                     = 1
+   MQTT_EVERY                     = 2
+   MQTT_DEPTH                     = 3
+   MQUS_NORMAL                    = 0
+   MQUS_TRANSMISSION              = 1
+   MQDL_SUPPORTED                 = 1
+   MQDL_NOT_SUPPORTED             = 0
+   MQIT_NONE                      = 0
+   MQIT_MSG_ID                    = 1
+   MQIT_CORREL_ID                 = 2
+   MQIT_MSG_TOKEN                 = 4
+   MQIT_GROUP_ID                  = 5
+   MQBND_BIND_ON_OPEN             = 0
+   MQBND_BIND_NOT_FIXED           = 1
+   MQQSGD_Q_MGR                   = 0
+   MQQSGD_COPY                    = 1
+   MQQSGD_SHARED                  = 2
+   MQQSGD_GROUP                   = 3
+   MQNC_MAX_NAMELIST_NAME_COUNT   = 256
+   MQNT_NONE                      = 0
+   MQNT_Q                         = 1
+   MQNT_CLUSTER                   = 2
+   MQNT_AUTH_INFO                 = 4
+   MQNT_ALL                       = 1001
+   MQCHAD_DISABLED                = 0
+   MQCHAD_ENABLED                 = 1
+   MQCMDL_LEVEL_1                 = 100
+   MQCMDL_LEVEL_101               = 101
+   MQCMDL_LEVEL_110               = 110
+   MQCMDL_LEVEL_114               = 114
+   MQCMDL_LEVEL_120               = 120
+   MQCMDL_LEVEL_200               = 200
+   MQCMDL_LEVEL_201               = 201
+   MQCMDL_LEVEL_210               = 210
+   MQCMDL_LEVEL_220               = 220
+   MQCMDL_LEVEL_221               = 221
+   MQCMDL_LEVEL_320               = 320
+   MQCMDL_LEVEL_420               = 420
+   MQCMDL_LEVEL_500               = 500
+   MQCMDL_LEVEL_510               = 510
+   MQCMDL_LEVEL_520               = 520
+   MQCMDL_LEVEL_530               = 530
+   MQEXPI_OFF                     = 0
+   MQIGQ_DISABLED                 = 0
+   MQIGQ_ENABLED                  = 1
+   MQIGQPA_DEFAULT                = 1
+   MQIGQPA_CONTEXT                = 2
+   MQIGQPA_ONLY_IGQ               = 3
+   MQIGQPA_ALTERNATE_OR_IGQ       = 4
+   MQPL_MVS                       = 1
+   MQPL_OS390                     = 1
+   MQPL_ZOS                       = 1
+   MQPL_OS2                       = 2
+   MQPL_AIX                       = 3
+   MQPL_UNIX                      = 3
+   MQPL_OS400                     = 4
+   MQPL_WINDOWS                   = 5
+   MQPL_WINDOWS_NT                = 11
+   MQPL_VMS                       = 12
+   MQPL_NSK                       = 13
+   MQSP_AVAILABLE                 = 1
+   MQSP_NOT_AVAILABLE             = 0
+# Admin constants from cmqcfc.h
+   MQACT_FORCE_REMOVE             = 1
+   MQBT_OTMA                      = 1
+   MQCFO_REFRESH_REPOSITORY_YES   = 1
+   MQCFO_REFRESH_REPOSITORY_NO    = 0
+   MQCFO_REMOVE_QUEUES_YES        = 1
+   MQCFO_REMOVE_QUEUES_NO         = 0
+   MQCHIDS_NOT_INDOUBT            = 0
+   MQCHIDS_INDOUBT                = 1
+   MQCHS_INACTIVE                 = 0
+   MQCHS_BINDING                  = 1
+   MQCHS_STARTING                 = 2
+   MQCHS_RUNNING                  = 3
+   MQCHS_STOPPING                 = 4
+   MQCHS_RETRYING                 = 5
+   MQCHS_STOPPED                  = 6
+   MQCHS_REQUESTING               = 7
+   MQCHS_PAUSED                   = 8
+   MQCHS_INITIALIZING             = 13
+   MQCHSR_STOP_NOT_REQUESTED      = 0
+   MQCHSR_STOP_REQUESTED          = 1
+   MQCHTAB_Q_MGR                  = 1
+   MQCHTAB_CLNTCONN               = 2
+   MQCFR_YES                      = 1
+   MQCFR_NO                       = 0
+   MQET_MQSC                      = 1
+   MQEVO_OTHER                    = 0
+   MQEVO_CONSOLE                  = 1
+   MQEVO_INIT                     = 2
+   MQEVO_MSG                      = 3
+   MQEVO_MQSET                    = 4
+   MQEVO_INTERNAL                 = 5
+   MQEVR_DISABLED                 = 0
+   MQEVR_ENABLED                  = 1
+   MQFC_YES                       = 1
+   MQFC_NO                        = 0
+   MQIDO_COMMIT                   = 1
+   MQIDO_BACKOUT                  = 2
+   MQMCAS_STOPPED                 = 0
+   MQMCAS_RUNNING                 = 3
+   MQMODE_FORCE                   = 0
+   MQMODE_QUIESCE                 = 1
+   MQMODE_TERMINATE               = 2
+   MQPO_YES                       = 1
+   MQPO_NO                        = 0
+   MQQMDT_EXPLICIT_CLUSTER_SENDER = 1
+   MQQMDT_AUTO_CLUSTER_SENDER     = 2
+   MQQMDT_AUTO_EXP_CLUSTER_SENDER = 4
+   MQQMDT_CLUSTER_RECEIVER        = 3
+   MQQMT_NORMAL                   = 0
+   MQQMT_REPOSITORY               = 1
+   MQQO_YES                       = 1
+   MQQO_NO                        = 0
+   MQQSIE_NONE                    = 0
+   MQQSIE_HIGH                    = 1
+   MQQSIE_OK                      = 2
+   MQQSOT_ALL                     = 1
+   MQQSOT_INPUT                   = 2
+   MQQSOT_OUTPUT                  = 3
+   MQQSO_NO                       = 0
+   MQQSO_YES                      = 1
+   MQQSO_SHARED                   = 1
+   MQQSO_EXCLUSIVE                = 2
+   MQQSUM_YES                     = 1
+   MQQSUM_NO                      = 0
+   MQRP_YES                       = 1
+   MQRP_NO                        = 0
+   MQRQ_CONN_NOT_AUTHORIZED       = 1
+   MQRQ_OPEN_NOT_AUTHORIZED       = 2
+   MQRQ_CLOSE_NOT_AUTHORIZED      = 3
+   MQRQ_CMD_NOT_AUTHORIZED        = 4
+   MQRQ_Q_MGR_STOPPING            = 5
+   MQRQ_Q_MGR_QUIESCING           = 6
+   MQRQ_CHANNEL_STOPPED_OK        = 7
+   MQRQ_CHANNEL_STOPPED_ERROR     = 8
+   MQRQ_CHANNEL_STOPPED_RETRY     = 9
+   MQRQ_CHANNEL_STOPPED_DISABLED  = 10
+   MQRQ_BRIDGE_STOPPED_OK         = 11
+   MQRQ_BRIDGE_STOPPED_ERROR      = 12
+   MQRQ_SSL_HANDSHAKE_ERROR       = 13
+   MQRQ_SSL_CIPHER_SPEC_ERROR     = 14
+   MQRQ_SSL_CLIENT_AUTH_ERROR     = 15
+   MQRQ_SSL_PEER_NAME_ERROR       = 16
+   MQSCO_Q_MGR                    = 1
+   MQSCO_CELL                     = 2
+   MQSUS_YES                      = 1
+   MQSUS_NO                       = 0
+   MQDELO_NONE                    = 0x00000000
+   MQDELO_LOCAL                   = 0x00000004
+   MQPUBO_NONE                    = 0x00000000
+   MQPUBO_CORREL_ID_AS_IDENTITY   = 0x00000001
+   MQPUBO_RETAIN_PUBLICATION      = 0x00000002
+   MQPUBO_OTHER_SUBSCRIBERS_ONLY  = 0x00000004
+   MQPUBO_NO_REGISTRATION         = 0x00000008
+   MQPUBO_IS_RETAINED_PUBLICATION = 0x00000010
+   MQREGO_NONE                    = 0x00000000
+   MQREGO_CORREL_ID_AS_IDENTITY   = 0x00000001
+   MQREGO_ANONYMOUS               = 0x00000002
+   MQREGO_LOCAL                   = 0x00000004
+   MQREGO_DIRECT_REQUESTS         = 0x00000008
+   MQREGO_NEW_PUBLICATIONS_ONLY   = 0x00000010
+   MQREGO_PUBLISH_ON_REQUEST_ONLY = 0x00000020
+   MQREGO_DEREGISTER_ALL          = 0x00000040
+   MQREGO_INCLUDE_STREAM_NAME     = 0x00000080
+   MQREGO_INFORM_IF_RETAINED      = 0x00000100
+   MQREGO_DUPLICATES_OK           = 0x00000200
+   MQREGO_NON_PERSISTENT          = 0x00000400
+   MQREGO_PERSISTENT              = 0x00000800
+   MQREGO_PERSISTENT_AS_PUBLISH   = 0x00001000
+   MQREGO_PERSISTENT_AS_Q         = 0x00002000
+   MQREGO_ADD_NAME                = 0x00004000
+   MQREGO_NO_ALTERATION           = 0x00008000
+   MQREGO_FULL_RESPONSE           = 0x00010000
+   MQREGO_JOIN_SHARED             = 0x00020000
+   MQREGO_JOIN_EXCLUSIVE          = 0x00040000
+   MQREGO_LEAVE_ONLY              = 0x00080000
+   MQREGO_VARIABLE_USER_ID        = 0x00100000
+   MQREGO_LOCKED                  = 0x00200000
+   MQUA_FIRST                     = 65536
+   MQUA_LAST                      = 999999999
+end

data/lib/wmq/wmq_temp.rb

@@ -0,0 +1,197 @@
+################################################################################
+#  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.
+################################################################################
+
+module WMQ
+
+  # Temporary placeholder until the following code is moved to 'C'
+
+  #
+  class QueueManager
+    def method_missing(name, *args)
+      if args.size == 1
+        self.execute({:command=>name}.merge(args[0]))
+      elsif args.size == 0
+        self.execute({:command=>name})
+      else
+        raise("Invalid arguments supplied to QueueManager#:#{name}, args:#{args}")
+      end
+    end
+
+    # Execute any MQSC command against the queue manager
+    #
+    # Example
+    #   require 'wmq/wmq'
+    #   require 'wmq/wmq_const_admin'
+    #   WMQ::QueueManager.connect(:q_mgr_name=>'REID', :connection_name=>'localhost(1414)') do |qmgr|
+    #     qmgr.mqsc('dis ql(*)').each {|item| p item }
+    #   end
+    def mqsc(mqsc_text)
+      self.execute(:command=>:escape, :escape_type=>WMQ::MQET_MQSC, :escape_text=>mqsc_text).collect {|item| item[:escape_text] }
+    end
+
+    # Put a reply message back to the sender
+    #
+    #   The :message is sent to the queue and queue manager specified in the
+    #   :reply_to_q and :reply_to_q_mgr propoerties of the :request_message.
+    #
+    #   The following rules are followed before sending the reply:
+    #   - Only send replies to Request messages. No reply for Datagrams
+    #   - Set the message type to Reply when replying to a request message
+    #   - Reply with:
+    #     - Remaining Expiry (Ideally deduct any processing time since get)
+    #     - Same priority as received message
+    #     - Same persistence as received message
+    #   - Adhere to the Report options supplied for message and correlation id's
+    #       in reply message
+    #   - All headers must be returned on reply messages
+    #     - This allows the calling application to store state information
+    #       in these headers
+    #     - Unless of course if the relevant header is input only and used
+    #       for completing the request
+    #       - In this case any remaining headers should be returned
+    #         to the caller
+    #
+    # Parameters:
+    #   * :request_message The message originally received
+    #   * All the other parameters are the same as QueueManager#put
+    #
+    def put_to_reply_q(parms)
+      # Send replies only if message type is request
+      if parms[:request_message].descriptor[:msg_type] == WMQ::MQMT_REQUEST
+        request = parms.delete(:request_message)
+
+        reply = parms[:message] ||= Message.new(:data=>parms[:data])
+        reply.descriptor[:msg_type]   = WMQ::MQMT_REPLY
+        reply.descriptor[:expiry]     = request.descriptor[:expiry]
+        reply.descriptor[:priority]   = request.descriptor[:priority]
+        reply.descriptor[:persistence]= request.descriptor[:persistence]
+        reply.descriptor[:format] = request.descriptor[:format]
+
+        # Set Correlation Id based on report options supplied
+        if request.descriptor[:report] & WMQ::MQRO_PASS_CORREL_ID != 0
+          reply.descriptor[:correl_id] = request.descriptor[:correl_id]
+        else
+          reply.descriptor[:correl_id] = request.descriptor[:msg_id]
+        end
+
+        # Set Message Id based on report options supplied
+        if request.descriptor[:report] & WMQ::MQRO_PASS_MSG_ID != 0
+          reply.descriptor[:msg_id] = request.descriptor[:msg_id]
+        end
+
+        parms[:q_name]    = request.descriptor[:reply_to_q]
+        parms[:q_mgr_name]= request.descriptor[:reply_to_q_mgr]
+        return put(parms)
+      else
+        return false
+      end
+    end
+
+    # Put a message to the Dead Letter Queue
+    #
+    #   If an error occurs when processing a datagram message
+    #   it is necessary to move the message to the dead letter queue.
+    #   I.e. An error message cannot be sent back to the sender because
+    #        the original message was not a request message.
+    #          I.e. msg_type != WMQ::MQMT_REQUEST
+    #
+    #   All existing message data, message descriptor and message headers
+    #   are retained.
+    #
+    def put_to_dead_letter_q(parms)
+      message = parms[:message] ||= Message.new(:data=>parms[:data])
+      dlh = {
+        :header_type     =>:dead_letter_header,
+        :reason          =>parms.delete(:reason),
+        :dest_q_name     =>parms.delete(:q_name),
+        :dest_q_mgr_name =>self.name}
+
+      message.headers.unshift(dlh)
+      parms[:q_name]='SYSTEM.DEAD.LETTER.QUEUE'  #TODO Should be obtained from QMGR config
+      return self.put(parms)
+    end
+
+  end
+
+  # Message contains the message descriptor (MQMD), data
+  # and any headers.
+  #
+  # Note:
+  # * The format in the descriptor applies only to the format of the data portion,
+  #   not the format of any included headers
+  # * The message format can ONLY be supplied in the descriptor.
+  #   * I.e. It is the format of the data, Not the headers.
+  #   * On the wire formats are determined automatically by the :header_type key for 
+  #     each header
+  #   * Other WebSphere MQ interfaces require that the formats be "daisy-chained"
+  #     * I.e. The MQMD.Format is actually the format of the first header
+  #     * Ruby WMQ removes this tedious requirement and performs this
+  #       requirement automatically under the covers
+  #   * The format of any header should not be supplied in the descriptor or any header
+  #
+  # Message has the following attributes:
+  # * descriptor = {
+  #                                                           # WebSphere MQ Equivalent
+  #     :format             => WMQ::MQFMT_STRING,             # MQMD.Format - Format of data only
+  #                            WMQ::MQFMT_NONE                #   Do not supply header formats here
+  #     :original_length    => Number                         # MQMD.OriginalLength
+  #     :priority           => 0 .. 9                         # MQMD.Priority
+  #     :put_time           => String                         # MQMD.PutTime
+  #     :msg_id             => String                         ...
+  #     :expiry             => Number
+  #     :persistence        => Number
+  #     :reply_to_q         => String
+  #     :correl_id          => String
+  #     :feedback           => Number
+  #     :offset             => Number
+  #     :report             => Number
+  #     :msg_flags          => Number
+  #     :reply_to_q_mgr     => String
+  #     :appl_identity_data => String
+  #     :put_appl_name      => String
+  #     :user_identifier    => String
+  #     :msg_seq_number     => Number
+  #     :appl_origin_data   => String
+  #     :accounting_token   => String
+  #     :backout_count      => Number
+  #     :coded_char_set_id  => Number
+  #     :put_appl_type      => Number
+  #     :msg_type           => Number
+  #     :group_id           => String
+  #     :put_date           => String
+  #     :encoding           => Number
+  #   }
+  # * data => String
+  # * headers => Array of Hashes
+  #   * Note: Do not supply the format of any header. Ruby WMQ does this for you.
+  #   
+  #    The following headers are supported:
+  #   * Rules And Formatting Header (RFH)
+  #       :header_type => :rf_header
+  #       :....
+  #   * Rules and Formatting V2 Header (RFH2)
+  #       ....
+  #   * Dead Letter Header
+  #   * CICS Header
+  #   * IMS Header
+  #   * Transmission Queue Header
+  #   * ...
+  class Message
+    attr_reader :data, :descriptor, :headers
+    attr_writer :data, :descriptor, :headers
+  end
+
+end

data/lib/wmq.rb

@@ -0,0 +1,25 @@
+################################################################################
+#  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.
+################################################################################
+
+# Load wmq that uses auto-load library.
+# 
+# If it fails, then it is likely due to this platform not being supported
+# by auto load facility in Ruby WMQ, so try to load client linked library
+begin
+  require 'wmq/wmq'
+rescue LoadError
+  require 'wmq/wmq_client'
+end