jruby-jms 0.10.2 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. data/HISTORY.md +15 -0
  2. data/README.md +27 -28
  3. data/Rakefile +7 -1
  4. data/doc/classes/JMS.html +265 -0
  5. data/doc/classes/JMS/BytesMessage.html +215 -0
  6. data/doc/classes/JMS/Connection.html +1145 -0
  7. data/doc/classes/JMS/MapMessage.html +333 -0
  8. data/doc/classes/JMS/Message.html +1085 -0
  9. data/doc/classes/JMS/MessageConsumer.html +316 -0
  10. data/doc/classes/JMS/MessageListenerImpl.html +262 -0
  11. data/doc/classes/JMS/ObjectMessage.html +170 -0
  12. data/doc/classes/JMS/OracleAQConnectionFactory.html +184 -0
  13. data/doc/classes/JMS/QueueBrowser.html +155 -0
  14. data/doc/classes/JMS/Session.html +947 -0
  15. data/doc/classes/JMS/SessionPool.html +411 -0
  16. data/doc/classes/JMS/TextMessage.html +194 -0
  17. data/doc/created.rid +1 -0
  18. data/doc/files/README_md.html +440 -0
  19. data/doc/files/lib/jms/bytes_message_rb.html +122 -0
  20. data/doc/files/lib/jms/connection_rb.html +140 -0
  21. data/doc/files/lib/jms/imports_rb.html +108 -0
  22. data/doc/files/lib/jms/logging_rb.html +129 -0
  23. data/doc/files/lib/jms/map_message_rb.html +122 -0
  24. data/doc/files/lib/jms/message_consumer_rb.html +122 -0
  25. data/doc/files/lib/jms/message_listener_impl_rb.html +122 -0
  26. data/doc/files/lib/jms/message_rb.html +122 -0
  27. data/doc/files/lib/jms/object_message_rb.html +122 -0
  28. data/doc/files/lib/jms/oracle_a_q_connection_factory_rb.html +122 -0
  29. data/doc/files/lib/jms/queue_browser_rb.html +122 -0
  30. data/doc/files/lib/jms/session_pool_rb.html +108 -0
  31. data/doc/files/lib/jms/session_rb.html +164 -0
  32. data/doc/files/lib/jms/text_message_rb.html +122 -0
  33. data/doc/files/lib/jms_rb.html +131 -0
  34. data/doc/fr_class_index.html +39 -0
  35. data/doc/fr_file_index.html +42 -0
  36. data/doc/fr_method_index.html +120 -0
  37. data/doc/index.html +24 -0
  38. data/doc/rdoc-style.css +208 -0
  39. data/examples/advanced/session_pool.rb +37 -0
  40. data/examples/client-server/replier.rb +29 -0
  41. data/examples/client-server/requestor.rb +40 -0
  42. data/examples/jms.yml +85 -9
  43. data/examples/performance/consumer.rb +6 -8
  44. data/examples/performance/producer.rb +10 -10
  45. data/examples/producer-consumer/browser.rb +24 -0
  46. data/examples/{consumer.rb → producer-consumer/consumer.rb} +5 -4
  47. data/examples/producer-consumer/consumer_async.rb +30 -0
  48. data/examples/{producer.rb → producer-consumer/producer.rb} +5 -3
  49. data/examples/publish-subscribe/publish.rb +24 -0
  50. data/examples/publish-subscribe/subscribe.rb +31 -0
  51. data/lib/jms/bytes_message.rb +52 -0
  52. data/lib/jms/connection.rb +170 -162
  53. data/lib/jms/imports.rb +21 -0
  54. data/lib/jms/logging.rb +17 -1
  55. data/lib/jms/{javax_jms_map_message.rb → map_message.rb} +2 -2
  56. data/lib/jms/message.rb +285 -0
  57. data/lib/jms/{javax_jms_message_consumer.rb → message_consumer.rb} +6 -3
  58. data/lib/jms/{message_listener.rb → message_listener_impl.rb} +3 -3
  59. data/lib/jms/{javax_jms_object_message.rb → object_message.rb} +1 -1
  60. data/lib/jms/oracle_a_q_connection_factory.rb +35 -0
  61. data/lib/jms/{javax_jms_queue_browser.rb → queue_browser.rb} +5 -4
  62. data/lib/jms/{javax_jms_session.rb → session.rb} +23 -25
  63. data/lib/jms/session_pool.rb +148 -0
  64. data/lib/jms/{javax_jms_text_message.rb → text_message.rb} +1 -1
  65. data/test/connection_test.rb +31 -29
  66. data/test/jms.yml +8 -9
  67. data/test/message_test.rb +29 -29
  68. data/test/session_test.rb +39 -39
  69. metadata +62 -22
  70. data/lib/jms/javax_jms_message.rb +0 -264
data/doc/classes/JMS/MapMessage.html ADDED
@@ -0,0 +1,333 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Module: JMS::MapMessage</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Module</strong></td>
53
+ <td class="class-name-in-header">JMS::MapMessage</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../files/lib/jms/map_message_rb.html">
59
+ lib/jms/map_message.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ </table>
66
+ </div>
67
+ <!-- banner header -->
68
+
69
+ <div id="bodyContent">
70
+
71
+
72
+
73
+ <div id="contextContent">
74
+
75
+ <div id="description">
76
+ <p>
77
+ Interface javax.jms.<a href="MapMessage.html">MapMessage</a>
78
+ </p>
79
+
80
+ </div>
81
+
82
+
83
+ </div>
84
+
85
+ <div id="method-list">
86
+ <h3 class="section-bar">Methods</h3>
87
+
88
+ <div class="name-list">
89
+ <a href="#M000009">data</a>&nbsp;&nbsp;
90
+ <a href="#M000010">data=</a>&nbsp;&nbsp;
91
+ <a href="#M000011">each</a>&nbsp;&nbsp;
92
+ <a href="#M000012">each_pair</a>&nbsp;&nbsp;
93
+ <a href="#M000013">include?</a>&nbsp;&nbsp;
94
+ <a href="#M000008">to_h</a>&nbsp;&nbsp;
95
+ </div>
96
+ </div>
97
+
98
+ </div>
99
+
100
+
101
+ <!-- if includes -->
102
+ <div id="includes">
103
+ <h3 class="section-bar">Included Modules</h3>
104
+
105
+ <div id="includes-list">
106
+ <span class="include-name">Enumerable</span>
107
+ </div>
108
+ </div>
109
+
110
+ <div id="section">
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+ <!-- if method_list -->
120
+ <div id="methods">
121
+ <h3 class="section-bar">Public Instance methods</h3>
122
+
123
+ <div id="method-M000009" class="method-detail">
124
+ <a name="M000009"></a>
125
+
126
+ <div class="method-heading">
127
+ <a href="#M000009" class="method-signature">
128
+ <span class="method-name">data</span><span class="method-args">()</span>
129
+ </a>
130
+ </div>
131
+
132
+ <div class="method-description">
133
+ <p>
134
+ Return Map <a href="Message.html">Message</a> as a hash
135
+ </p>
136
+ <p><a class="source-toggle" href="#"
137
+ onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
138
+ <div class="method-source-code" id="M000009-source">
139
+ <pre>
140
+ <span class="ruby-comment cmt"># File lib/jms/map_message.rb, line 31</span>
141
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">data</span>
142
+ <span class="ruby-identifier">to_h</span>
143
+ <span class="ruby-keyword kw">end</span>
144
+ </pre>
145
+ </div>
146
+ </div>
147
+ </div>
148
+
149
+ <div id="method-M000010" class="method-detail">
150
+ <a name="M000010"></a>
151
+
152
+ <div class="method-heading">
153
+ <a href="#M000010" class="method-signature">
154
+ <span class="method-name">data=</span><span class="method-args">(data)</span>
155
+ </a>
156
+ </div>
157
+
158
+ <div class="method-description">
159
+ <p>
160
+ Copy values from supplied hash into this <a
161
+ href="MapMessage.html">MapMessage</a> Converts Ruby types to Java native
162
+ Data types as follows:
163
+ </p>
164
+ <pre>
165
+ Fixnum =&gt; long
166
+ Float =&gt; double
167
+ Bignum =&gt; long
168
+ true =&gt; boolean
169
+ false =&gt; boolean
170
+ nil =&gt; null
171
+ Otherwise it calls ::to_s on the supplied data type
172
+ </pre>
173
+ <p><a class="source-toggle" href="#"
174
+ onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
175
+ <div class="method-source-code" id="M000010-source">
176
+ <pre>
177
+ <span class="ruby-comment cmt"># File lib/jms/map_message.rb, line 44</span>
178
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">data=</span>(<span class="ruby-identifier">data</span>)
179
+ <span class="ruby-identifier">data</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>,<span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
180
+ <span class="ruby-keyword kw">case</span>
181
+ <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Fixnum</span> <span class="ruby-comment cmt"># 1</span>
182
+ <span class="ruby-identifier">setLong</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>,<span class="ruby-identifier">val</span>)
183
+ <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Float</span> <span class="ruby-comment cmt">#1.1</span>
184
+ <span class="ruby-identifier">setDouble</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>,<span class="ruby-identifier">val</span>)
185
+ <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Bignum</span> <span class="ruby-comment cmt"># 11111111111111111</span>
186
+ <span class="ruby-identifier">setLong</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>,<span class="ruby-identifier">val</span>)
187
+ <span class="ruby-keyword kw">when</span> (<span class="ruby-identifier">val</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">TrueClass</span>) <span class="ruby-operator">||</span> (<span class="ruby-identifier">val</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">FalseClass</span>)
188
+ <span class="ruby-identifier">setBoolean</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>,<span class="ruby-identifier">val</span>)
189
+ <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">NilClass</span>
190
+ <span class="ruby-identifier">setObject</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>,<span class="ruby-identifier">val</span>)
191
+ <span class="ruby-keyword kw">else</span>
192
+ <span class="ruby-identifier">setString</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>,<span class="ruby-identifier">val</span>.<span class="ruby-identifier">to_s</span>)
193
+ <span class="ruby-keyword kw">end</span>
194
+ <span class="ruby-keyword kw">end</span>
195
+ <span class="ruby-keyword kw">end</span>
196
+ </pre>
197
+ </div>
198
+ </div>
199
+ </div>
200
+
201
+ <div id="method-M000011" class="method-detail">
202
+ <a name="M000011"></a>
203
+
204
+ <div class="method-heading">
205
+ <a href="#M000011" class="method-signature">
206
+ <span class="method-name">each</span><span class="method-args">(&amp;proc)</span>
207
+ </a>
208
+ </div>
209
+
210
+ <div class="method-description">
211
+ <p>
212
+ Return <a href="MapMessage.html#M000011">each</a> name value pair
213
+ </p>
214
+ <p><a class="source-toggle" href="#"
215
+ onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
216
+ <div class="method-source-code" id="M000011-source">
217
+ <pre>
218
+ <span class="ruby-comment cmt"># File lib/jms/map_message.rb, line 64</span>
219
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">proc</span>)
220
+ <span class="ruby-comment cmt"># When key and value are expected separately. Should actually be calling each_pair anyway</span>
221
+ <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">proc</span>.<span class="ruby-identifier">arity</span> <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
222
+ <span class="ruby-identifier">each_pair</span>(<span class="ruby-identifier">proc</span>)
223
+ <span class="ruby-keyword kw">else</span>
224
+ <span class="ruby-identifier">enum</span> = <span class="ruby-identifier">getMapNames</span>
225
+ <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">enum</span>.<span class="ruby-identifier">has_more_elements</span>
226
+ <span class="ruby-identifier">key</span> = <span class="ruby-identifier">enum</span>.<span class="ruby-identifier">next_element</span>
227
+ <span class="ruby-identifier">proc</span>.<span class="ruby-identifier">call</span> [<span class="ruby-identifier">key</span>, <span class="ruby-identifier">getObject</span>(<span class="ruby-identifier">key</span>)]
228
+ <span class="ruby-keyword kw">end</span>
229
+ <span class="ruby-keyword kw">end</span>
230
+ <span class="ruby-keyword kw">end</span>
231
+ </pre>
232
+ </div>
233
+ </div>
234
+ </div>
235
+
236
+ <div id="method-M000012" class="method-detail">
237
+ <a name="M000012"></a>
238
+
239
+ <div class="method-heading">
240
+ <a href="#M000012" class="method-signature">
241
+ <span class="method-name">each_pair</span><span class="method-args">(&amp;proc)</span>
242
+ </a>
243
+ </div>
244
+
245
+ <div class="method-description">
246
+ <p>
247
+ Return <a href="MapMessage.html#M000011">each</a> name value pair
248
+ </p>
249
+ <p><a class="source-toggle" href="#"
250
+ onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
251
+ <div class="method-source-code" id="M000012-source">
252
+ <pre>
253
+ <span class="ruby-comment cmt"># File lib/jms/map_message.rb, line 78</span>
254
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each_pair</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">proc</span>)
255
+ <span class="ruby-identifier">enum</span> = <span class="ruby-identifier">getMapNames</span>
256
+ <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">enum</span>.<span class="ruby-identifier">has_more_elements</span>
257
+ <span class="ruby-identifier">key</span> = <span class="ruby-identifier">enum</span>.<span class="ruby-identifier">next_element</span>
258
+ <span class="ruby-identifier">proc</span>.<span class="ruby-identifier">call</span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">getObject</span>(<span class="ruby-identifier">key</span>)
259
+ <span class="ruby-keyword kw">end</span>
260
+ <span class="ruby-keyword kw">end</span>
261
+ </pre>
262
+ </div>
263
+ </div>
264
+ </div>
265
+
266
+ <div id="method-M000013" class="method-detail">
267
+ <a name="M000013"></a>
268
+
269
+ <div class="method-heading">
270
+ <a href="#M000013" class="method-signature">
271
+ <span class="method-name">include?</span><span class="method-args">(key)</span>
272
+ </a>
273
+ </div>
274
+
275
+ <div class="method-description">
276
+ <p>
277
+ Does map include specified key
278
+ </p>
279
+ <p><a class="source-toggle" href="#"
280
+ onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
281
+ <div class="method-source-code" id="M000013-source">
282
+ <pre>
283
+ <span class="ruby-comment cmt"># File lib/jms/map_message.rb, line 87</span>
284
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
285
+ <span class="ruby-comment cmt"># Ensure a Ruby true is returned</span>
286
+ <span class="ruby-identifier">item_exists</span>(<span class="ruby-identifier">key</span>) <span class="ruby-operator">==</span> <span class="ruby-keyword kw">true</span>
287
+ <span class="ruby-keyword kw">end</span>
288
+ </pre>
289
+ </div>
290
+ </div>
291
+ </div>
292
+
293
+ <div id="method-M000008" class="method-detail">
294
+ <a name="M000008"></a>
295
+
296
+ <div class="method-heading">
297
+ <a href="#M000008" class="method-signature">
298
+ <span class="method-name">to_h</span><span class="method-args">()</span>
299
+ </a>
300
+ </div>
301
+
302
+ <div class="method-description">
303
+ <p>
304
+ Return Map <a href="Message.html">Message</a> as a hash
305
+ </p>
306
+ <p><a class="source-toggle" href="#"
307
+ onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
308
+ <div class="method-source-code" id="M000008-source">
309
+ <pre>
310
+ <span class="ruby-comment cmt"># File lib/jms/map_message.rb, line 24</span>
311
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_h</span>
312
+ <span class="ruby-identifier">h</span> = {}
313
+ <span class="ruby-identifier">each_pair</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>}
314
+ <span class="ruby-identifier">h</span>
315
+ <span class="ruby-keyword kw">end</span>
316
+ </pre>
317
+ </div>
318
+ </div>
319
+ </div>
320
+
321
+
322
+ </div>
323
+
324
+
325
+ </div>
326
+
327
+
328
+ <div id="validator-badges">
329
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
330
+ </div>
331
+
332
+ </body>
333
+ </html>
data/doc/classes/JMS/Message.html ADDED
@@ -0,0 +1,1085 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Module: JMS::Message</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Module</strong></td>
53
+ <td class="class-name-in-header">JMS::Message</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../files/lib/jms/message_rb.html">
59
+ lib/jms/message.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ </table>
66
+ </div>
67
+ <!-- banner header -->
68
+
69
+ <div id="bodyContent">
70
+
71
+
72
+
73
+ <div id="contextContent">
74
+
75
+ <div id="description">
76
+ <p>
77
+ Extend <a href="../JMS.html">JMS</a> <a href="Message.html">Message</a>
78
+ Interface with Ruby methods
79
+ </p>
80
+ <p>
81
+ A <a href="Message.html">Message</a> is the item that can be put on a
82
+ queue, or obtained from a queue.
83
+ </p>
84
+ <p>
85
+ A <a href="Message.html">Message</a> consists of 3 major parts:
86
+ </p>
87
+ <pre>
88
+ - Header
89
+ Accessible as attributes of the Message class
90
+ - Properties
91
+ Accessible via [] and []= methods
92
+ - Data
93
+ The actual data portion of the message
94
+ See the specific message types for details on how to access the data
95
+ portion of the message
96
+ </pre>
97
+ <p>
98
+ For further help on javax.jms.<a href="Message.html">Message</a>
99
+ </p>
100
+ <pre>
101
+ http://download.oracle.com/javaee/6/api/index.html?javax/jms/Message.html
102
+ </pre>
103
+ <p>
104
+ Interface javax.jms.<a href="Message.html">Message</a>
105
+ </p>
106
+
107
+ </div>
108
+
109
+
110
+ </div>
111
+
112
+ <div id="method-list">
113
+ <h3 class="section-bar">Methods</h3>
114
+
115
+ <div class="name-list">
116
+ <a href="#M000038">[]</a>&nbsp;&nbsp;
117
+ <a href="#M000039">[]=</a>&nbsp;&nbsp;
118
+ <a href="#M000037">attributes</a>&nbsp;&nbsp;
119
+ <a href="#M000040">include?</a>&nbsp;&nbsp;
120
+ <a href="#M000044">inspect</a>&nbsp;&nbsp;
121
+ <a href="#M000017">jms_correlation_id</a>&nbsp;&nbsp;
122
+ <a href="#M000018">jms_correlation_id=</a>&nbsp;&nbsp;
123
+ <a href="#M000014">jms_delivery_mode</a>&nbsp;&nbsp;
124
+ <a href="#M000015">jms_delivery_mode=</a>&nbsp;&nbsp;
125
+ <a href="#M000035">jms_delivery_mode_sym</a>&nbsp;&nbsp;
126
+ <a href="#M000036">jms_delivery_mode_sym=</a>&nbsp;&nbsp;
127
+ <a href="#M000019">jms_destination</a>&nbsp;&nbsp;
128
+ <a href="#M000020">jms_destination=</a>&nbsp;&nbsp;
129
+ <a href="#M000021">jms_expiration</a>&nbsp;&nbsp;
130
+ <a href="#M000022">jms_expiration=</a>&nbsp;&nbsp;
131
+ <a href="#M000023">jms_message_id</a>&nbsp;&nbsp;
132
+ <a href="#M000024">jms_message_id=</a>&nbsp;&nbsp;
133
+ <a href="#M000025">jms_priority</a>&nbsp;&nbsp;
134
+ <a href="#M000026">jms_priority=</a>&nbsp;&nbsp;
135
+ <a href="#M000028">jms_redelivered=</a>&nbsp;&nbsp;
136
+ <a href="#M000027">jms_redelivered?</a>&nbsp;&nbsp;
137
+ <a href="#M000029">jms_reply_to</a>&nbsp;&nbsp;
138
+ <a href="#M000030">jms_reply_to=</a>&nbsp;&nbsp;
139
+ <a href="#M000031">jms_timestamp</a>&nbsp;&nbsp;
140
+ <a href="#M000032">jms_timestamp=</a>&nbsp;&nbsp;
141
+ <a href="#M000033">jms_type</a>&nbsp;&nbsp;
142
+ <a href="#M000034">jms_type=</a>&nbsp;&nbsp;
143
+ <a href="#M000016">persistent?</a>&nbsp;&nbsp;
144
+ <a href="#M000041">properties</a>&nbsp;&nbsp;
145
+ <a href="#M000042">properties=</a>&nbsp;&nbsp;
146
+ <a href="#M000043">properties_each_pair</a>&nbsp;&nbsp;
147
+ </div>
148
+ </div>
149
+
150
+ </div>
151
+
152
+
153
+ <!-- if includes -->
154
+
155
+ <div id="section">
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+ <!-- if method_list -->
165
+ <div id="methods">
166
+ <h3 class="section-bar">Public Instance methods</h3>
167
+
168
+ <div id="method-M000038" class="method-detail">
169
+ <a name="M000038"></a>
170
+
171
+ <div class="method-heading">
172
+ <a href="#M000038" class="method-signature">
173
+ <span class="method-name">[]</span><span class="method-args">(key)</span>
174
+ </a>
175
+ </div>
176
+
177
+ <div class="method-description">
178
+ <p>
179
+ Get the value of a property
180
+ </p>
181
+ <p><a class="source-toggle" href="#"
182
+ onclick="toggleCode('M000038-source');return false;">[Source]</a></p>
183
+ <div class="method-source-code" id="M000038-source">
184
+ <pre>
185
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 243</span>
186
+ <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
187
+ <span class="ruby-identifier">getObjectProperty</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>
188
+ <span class="ruby-keyword kw">end</span>
189
+ </pre>
190
+ </div>
191
+ </div>
192
+ </div>
193
+
194
+ <div id="method-M000039" class="method-detail">
195
+ <a name="M000039"></a>
196
+
197
+ <div class="method-heading">
198
+ <a href="#M000039" class="method-signature">
199
+ <span class="method-name">[]=</span><span class="method-args">(key, value)</span>
200
+ </a>
201
+ </div>
202
+
203
+ <div class="method-description">
204
+ <p>
205
+ Set a property
206
+ </p>
207
+ <p><a class="source-toggle" href="#"
208
+ onclick="toggleCode('M000039-source');return false;">[Source]</a></p>
209
+ <div class="method-source-code" id="M000039-source">
210
+ <pre>
211
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 248</span>
212
+ <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>)
213
+ <span class="ruby-identifier">setObjectProperty</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">value</span>)
214
+ <span class="ruby-keyword kw">end</span>
215
+ </pre>
216
+ </div>
217
+ </div>
218
+ </div>
219
+
220
+ <div id="method-M000037" class="method-detail">
221
+ <a name="M000037"></a>
222
+
223
+ <div class="method-heading">
224
+ <a href="#M000037" class="method-signature">
225
+ <span class="method-name">attributes</span><span class="method-args">()</span>
226
+ </a>
227
+ </div>
228
+
229
+ <div class="method-description">
230
+ <p>
231
+ Return the <a href="Message.html#M000037">attributes</a> (header fields) of
232
+ the message as a Hash
233
+ </p>
234
+ <p><a class="source-toggle" href="#"
235
+ onclick="toggleCode('M000037-source');return false;">[Source]</a></p>
236
+ <div class="method-source-code" id="M000037-source">
237
+ <pre>
238
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 225</span>
239
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">attributes</span>
240
+ {
241
+ <span class="ruby-identifier">:jms_correlation_id</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">jms_correlation_id</span>,
242
+ <span class="ruby-identifier">:jms_delivery_mode</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">jms_delivery_mode_sym</span>,
243
+ <span class="ruby-identifier">:jms_destination</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">jms_destination</span>,
244
+ <span class="ruby-identifier">:jms_expiration</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">jms_expiration</span>,
245
+ <span class="ruby-identifier">:jms_message_id</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">jms_message_id</span>,
246
+ <span class="ruby-identifier">:jms_priority</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">jms_priority</span>,
247
+ <span class="ruby-identifier">:jms_redelivered</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">jms_redelivered?</span>,
248
+ <span class="ruby-identifier">:jms_reply_to</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">jms_reply_to</span>,
249
+ <span class="ruby-identifier">:jms_timestamp</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">jms_timestamp</span>,
250
+ <span class="ruby-identifier">:jms_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">jms_type</span>,
251
+ }
252
+ <span class="ruby-keyword kw">end</span>
253
+ </pre>
254
+ </div>
255
+ </div>
256
+ </div>
257
+
258
+ <div id="method-M000040" class="method-detail">
259
+ <a name="M000040"></a>
260
+
261
+ <div class="method-heading">
262
+ <a href="#M000040" class="method-signature">
263
+ <span class="method-name">include?</span><span class="method-args">(key)</span>
264
+ </a>
265
+ </div>
266
+
267
+ <div class="method-description">
268
+ <p>
269
+ Does message include specified property?
270
+ </p>
271
+ <p><a class="source-toggle" href="#"
272
+ onclick="toggleCode('M000040-source');return false;">[Source]</a></p>
273
+ <div class="method-source-code" id="M000040-source">
274
+ <pre>
275
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 253</span>
276
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
277
+ <span class="ruby-comment cmt"># Ensure a Ruby true is returned</span>
278
+ <span class="ruby-identifier">property_exists</span>(<span class="ruby-identifier">key</span>) <span class="ruby-operator">==</span> <span class="ruby-keyword kw">true</span>
279
+ <span class="ruby-keyword kw">end</span>
280
+ </pre>
281
+ </div>
282
+ </div>
283
+ </div>
284
+
285
+ <div id="method-M000044" class="method-detail">
286
+ <a name="M000044"></a>
287
+
288
+ <div class="method-heading">
289
+ <a href="#M000044" class="method-signature">
290
+ <span class="method-name">inspect</span><span class="method-args">()</span>
291
+ </a>
292
+ </div>
293
+
294
+ <div class="method-description">
295
+ <p><a class="source-toggle" href="#"
296
+ onclick="toggleCode('M000044-source');return false;">[Source]</a></p>
297
+ <div class="method-source-code" id="M000044-source">
298
+ <pre>
299
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 281</span>
300
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inspect</span>
301
+ <span class="ruby-node">&quot;#{self.class.name}: #{data}\nAttributes: #{attributes.inspect}\nProperties: #{properties.inspect}&quot;</span>
302
+ <span class="ruby-keyword kw">end</span>
303
+ </pre>
304
+ </div>
305
+ </div>
306
+ </div>
307
+
308
+ <div id="method-M000017" class="method-detail">
309
+ <a name="M000017"></a>
310
+
311
+ <div class="method-heading">
312
+ <a href="#M000017" class="method-signature">
313
+ <span class="method-name">jms_correlation_id</span><span class="method-args">()</span>
314
+ </a>
315
+ </div>
316
+
317
+ <div class="method-description">
318
+ <p>
319
+ Returns the <a href="Message.html">Message</a> correlation ID as a String
320
+ The resulting string may contain nulls
321
+ </p>
322
+ <p><a class="source-toggle" href="#"
323
+ onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
324
+ <div class="method-source-code" id="M000017-source">
325
+ <pre>
326
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 87</span>
327
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_correlation_id</span>
328
+ <span class="ruby-constant">String</span>.<span class="ruby-identifier">from_java_bytes</span>(<span class="ruby-identifier">getJMSCorrelationIDAsBytes</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">getJMSCorrelationIDAsBytes</span>
329
+ <span class="ruby-keyword kw">end</span>
330
+ </pre>
331
+ </div>
332
+ </div>
333
+ </div>
334
+
335
+ <div id="method-M000018" class="method-detail">
336
+ <a name="M000018"></a>
337
+
338
+ <div class="method-heading">
339
+ <a href="#M000018" class="method-signature">
340
+ <span class="method-name">jms_correlation_id=</span><span class="method-args">(correlation_id)</span>
341
+ </a>
342
+ </div>
343
+
344
+ <div class="method-description">
345
+ <p>
346
+ Set the <a href="Message.html">Message</a> correlation ID
347
+ </p>
348
+ <pre>
349
+ correlation_id: String
350
+ </pre>
351
+ <p>
352
+ Also supports embedded nulls within the correlation id
353
+ </p>
354
+ <p><a class="source-toggle" href="#"
355
+ onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
356
+ <div class="method-source-code" id="M000018-source">
357
+ <pre>
358
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 94</span>
359
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_correlation_id=</span>(<span class="ruby-identifier">correlation_id</span>)
360
+ <span class="ruby-identifier">setJMSCorrelationIDAsBytes</span>(<span class="ruby-identifier">correlation_id</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">correlation_id</span>.<span class="ruby-identifier">to_java_bytes</span>)
361
+ <span class="ruby-keyword kw">end</span>
362
+ </pre>
363
+ </div>
364
+ </div>
365
+ </div>
366
+
367
+ <div id="method-M000014" class="method-detail">
368
+ <a name="M000014"></a>
369
+
370
+ <div class="method-heading">
371
+ <a href="#M000014" class="method-signature">
372
+ <span class="method-name">jms_delivery_mode</span><span class="method-args">()</span>
373
+ </a>
374
+ </div>
375
+
376
+ <div class="method-description">
377
+ <p>
378
+ Returns the <a href="../JMS.html">JMS</a> Delivery Mode One of the
379
+ following will be returned
380
+ </p>
381
+ <pre>
382
+ JMS::DeliveryMode::PERSISTENT
383
+ JMS::DeliveryMode::NON_PERSISTENT
384
+ </pre>
385
+ <p><a class="source-toggle" href="#"
386
+ onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
387
+ <div class="method-source-code" id="M000014-source">
388
+ <pre>
389
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 67</span>
390
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_delivery_mode</span>
391
+ <span class="ruby-identifier">getJMSDeliveryMode</span>
392
+ <span class="ruby-keyword kw">end</span>
393
+ </pre>
394
+ </div>
395
+ </div>
396
+ </div>
397
+
398
+ <div id="method-M000015" class="method-detail">
399
+ <a name="M000015"></a>
400
+
401
+ <div class="method-heading">
402
+ <a href="#M000015" class="method-signature">
403
+ <span class="method-name">jms_delivery_mode=</span><span class="method-args">(mode)</span>
404
+ </a>
405
+ </div>
406
+
407
+ <div class="method-description">
408
+ <p>
409
+ Set the <a href="../JMS.html">JMS</a> Delivery Mode Values can be
410
+ </p>
411
+ <pre>
412
+ JMS::DeliveryMode::PERSISTENT
413
+ JMS::DeliveryMode::NON_PERSISTENT
414
+ </pre>
415
+ <p><a class="source-toggle" href="#"
416
+ onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
417
+ <div class="method-source-code" id="M000015-source">
418
+ <pre>
419
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 75</span>
420
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_delivery_mode=</span>(<span class="ruby-identifier">mode</span>)
421
+ <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Sorry, due to incompatibility with JRuby 1.6, please call jms_delivery_mode_sym when using symbols&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">mode</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Symbol</span>
422
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">setJMSDeliveryMode</span>(<span class="ruby-identifier">mode</span>)
423
+ <span class="ruby-keyword kw">end</span>
424
+ </pre>
425
+ </div>
426
+ </div>
427
+ </div>
428
+
429
+ <div id="method-M000035" class="method-detail">
430
+ <a name="M000035"></a>
431
+
432
+ <div class="method-heading">
433
+ <a href="#M000035" class="method-signature">
434
+ <span class="method-name">jms_delivery_mode_sym</span><span class="method-args">()</span>
435
+ </a>
436
+ </div>
437
+
438
+ <div class="method-description">
439
+ <p>
440
+ Return the <a href="../JMS.html">JMS</a> Delivery Mode as a Ruby symbol
441
+ </p>
442
+ <pre>
443
+ :persistent
444
+ :non_persistent
445
+ nil if unknown
446
+ </pre>
447
+ <p><a class="source-toggle" href="#"
448
+ onclick="toggleCode('M000035-source');return false;">[Source]</a></p>
449
+ <div class="method-source-code" id="M000035-source">
450
+ <pre>
451
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 197</span>
452
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_delivery_mode_sym</span>
453
+ <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">jms_delivery_mode</span>
454
+ <span class="ruby-keyword kw">when</span> <span class="ruby-constant">JMS</span><span class="ruby-operator">::</span><span class="ruby-constant">DeliveryMode</span><span class="ruby-operator">::</span><span class="ruby-constant">PERSISTENT</span>
455
+ <span class="ruby-identifier">:persistent</span>
456
+ <span class="ruby-keyword kw">when</span> <span class="ruby-constant">JMS</span><span class="ruby-operator">::</span><span class="ruby-constant">DeliveryMode</span><span class="ruby-operator">::</span><span class="ruby-constant">NON_PERSISTENT</span>
457
+ <span class="ruby-identifier">:non_persistent</span>
458
+ <span class="ruby-keyword kw">else</span>
459
+ <span class="ruby-keyword kw">nil</span>
460
+ <span class="ruby-keyword kw">end</span>
461
+ <span class="ruby-keyword kw">end</span>
462
+ </pre>
463
+ </div>
464
+ </div>
465
+ </div>
466
+
467
+ <div id="method-M000036" class="method-detail">
468
+ <a name="M000036"></a>
469
+
470
+ <div class="method-heading">
471
+ <a href="#M000036" class="method-signature">
472
+ <span class="method-name">jms_delivery_mode_sym=</span><span class="method-args">(mode)</span>
473
+ </a>
474
+ </div>
475
+
476
+ <div class="method-description">
477
+ <p>
478
+ Set the <a href="../JMS.html">JMS</a> Delivery Mode from a Ruby Symbol
479
+ Valid values for mode
480
+ </p>
481
+ <pre>
482
+ :persistent
483
+ :non_persistent
484
+ </pre>
485
+ <p><a class="source-toggle" href="#"
486
+ onclick="toggleCode('M000036-source');return false;">[Source]</a></p>
487
+ <div class="method-source-code" id="M000036-source">
488
+ <pre>
489
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 212</span>
490
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_delivery_mode_sym=</span>(<span class="ruby-identifier">mode</span>)
491
+ <span class="ruby-identifier">val</span> = <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">mode</span>
492
+ <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:persistent</span>
493
+ <span class="ruby-constant">JMS</span><span class="ruby-operator">::</span><span class="ruby-constant">DeliveryMode</span><span class="ruby-operator">::</span><span class="ruby-constant">PERSISTENT</span>
494
+ <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:non_persistent</span>
495
+ <span class="ruby-constant">JMS</span><span class="ruby-operator">::</span><span class="ruby-constant">DeliveryMode</span><span class="ruby-operator">::</span><span class="ruby-constant">NON_PERSISTENT</span>
496
+ <span class="ruby-keyword kw">else</span>
497
+ <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Unknown delivery mode symbol: #{mode}&quot;</span>
498
+ <span class="ruby-keyword kw">end</span>
499
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">setJMSDeliveryMode</span>(<span class="ruby-identifier">val</span>)
500
+ <span class="ruby-keyword kw">end</span>
501
+ </pre>
502
+ </div>
503
+ </div>
504
+ </div>
505
+
506
+ <div id="method-M000019" class="method-detail">
507
+ <a name="M000019"></a>
508
+
509
+ <div class="method-heading">
510
+ <a href="#M000019" class="method-signature">
511
+ <span class="method-name">jms_destination</span><span class="method-args">()</span>
512
+ </a>
513
+ </div>
514
+
515
+ <div class="method-description">
516
+ <p>
517
+ Returns the <a href="Message.html">Message</a> Destination
518
+ </p>
519
+ <pre>
520
+ Instance of JMS::Destination
521
+ </pre>
522
+ <p><a class="source-toggle" href="#"
523
+ onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
524
+ <div class="method-source-code" id="M000019-source">
525
+ <pre>
526
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 100</span>
527
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_destination</span>
528
+ <span class="ruby-identifier">getJMSDestination</span>
529
+ <span class="ruby-keyword kw">end</span>
530
+ </pre>
531
+ </div>
532
+ </div>
533
+ </div>
534
+
535
+ <div id="method-M000020" class="method-detail">
536
+ <a name="M000020"></a>
537
+
538
+ <div class="method-heading">
539
+ <a href="#M000020" class="method-signature">
540
+ <span class="method-name">jms_destination=</span><span class="method-args">(destination)</span>
541
+ </a>
542
+ </div>
543
+
544
+ <div class="method-description">
545
+ <p>
546
+ Set the <a href="Message.html">Message</a> Destination
547
+ </p>
548
+ <pre>
549
+ jms_destination: Must be an instance of JMS::Destination
550
+ </pre>
551
+ <p><a class="source-toggle" href="#"
552
+ onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
553
+ <div class="method-source-code" id="M000020-source">
554
+ <pre>
555
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 106</span>
556
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_destination=</span>(<span class="ruby-identifier">destination</span>)
557
+ <span class="ruby-identifier">setJMSDestination</span>(<span class="ruby-identifier">destination</span>)
558
+ <span class="ruby-keyword kw">end</span>
559
+ </pre>
560
+ </div>
561
+ </div>
562
+ </div>
563
+
564
+ <div id="method-M000021" class="method-detail">
565
+ <a name="M000021"></a>
566
+
567
+ <div class="method-heading">
568
+ <a href="#M000021" class="method-signature">
569
+ <span class="method-name">jms_expiration</span><span class="method-args">()</span>
570
+ </a>
571
+ </div>
572
+
573
+ <div class="method-description">
574
+ <p>
575
+ Return the message expiration value as an Integer
576
+ </p>
577
+ <p><a class="source-toggle" href="#"
578
+ onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
579
+ <div class="method-source-code" id="M000021-source">
580
+ <pre>
581
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 111</span>
582
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_expiration</span>
583
+ <span class="ruby-identifier">getJMSExpiration</span>
584
+ <span class="ruby-keyword kw">end</span>
585
+ </pre>
586
+ </div>
587
+ </div>
588
+ </div>
589
+
590
+ <div id="method-M000022" class="method-detail">
591
+ <a name="M000022"></a>
592
+
593
+ <div class="method-heading">
594
+ <a href="#M000022" class="method-signature">
595
+ <span class="method-name">jms_expiration=</span><span class="method-args">(expiration)</span>
596
+ </a>
597
+ </div>
598
+
599
+ <div class="method-description">
600
+ <p>
601
+ Set the <a href="Message.html">Message</a> expiration value
602
+ </p>
603
+ <pre>
604
+ expiration: Integer
605
+ </pre>
606
+ <p><a class="source-toggle" href="#"
607
+ onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
608
+ <div class="method-source-code" id="M000022-source">
609
+ <pre>
610
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 117</span>
611
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_expiration=</span>(<span class="ruby-identifier">expiration</span>)
612
+ <span class="ruby-identifier">setJMSExpiration</span>(<span class="ruby-identifier">expiration</span>)
613
+ <span class="ruby-keyword kw">end</span>
614
+ </pre>
615
+ </div>
616
+ </div>
617
+ </div>
618
+
619
+ <div id="method-M000023" class="method-detail">
620
+ <a name="M000023"></a>
621
+
622
+ <div class="method-heading">
623
+ <a href="#M000023" class="method-signature">
624
+ <span class="method-name">jms_message_id</span><span class="method-args">()</span>
625
+ </a>
626
+ </div>
627
+
628
+ <div class="method-description">
629
+ <p>
630
+ Returns the <a href="Message.html">Message</a> ID as a String The resulting
631
+ string may contain embedded nulls
632
+ </p>
633
+ <p><a class="source-toggle" href="#"
634
+ onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
635
+ <div class="method-source-code" id="M000023-source">
636
+ <pre>
637
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 123</span>
638
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_message_id</span>
639
+ <span class="ruby-identifier">getJMSMessageID</span>
640
+ <span class="ruby-keyword kw">end</span>
641
+ </pre>
642
+ </div>
643
+ </div>
644
+ </div>
645
+
646
+ <div id="method-M000024" class="method-detail">
647
+ <a name="M000024"></a>
648
+
649
+ <div class="method-heading">
650
+ <a href="#M000024" class="method-signature">
651
+ <span class="method-name">jms_message_id=</span><span class="method-args">(message_id)</span>
652
+ </a>
653
+ </div>
654
+
655
+ <div class="method-description">
656
+ <p>
657
+ Set the <a href="Message.html">Message</a> correlation ID
658
+ </p>
659
+ <pre>
660
+ message_id: String
661
+ </pre>
662
+ <p>
663
+ Also supports nulls within the message id
664
+ </p>
665
+ <p><a class="source-toggle" href="#"
666
+ onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
667
+ <div class="method-source-code" id="M000024-source">
668
+ <pre>
669
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 130</span>
670
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_message_id=</span>(<span class="ruby-identifier">message_id</span>)
671
+ <span class="ruby-identifier">setJMSMessageID</span>(<span class="ruby-identifier">message_id</span>)
672
+ <span class="ruby-keyword kw">end</span>
673
+ </pre>
674
+ </div>
675
+ </div>
676
+ </div>
677
+
678
+ <div id="method-M000025" class="method-detail">
679
+ <a name="M000025"></a>
680
+
681
+ <div class="method-heading">
682
+ <a href="#M000025" class="method-signature">
683
+ <span class="method-name">jms_priority</span><span class="method-args">()</span>
684
+ </a>
685
+ </div>
686
+
687
+ <div class="method-description">
688
+ <p>
689
+ Returns the <a href="Message.html">Message</a> Priority level as an Integer
690
+ </p>
691
+ <p><a class="source-toggle" href="#"
692
+ onclick="toggleCode('M000025-source');return false;">[Source]</a></p>
693
+ <div class="method-source-code" id="M000025-source">
694
+ <pre>
695
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 135</span>
696
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_priority</span>
697
+ <span class="ruby-identifier">getJMSPriority</span>
698
+ <span class="ruby-keyword kw">end</span>
699
+ </pre>
700
+ </div>
701
+ </div>
702
+ </div>
703
+
704
+ <div id="method-M000026" class="method-detail">
705
+ <a name="M000026"></a>
706
+
707
+ <div class="method-heading">
708
+ <a href="#M000026" class="method-signature">
709
+ <span class="method-name">jms_priority=</span><span class="method-args">(priority)</span>
710
+ </a>
711
+ </div>
712
+
713
+ <div class="method-description">
714
+ <p>
715
+ Set the <a href="Message.html">Message</a> priority level
716
+ </p>
717
+ <pre>
718
+ priority: Integer
719
+ </pre>
720
+ <p><a class="source-toggle" href="#"
721
+ onclick="toggleCode('M000026-source');return false;">[Source]</a></p>
722
+ <div class="method-source-code" id="M000026-source">
723
+ <pre>
724
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 141</span>
725
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_priority=</span>(<span class="ruby-identifier">priority</span>)
726
+ <span class="ruby-identifier">setJMSPriority</span>(<span class="ruby-identifier">priority</span>)
727
+ <span class="ruby-keyword kw">end</span>
728
+ </pre>
729
+ </div>
730
+ </div>
731
+ </div>
732
+
733
+ <div id="method-M000028" class="method-detail">
734
+ <a name="M000028"></a>
735
+
736
+ <div class="method-heading">
737
+ <a href="#M000028" class="method-signature">
738
+ <span class="method-name">jms_redelivered=</span><span class="method-args">(bool)</span>
739
+ </a>
740
+ </div>
741
+
742
+ <div class="method-description">
743
+ <p>
744
+ Set whether the <a href="Message.html">Message</a> was redelivered
745
+ </p>
746
+ <pre>
747
+ bool: Boolean
748
+ </pre>
749
+ <p><a class="source-toggle" href="#"
750
+ onclick="toggleCode('M000028-source');return false;">[Source]</a></p>
751
+ <div class="method-source-code" id="M000028-source">
752
+ <pre>
753
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 152</span>
754
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_redelivered=</span>(<span class="ruby-identifier">bool</span>)
755
+ <span class="ruby-identifier">setJMSPriority</span>(<span class="ruby-identifier">bool</span>)
756
+ <span class="ruby-keyword kw">end</span>
757
+ </pre>
758
+ </div>
759
+ </div>
760
+ </div>
761
+
762
+ <div id="method-M000027" class="method-detail">
763
+ <a name="M000027"></a>
764
+
765
+ <div class="method-heading">
766
+ <a href="#M000027" class="method-signature">
767
+ <span class="method-name">jms_redelivered?</span><span class="method-args">()</span>
768
+ </a>
769
+ </div>
770
+
771
+ <div class="method-description">
772
+ <p>
773
+ Indicates whether the <a href="Message.html">Message</a> was redelivered?
774
+ </p>
775
+ <p><a class="source-toggle" href="#"
776
+ onclick="toggleCode('M000027-source');return false;">[Source]</a></p>
777
+ <div class="method-source-code" id="M000027-source">
778
+ <pre>
779
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 146</span>
780
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_redelivered?</span>
781
+ <span class="ruby-identifier">getJMSRedelivered</span>
782
+ <span class="ruby-keyword kw">end</span>
783
+ </pre>
784
+ </div>
785
+ </div>
786
+ </div>
787
+
788
+ <div id="method-M000029" class="method-detail">
789
+ <a name="M000029"></a>
790
+
791
+ <div class="method-heading">
792
+ <a href="#M000029" class="method-signature">
793
+ <span class="method-name">jms_reply_to</span><span class="method-args">()</span>
794
+ </a>
795
+ </div>
796
+
797
+ <div class="method-description">
798
+ <p>
799
+ Returns the <a href="Message.html">Message</a> reply to Destination
800
+ </p>
801
+ <pre>
802
+ Instance of JMS::Destination
803
+ </pre>
804
+ <p><a class="source-toggle" href="#"
805
+ onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
806
+ <div class="method-source-code" id="M000029-source">
807
+ <pre>
808
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 158</span>
809
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_reply_to</span>
810
+ <span class="ruby-identifier">getJMSReplyTo</span>
811
+ <span class="ruby-keyword kw">end</span>
812
+ </pre>
813
+ </div>
814
+ </div>
815
+ </div>
816
+
817
+ <div id="method-M000030" class="method-detail">
818
+ <a name="M000030"></a>
819
+
820
+ <div class="method-heading">
821
+ <a href="#M000030" class="method-signature">
822
+ <span class="method-name">jms_reply_to=</span><span class="method-args">(reply_to)</span>
823
+ </a>
824
+ </div>
825
+
826
+ <div class="method-description">
827
+ <p>
828
+ Set the <a href="Message.html">Message</a> reply to Destination
829
+ </p>
830
+ <pre>
831
+ reply_to: Must be an instance of JMS::Destination
832
+ </pre>
833
+ <p><a class="source-toggle" href="#"
834
+ onclick="toggleCode('M000030-source');return false;">[Source]</a></p>
835
+ <div class="method-source-code" id="M000030-source">
836
+ <pre>
837
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 164</span>
838
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_reply_to=</span>(<span class="ruby-identifier">reply_to</span>)
839
+ <span class="ruby-identifier">setJMSReplyTo</span>(<span class="ruby-identifier">reply_to</span>)
840
+ <span class="ruby-keyword kw">end</span>
841
+ </pre>
842
+ </div>
843
+ </div>
844
+ </div>
845
+
846
+ <div id="method-M000031" class="method-detail">
847
+ <a name="M000031"></a>
848
+
849
+ <div class="method-heading">
850
+ <a href="#M000031" class="method-signature">
851
+ <span class="method-name">jms_timestamp</span><span class="method-args">()</span>
852
+ </a>
853
+ </div>
854
+
855
+ <div class="method-description">
856
+ <pre>
857
+ Returns the Message timestamp as Java Timestamp Integer
858
+ </pre>
859
+ <p>
860
+ TODO Return Ruby Time object?
861
+ </p>
862
+ <p><a class="source-toggle" href="#"
863
+ onclick="toggleCode('M000031-source');return false;">[Source]</a></p>
864
+ <div class="method-source-code" id="M000031-source">
865
+ <pre>
866
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 170</span>
867
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_timestamp</span>
868
+ <span class="ruby-identifier">getJMSTimestamp</span>
869
+ <span class="ruby-keyword kw">end</span>
870
+ </pre>
871
+ </div>
872
+ </div>
873
+ </div>
874
+
875
+ <div id="method-M000032" class="method-detail">
876
+ <a name="M000032"></a>
877
+
878
+ <div class="method-heading">
879
+ <a href="#M000032" class="method-signature">
880
+ <span class="method-name">jms_timestamp=</span><span class="method-args">(timestamp)</span>
881
+ </a>
882
+ </div>
883
+
884
+ <div class="method-description">
885
+ <pre>
886
+ Set the Message timestamp as Java Timestamp Integer
887
+ timestamp: Must be an Java Timestamp Integer
888
+ </pre>
889
+ <p>
890
+ TODO Support Ruby Time
891
+ </p>
892
+ <p><a class="source-toggle" href="#"
893
+ onclick="toggleCode('M000032-source');return false;">[Source]</a></p>
894
+ <div class="method-source-code" id="M000032-source">
895
+ <pre>
896
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 177</span>
897
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_timestamp=</span>(<span class="ruby-identifier">timestamp</span>)
898
+ <span class="ruby-identifier">setJMSTimestamp</span>(<span class="ruby-identifier">timestamp</span>)
899
+ <span class="ruby-keyword kw">end</span>
900
+ </pre>
901
+ </div>
902
+ </div>
903
+ </div>
904
+
905
+ <div id="method-M000033" class="method-detail">
906
+ <a name="M000033"></a>
907
+
908
+ <div class="method-heading">
909
+ <a href="#M000033" class="method-signature">
910
+ <span class="method-name">jms_type</span><span class="method-args">()</span>
911
+ </a>
912
+ </div>
913
+
914
+ <div class="method-description">
915
+ <p>
916
+ Returns the <a href="Message.html">Message</a> type supplied by the client
917
+ when the message was sent
918
+ </p>
919
+ <p><a class="source-toggle" href="#"
920
+ onclick="toggleCode('M000033-source');return false;">[Source]</a></p>
921
+ <div class="method-source-code" id="M000033-source">
922
+ <pre>
923
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 182</span>
924
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_type</span>
925
+ <span class="ruby-identifier">getJMSType</span>
926
+ <span class="ruby-keyword kw">end</span>
927
+ </pre>
928
+ </div>
929
+ </div>
930
+ </div>
931
+
932
+ <div id="method-M000034" class="method-detail">
933
+ <a name="M000034"></a>
934
+
935
+ <div class="method-heading">
936
+ <a href="#M000034" class="method-signature">
937
+ <span class="method-name">jms_type=</span><span class="method-args">(type)</span>
938
+ </a>
939
+ </div>
940
+
941
+ <div class="method-description">
942
+ <p>
943
+ Sets the <a href="Message.html">Message</a> type
944
+ </p>
945
+ <pre>
946
+ type: String
947
+ </pre>
948
+ <p><a class="source-toggle" href="#"
949
+ onclick="toggleCode('M000034-source');return false;">[Source]</a></p>
950
+ <div class="method-source-code" id="M000034-source">
951
+ <pre>
952
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 188</span>
953
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">jms_type=</span>(<span class="ruby-identifier">type</span>)
954
+ <span class="ruby-identifier">setJMSType</span>(<span class="ruby-identifier">type</span>)
955
+ <span class="ruby-keyword kw">end</span>
956
+ </pre>
957
+ </div>
958
+ </div>
959
+ </div>
960
+
961
+ <div id="method-M000016" class="method-detail">
962
+ <a name="M000016"></a>
963
+
964
+ <div class="method-heading">
965
+ <a href="#M000016" class="method-signature">
966
+ <span class="method-name">persistent?</span><span class="method-args">()</span>
967
+ </a>
968
+ </div>
969
+
970
+ <div class="method-description">
971
+ <p>
972
+ Is the message <a href="Message.html#M000016">persistent?</a>
973
+ </p>
974
+ <p><a class="source-toggle" href="#"
975
+ onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
976
+ <div class="method-source-code" id="M000016-source">
977
+ <pre>
978
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 81</span>
979
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">persistent?</span>
980
+ <span class="ruby-identifier">getJMSDeliveryMode</span> <span class="ruby-operator">==</span> <span class="ruby-constant">JMS</span><span class="ruby-operator">::</span><span class="ruby-constant">DeliveryMode</span><span class="ruby-operator">::</span><span class="ruby-constant">PERSISTENT</span>
981
+ <span class="ruby-keyword kw">end</span>
982
+ </pre>
983
+ </div>
984
+ </div>
985
+ </div>
986
+
987
+ <div id="method-M000041" class="method-detail">
988
+ <a name="M000041"></a>
989
+
990
+ <div class="method-heading">
991
+ <a href="#M000041" class="method-signature">
992
+ <span class="method-name">properties</span><span class="method-args">()</span>
993
+ </a>
994
+ </div>
995
+
996
+ <div class="method-description">
997
+ <p>
998
+ Return Properties as a hash
999
+ </p>
1000
+ <p><a class="source-toggle" href="#"
1001
+ onclick="toggleCode('M000041-source');return false;">[Source]</a></p>
1002
+ <div class="method-source-code" id="M000041-source">
1003
+ <pre>
1004
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 259</span>
1005
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">properties</span>
1006
+ <span class="ruby-identifier">h</span> = {}
1007
+ <span class="ruby-identifier">properties_each_pair</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">k</span>]=<span class="ruby-identifier">v</span>}
1008
+ <span class="ruby-identifier">h</span>
1009
+ <span class="ruby-keyword kw">end</span>
1010
+ </pre>
1011
+ </div>
1012
+ </div>
1013
+ </div>
1014
+
1015
+ <div id="method-M000042" class="method-detail">
1016
+ <a name="M000042"></a>
1017
+
1018
+ <div class="method-heading">
1019
+ <a href="#M000042" class="method-signature">
1020
+ <span class="method-name">properties=</span><span class="method-args">(h)</span>
1021
+ </a>
1022
+ </div>
1023
+
1024
+ <div class="method-description">
1025
+ <p>
1026
+ Set Properties from an existing hash
1027
+ </p>
1028
+ <p><a class="source-toggle" href="#"
1029
+ onclick="toggleCode('M000042-source');return false;">[Source]</a></p>
1030
+ <div class="method-source-code" id="M000042-source">
1031
+ <pre>
1032
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 266</span>
1033
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">properties=</span>(<span class="ruby-identifier">h</span>)
1034
+ <span class="ruby-identifier">clear_properties</span>
1035
+ <span class="ruby-identifier">h</span>.<span class="ruby-identifier">each_pair</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">setObjectProperty</span>(<span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">v</span>)}
1036
+ <span class="ruby-identifier">h</span>
1037
+ <span class="ruby-keyword kw">end</span>
1038
+ </pre>
1039
+ </div>
1040
+ </div>
1041
+ </div>
1042
+
1043
+ <div id="method-M000043" class="method-detail">
1044
+ <a name="M000043"></a>
1045
+
1046
+ <div class="method-heading">
1047
+ <a href="#M000043" class="method-signature">
1048
+ <span class="method-name">properties_each_pair</span><span class="method-args">(&amp;proc)</span>
1049
+ </a>
1050
+ </div>
1051
+
1052
+ <div class="method-description">
1053
+ <p>
1054
+ Return each name value pair
1055
+ </p>
1056
+ <p><a class="source-toggle" href="#"
1057
+ onclick="toggleCode('M000043-source');return false;">[Source]</a></p>
1058
+ <div class="method-source-code" id="M000043-source">
1059
+ <pre>
1060
+ <span class="ruby-comment cmt"># File lib/jms/message.rb, line 273</span>
1061
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">properties_each_pair</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">proc</span>)
1062
+ <span class="ruby-identifier">enum</span> = <span class="ruby-identifier">getPropertyNames</span>
1063
+ <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">enum</span>.<span class="ruby-identifier">has_more_elements</span>
1064
+ <span class="ruby-identifier">key</span> = <span class="ruby-identifier">enum</span>.<span class="ruby-identifier">next_element</span>
1065
+ <span class="ruby-identifier">proc</span>.<span class="ruby-identifier">call</span> <span class="ruby-identifier">key</span>, <span class="ruby-identifier">getObjectProperty</span>(<span class="ruby-identifier">key</span>)
1066
+ <span class="ruby-keyword kw">end</span>
1067
+ <span class="ruby-keyword kw">end</span>
1068
+ </pre>
1069
+ </div>
1070
+ </div>
1071
+ </div>
1072
+
1073
+
1074
+ </div>
1075
+
1076
+
1077
+ </div>
1078
+
1079
+
1080
+ <div id="validator-badges">
1081
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
1082
+ </div>
1083
+
1084
+ </body>
1085
+ </html>