1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class MCollective::Connector::Activemq - mcollective version 2.12.5</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Base
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-connect">#connect</a>
<li ><a href="#method-i-connection_headers">#connection_headers</a>
<li ><a href="#method-i-disconnect">#disconnect</a>
<li ><a href="#method-i-exponential_back_off">#exponential_back_off</a>
<li ><a href="#method-i-get_bool_option">#get_bool_option</a>
<li ><a href="#method-i-get_cert_file">#get_cert_file</a>
<li ><a href="#method-i-get_env_or_option">#get_env_or_option</a>
<li ><a href="#method-i-get_key_file">#get_key_file</a>
<li ><a href="#method-i-get_option">#get_option</a>
<li ><a href="#method-i-headers_for">#headers_for</a>
<li ><a href="#method-i-make_target">#make_target</a>
<li ><a href="#method-i-publish">#publish</a>
<li ><a href="#method-i-receive">#receive</a>
<li ><a href="#method-i-ssl_parameters">#ssl_parameters</a>
<li ><a href="#method-i-stomp_version">#stomp_version</a>
<li ><a href="#method-i-stomp_version_supports_heartbeat-3F">#stomp_version_supports_heartbeat?</a>
<li ><a href="#method-i-subscribe">#subscribe</a>
<li ><a href="#method-i-target_for">#target_for</a>
<li ><a href="#method-i-unsubscribe">#unsubscribe</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-MCollective::Connector::Activemq">
<h1 id="class-MCollective::Connector::Activemq" class="class">
class MCollective::Connector::Activemq
</h1>
<section class="description">
<p>Handles sending and receiving messages over the <a href="Activemq/Stomp.html"><code>Stomp</code></a> protocol for ActiveMQ servers specifically, we take advantages of ActiveMQ specific features and enhancements to the <a href="Activemq/Stomp.html"><code>Stomp</code></a> protocol. For best results in a clustered environment use ActiveMQ 5.5.0 at least.</p>
<p>This plugin takes an entirely different approach to dealing with ActiveMQ from the more generic stomp connector.</p>
<pre>- Agents use /topic/<collective>.<agent>.agent
- Replies use temp-topics so they are private and transient.
- Point to Point messages using topics are supported by subscribing to
/queue/<collective>.nodes with a selector "mc_identity = 'identity'</pre>
<p>The use of temp-topics for the replies is a huge improvement over the old style. In the old way all clients got replies for all clients that were active at that time, this would mean that they would need to decrypt, validate etc in order to determine if they need to ignore the message, this was computationally expensive and on large busy networks the messages were being sent all over the show cross broker boundaries.</p>
<p>The new way means the messages go point2point back to only whoever requested the message, they only get their own replies and this is ap private channel that casual observers cannot just snoop into.</p>
<p>This plugin supports 1.1.6 and newer of the <a href="Activemq/Stomp.html"><code>Stomp</code></a> rubygem.</p>
<pre>connector = activemq
plugin.activemq.pool.size = 2
plugin.activemq.pool.1.host = stomp1.your.net
plugin.activemq.pool.1.port = 61613
plugin.activemq.pool.1.user = you
plugin.activemq.pool.1.password = secret
plugin.activemq.pool.1.ssl = true
plugin.activemq.pool.1.ssl.cert = /path/to/your.cert
plugin.activemq.pool.1.ssl.key = /path/to/your.key
plugin.activemq.pool.1.ssl.ca = /path/to/your.ca
plugin.activemq.pool.1.ssl.fallback = true
plugin.activemq.pool.1.ssl.ciphers = TLSv1:!MD5:!LOW:!EXPORT
plugin.activemq.pool.2.host = stomp2.your.net
plugin.activemq.pool.2.port = 61613
plugin.activemq.pool.2.user = you
plugin.activemq.pool.2.password = secret
plugin.activemq.pool.2.ssl = false</pre>
<p>Using this method you can supply just STOMP_USER and STOMP_PASSWORD. The port will default to 61613 if not specified.</p>
<p>The ssl options are only usable in version of the <a href="Activemq/Stomp.html"><code>Stomp</code></a> gem newer than 1.2.2 where these will imply full <a href="../SSL.html"><code>SSL</code></a> validation will be done and you'll only be able to connect to a ActiveMQ server that has a cert signed by the same CA. If you only set ssl = true and do not supply the cert, key and ca properties or if you have an older gem it will fall back to unverified mode only if ssl.fallback is true</p>
<p>In addition you can set the following options for the rubygem:</p>
<pre class="ruby"><span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">activemq</span>.<span class="ruby-identifier">initial_reconnect_delay</span> = <span class="ruby-value">0.01</span>
<span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">activemq</span>.<span class="ruby-identifier">max_reconnect_delay</span> = <span class="ruby-value">30.0</span>
<span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">activemq</span>.<span class="ruby-identifier">use_exponential_back_off</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">activemq</span>.<span class="ruby-identifier">back_off_multiplier</span> = <span class="ruby-value">2</span>
<span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">activemq</span>.<span class="ruby-identifier">max_reconnect_attempts</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">activemq</span>.<span class="ruby-identifier">randomize</span> = <span class="ruby-keyword">false</span>
<span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">activemq</span>.<span class="ruby-identifier">timeout</span> = <span class="ruby-value">-1</span>
</pre>
<p>You can set the initial connetion timeout - this is when your stomp server is simply unreachable - after which it would failover to the next in the pool:</p>
<pre class="ruby"><span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">activemq</span>.<span class="ruby-identifier">connect_timeout</span> = <span class="ruby-value">30</span>
</pre>
<p>ActiveMQ JMS message priorities can be set:</p>
<pre class="ruby"><span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">activemq</span>.<span class="ruby-identifier">priority</span> = <span class="ruby-value">4</span>
</pre>
<p>This plugin supports <a href="Activemq/Stomp.html"><code>Stomp</code></a> protocol 1.1 when combined with the stomp gem version 1.2.10 or newer. To enable network heartbeats which will help keep the connection alive over NAT connections and aggresive session tracking firewalls you can set:</p>
<pre class="ruby"><span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">activemq</span>.<span class="ruby-identifier">heartbeat_interval</span> = <span class="ruby-value">30</span>
</pre>
<p>which will cause a heartbeat to be sent on 30 second intervals and one to be expected from the broker every 30 seconds. The shortest supported period is 30 seconds, if you set it lower it will get forced to 30 seconds.</p>
<p>After 2 failures to receive a heartbeat the connection will be reset via the normal failover mechanism.</p>
<p>By default if heartbeat_interval is set it will request <a href="Activemq/Stomp.html"><code>Stomp</code></a> 1.1 but support fallback to 1.0, but you can enable strict <a href="Activemq/Stomp.html"><code>Stomp</code></a> 1.1 only operation</p>
<pre class="ruby"><span class="ruby-identifier">plugin</span>.<span class="ruby-identifier">activemq</span>.<span class="ruby-identifier">stomp_1_0_fallback</span> = <span class="ruby-value">0</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-connection" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">connection</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">200</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="line-num">201</span> <span class="ruby-ivar">@config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
<span class="line-num">202</span> <span class="ruby-ivar">@subscriptions</span> = []
<span class="line-num">203</span> <span class="ruby-ivar">@msgpriority</span> = <span class="ruby-value">0</span>
<span class="line-num">204</span> <span class="ruby-ivar">@base64</span> = <span class="ruby-keyword">false</span>
<span class="line-num">205</span> <span class="ruby-ivar">@use_exponential_back_off</span> = <span class="ruby-identifier">get_bool_option</span>(<span class="ruby-string">"activemq.use_exponential_back_off"</span>, <span class="ruby-string">"true"</span>)
<span class="line-num">206</span> <span class="ruby-ivar">@initial_reconnect_delay</span> = <span class="ruby-constant">Float</span>(<span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.initial_reconnect_delay"</span>, <span class="ruby-value">0.01</span>))
<span class="line-num">207</span> <span class="ruby-ivar">@back_off_multiplier</span> = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.back_off_multiplier"</span>, <span class="ruby-value">2</span>))
<span class="line-num">208</span> <span class="ruby-ivar">@max_reconnect_delay</span> = <span class="ruby-constant">Float</span>(<span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.max_reconnect_delay"</span>, <span class="ruby-value">30.0</span>))
<span class="line-num">209</span> <span class="ruby-ivar">@reconnect_delay</span> = <span class="ruby-ivar">@initial_reconnect_delay</span>
<span class="line-num">210</span>
<span class="line-num">211</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"ActiveMQ connector initialized. Using stomp-gem #{stomp_version}"</span>)
<span class="line-num">212</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-connect" class="method-detail ">
<div class="method-heading">
<span class="method-name">connect</span><span
class="method-args">(connector = ::Stomp::Connection)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Connects to the ActiveMQ middleware</p>
<div class="method-source-code" id="connect-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">215</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">connect</span>(<span class="ruby-identifier">connector</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Stomp</span><span class="ruby-operator">::</span><span class="ruby-constant">Connection</span>)
<span class="line-num">216</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@connection</span>
<span class="line-num">217</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-string">"Already connection, not re-initializing connection"</span>)
<span class="line-num">218</span> <span class="ruby-keyword">return</span>
<span class="line-num">219</span> <span class="ruby-keyword">end</span>
<span class="line-num">220</span>
<span class="line-num">221</span> <span class="ruby-keyword">begin</span>
<span class="line-num">222</span> <span class="ruby-ivar">@base64</span> = <span class="ruby-identifier">get_bool_option</span>(<span class="ruby-string">"activemq.base64"</span>, <span class="ruby-string">"false"</span>)
<span class="line-num">223</span> <span class="ruby-ivar">@msgpriority</span> = <span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.priority"</span>, <span class="ruby-value">0</span>).<span class="ruby-identifier">to_i</span>
<span class="line-num">224</span>
<span class="line-num">225</span> <span class="ruby-identifier">pools</span> = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.pool.size"</span>))
<span class="line-num">226</span> <span class="ruby-identifier">hosts</span> = []
<span class="line-num">227</span> <span class="ruby-identifier">middleware_user</span> = <span class="ruby-string">''</span>
<span class="line-num">228</span> <span class="ruby-identifier">middleware_password</span> = <span class="ruby-string">''</span>
<span class="line-num">229</span> <span class="ruby-identifier">prompt_for_username</span> = <span class="ruby-identifier">get_bool_option</span>(<span class="ruby-string">"activemq.prompt_user"</span>, <span class="ruby-string">"false"</span>)
<span class="line-num">230</span> <span class="ruby-identifier">prompt_for_password</span> = <span class="ruby-identifier">get_bool_option</span>(<span class="ruby-string">"activemq.prompt_password"</span>, <span class="ruby-string">"false"</span>)
<span class="line-num">231</span>
<span class="line-num">232</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">prompt_for_username</span>
<span class="line-num">233</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-string">"No previous user exists and activemq.prompt-user is set to true"</span>)
<span class="line-num">234</span> <span class="ruby-identifier">print</span> <span class="ruby-string">"Please enter user to connect to middleware: "</span>
<span class="line-num">235</span> <span class="ruby-identifier">middleware_user</span> = <span class="ruby-constant">STDIN</span>.<span class="ruby-identifier">gets</span>.<span class="ruby-identifier">chomp</span>
<span class="line-num">236</span> <span class="ruby-keyword">end</span>
<span class="line-num">237</span>
<span class="line-num">238</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">prompt_for_password</span>
<span class="line-num">239</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-string">"No previous password exists and activemq.prompt-password is set to true"</span>)
<span class="line-num">240</span> <span class="ruby-identifier">middleware_password</span> = <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">get_hidden_input</span>(<span class="ruby-string">"Please enter password: "</span>)
<span class="line-num">241</span> <span class="ruby-identifier">print</span> <span class="ruby-string">"\n"</span>
<span class="line-num">242</span> <span class="ruby-keyword">end</span>
<span class="line-num">243</span>
<span class="line-num">244</span> <span class="ruby-value">1</span>.<span class="ruby-identifier">upto</span>(<span class="ruby-identifier">pools</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">poolnum</span><span class="ruby-operator">|</span>
<span class="line-num">245</span> <span class="ruby-identifier">host</span> = {}
<span class="line-num">246</span>
<span class="line-num">247</span> <span class="ruby-identifier">host</span>[<span class="ruby-value">:host</span>] = <span class="ruby-identifier">get_option</span>(<span class="ruby-node">"activemq.pool.#{poolnum}.host"</span>)
<span class="line-num">248</span> <span class="ruby-identifier">host</span>[<span class="ruby-value">:port</span>] = <span class="ruby-identifier">get_option</span>(<span class="ruby-node">"activemq.pool.#{poolnum}.port"</span>, <span class="ruby-value">61613</span>).<span class="ruby-identifier">to_i</span>
<span class="line-num">249</span> <span class="ruby-identifier">host</span>[<span class="ruby-value">:ssl</span>] = <span class="ruby-identifier">get_bool_option</span>(<span class="ruby-node">"activemq.pool.#{poolnum}.ssl"</span>, <span class="ruby-string">"false"</span>)
<span class="line-num">250</span>
<span class="line-num">251</span> <span class="ruby-comment"># read user from config file</span>
<span class="line-num">252</span> <span class="ruby-identifier">host</span>[<span class="ruby-value">:login</span>] = <span class="ruby-identifier">get_env_or_option</span>(<span class="ruby-string">"STOMP_USER"</span>, <span class="ruby-node">"activemq.pool.#{poolnum}.user"</span>, <span class="ruby-identifier">middleware_user</span>)
<span class="line-num">253</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">prompt_for_username</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">host</span>[<span class="ruby-value">:login</span>] <span class="ruby-operator">!=</span> <span class="ruby-identifier">middleware_user</span>
<span class="line-num">254</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"Using #{host[:login]} from config file to connect to #{host[:host]}. "</span><span class="ruby-operator">+</span>
<span class="line-num">255</span> <span class="ruby-string">"plugin.activemq.prompt_user should be set to false to remove the prompt."</span>)
<span class="line-num">256</span> <span class="ruby-keyword">end</span>
<span class="line-num">257</span>
<span class="line-num">258</span> <span class="ruby-comment"># read user from config file</span>
<span class="line-num">259</span> <span class="ruby-identifier">host</span>[<span class="ruby-value">:passcode</span>] = <span class="ruby-identifier">get_env_or_option</span>(<span class="ruby-string">"STOMP_PASSWORD"</span>, <span class="ruby-node">"activemq.pool.#{poolnum}.password"</span>, <span class="ruby-identifier">middleware_password</span>)
<span class="line-num">260</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">prompt_for_password</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">host</span>[<span class="ruby-value">:passcode</span>] <span class="ruby-operator">!=</span> <span class="ruby-identifier">middleware_password</span>
<span class="line-num">261</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"Using password from config file to connect to #{host[:host]}. "</span><span class="ruby-operator">+</span>
<span class="line-num">262</span> <span class="ruby-string">"plugin.activemq.prompt_password should be set to false to remove the prompt."</span>)
<span class="line-num">263</span> <span class="ruby-keyword">end</span>
<span class="line-num">264</span>
<span class="line-num">265</span> <span class="ruby-comment"># if ssl is enabled set :ssl to the hash of parameters</span>
<span class="line-num">266</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">host</span>[<span class="ruby-value">:ssl</span>]
<span class="line-num">267</span> <span class="ruby-identifier">host</span>[<span class="ruby-value">:ssl</span>] = <span class="ruby-identifier">ssl_parameters</span>(<span class="ruby-identifier">poolnum</span>, <span class="ruby-identifier">get_bool_option</span>(<span class="ruby-node">"activemq.pool.#{poolnum}.ssl.fallback"</span>, <span class="ruby-string">"false"</span>))
<span class="line-num">268</span> <span class="ruby-keyword">end</span>
<span class="line-num">269</span>
<span class="line-num">270</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Adding #{host[:host]}:#{host[:port]} to the connection pool"</span>)
<span class="line-num">271</span> <span class="ruby-identifier">hosts</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">host</span>
<span class="line-num">272</span> <span class="ruby-keyword">end</span>
<span class="line-num">273</span>
<span class="line-num">274</span> <span class="ruby-identifier">raise</span> <span class="ruby-string">"No hosts found for the ActiveMQ connection pool"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">hosts</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="line-num">275</span>
<span class="line-num">276</span> <span class="ruby-identifier">connection</span> = {<span class="ruby-value">:hosts</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">hosts</span>}
<span class="line-num">277</span>
<span class="line-num">278</span> <span class="ruby-comment"># Various STOMP gem options, defaults here matches defaults for 1.1.6 the meaning of</span>
<span class="line-num">279</span> <span class="ruby-comment"># these can be guessed, the documentation isn't clear</span>
<span class="line-num">280</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:use_exponential_back_off</span>] = <span class="ruby-ivar">@use_exponential_back_off</span>
<span class="line-num">281</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:initial_reconnect_delay</span>] = <span class="ruby-ivar">@initial_reconnect_delay</span>
<span class="line-num">282</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:back_off_multiplier</span>] = <span class="ruby-ivar">@back_off_multiplier</span>
<span class="line-num">283</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:max_reconnect_delay</span>] = <span class="ruby-ivar">@max_reconnect_delay</span>
<span class="line-num">284</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:max_reconnect_attempts</span>] = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.max_reconnect_attempts"</span>, <span class="ruby-value">0</span>))
<span class="line-num">285</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:randomize</span>] = <span class="ruby-identifier">get_bool_option</span>(<span class="ruby-string">"activemq.randomize"</span>, <span class="ruby-string">"false"</span>)
<span class="line-num">286</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:backup</span>] = <span class="ruby-identifier">get_bool_option</span>(<span class="ruby-string">"activemq.backup"</span>, <span class="ruby-string">"false"</span>)
<span class="line-num">287</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:timeout</span>] = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.timeout"</span>, <span class="ruby-value">-1</span>))
<span class="line-num">288</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:connect_timeout</span>] = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.connect_timeout"</span>, <span class="ruby-value">30</span>))
<span class="line-num">289</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:reliable</span>] = <span class="ruby-keyword">true</span>
<span class="line-num">290</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:connect_headers</span>] = <span class="ruby-identifier">connection_headers</span>
<span class="line-num">291</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:max_hbrlck_fails</span>] = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.max_hbrlck_fails"</span>, <span class="ruby-value">0</span>))
<span class="line-num">292</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:max_hbread_fails</span>] = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.max_hbread_fails"</span>, <span class="ruby-value">2</span>))
<span class="line-num">293</span>
<span class="line-num">294</span> <span class="ruby-identifier">connection</span>[<span class="ruby-value">:logger</span>] = <span class="ruby-constant">EventLogger</span>.<span class="ruby-identifier">new</span>
<span class="line-num">295</span>
<span class="line-num">296</span> <span class="ruby-ivar">@connection</span> = <span class="ruby-identifier">connector</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">connection</span>)
<span class="line-num">297</span>
<span class="line-num">298</span> <span class="ruby-keyword">rescue</span> <span class="ruby-constant">ClientTimeoutError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="line-num">299</span> <span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
<span class="line-num">300</span> <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="line-num">301</span> <span class="ruby-identifier">raise</span>(<span class="ruby-node">"Could not connect to ActiveMQ Server: #{e}"</span>)
<span class="line-num">302</span> <span class="ruby-keyword">end</span>
<span class="line-num">303</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-connection_headers" class="method-detail ">
<div class="method-heading">
<span class="method-name">connection_headers</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="connection_headers-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">313</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">connection_headers</span>
<span class="line-num">314</span> <span class="ruby-identifier">headers</span> = {<span class="ruby-value">:"accept-version"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"1.0"</span>}
<span class="line-num">315</span>
<span class="line-num">316</span> <span class="ruby-identifier">heartbeat_interval</span> = <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.heartbeat_interval"</span>, <span class="ruby-value">0</span>))
<span class="line-num">317</span> <span class="ruby-identifier">stomp_1_0_fallback</span> = <span class="ruby-identifier">get_bool_option</span>(<span class="ruby-string">"activemq.stomp_1_0_fallback"</span>, <span class="ruby-keyword">true</span>)
<span class="line-num">318</span>
<span class="line-num">319</span> <span class="ruby-identifier">headers</span>[<span class="ruby-value">:host</span>] = <span class="ruby-identifier">get_option</span>(<span class="ruby-string">"activemq.vhost"</span>, <span class="ruby-string">"mcollective"</span>)
<span class="line-num">320</span>
<span class="line-num">321</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">heartbeat_interval</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="line-num">322</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">stomp_version_supports_heartbeat?</span>
<span class="line-num">323</span> <span class="ruby-identifier">raise</span>(<span class="ruby-string">"Setting STOMP 1.1 properties like heartbeat intervals require at least version 1.2.10 of the STOMP gem"</span>)
<span class="line-num">324</span> <span class="ruby-keyword">end</span>
<span class="line-num">325</span>
<span class="line-num">326</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">heartbeat_interval</span> <span class="ruby-operator"><</span> <span class="ruby-value">30</span>
<span class="line-num">327</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-string">"Connection heartbeat is set to %d, forcing to minimum value of 30s"</span>)
<span class="line-num">328</span> <span class="ruby-identifier">heartbeat_interval</span> = <span class="ruby-value">30</span>
<span class="line-num">329</span> <span class="ruby-keyword">end</span>
<span class="line-num">330</span>
<span class="line-num">331</span> <span class="ruby-identifier">heartbeat_interval</span> = <span class="ruby-identifier">heartbeat_interval</span> <span class="ruby-operator">*</span> <span class="ruby-value">1000</span>
<span class="line-num">332</span> <span class="ruby-identifier">headers</span>[<span class="ruby-value">:"heart-beat"</span>] = <span class="ruby-string">"%d,%d"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">heartbeat_interval</span> <span class="ruby-operator">+</span> <span class="ruby-value">500</span>, <span class="ruby-identifier">heartbeat_interval</span> <span class="ruby-operator">-</span> <span class="ruby-value">500</span>]
<span class="line-num">333</span>
<span class="line-num">334</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">stomp_1_0_fallback</span>
<span class="line-num">335</span> <span class="ruby-identifier">headers</span>[<span class="ruby-value">:"accept-version"</span>] = <span class="ruby-string">"1.1,1.0"</span>
<span class="line-num">336</span> <span class="ruby-keyword">else</span>
<span class="line-num">337</span> <span class="ruby-identifier">headers</span>[<span class="ruby-value">:"accept-version"</span>] = <span class="ruby-string">"1.1"</span>
<span class="line-num">338</span> <span class="ruby-keyword">end</span>
<span class="line-num">339</span> <span class="ruby-keyword">else</span>
<span class="line-num">340</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">stomp_version_supports_heartbeat?</span>
<span class="line-num">341</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-string">"Connecting without STOMP 1.1 heartbeats, if you are using ActiveMQ 5.8 or newer consider setting plugin.activemq.heartbeat_interval"</span>)
<span class="line-num">342</span> <span class="ruby-keyword">end</span>
<span class="line-num">343</span> <span class="ruby-keyword">end</span>
<span class="line-num">344</span>
<span class="line-num">345</span> <span class="ruby-identifier">headers</span>
<span class="line-num">346</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-disconnect" class="method-detail ">
<div class="method-heading">
<span class="method-name">disconnect</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Disconnects from the ActiveMQ connection</p>
<div class="method-source-code" id="disconnect-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">506</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">disconnect</span>
<span class="line-num">507</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-string">"Disconnecting from ActiveMQ"</span>)
<span class="line-num">508</span> <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">disconnect</span>
<span class="line-num">509</span> <span class="ruby-ivar">@connection</span> = <span class="ruby-keyword">nil</span>
<span class="line-num">510</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-exponential_back_off" class="method-detail ">
<div class="method-heading">
<span class="method-name">exponential_back_off</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Calculate the exponential backoff needed</p>
<div class="method-source-code" id="exponential_back_off-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">399</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">exponential_back_off</span>
<span class="line-num">400</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@use_exponential_back_off</span>
<span class="line-num">401</span> <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="line-num">402</span> <span class="ruby-keyword">end</span>
<span class="line-num">403</span>
<span class="line-num">404</span> <span class="ruby-identifier">backoff</span> = <span class="ruby-ivar">@reconnect_delay</span>
<span class="line-num">405</span>
<span class="line-num">406</span> <span class="ruby-comment"># calculate next delay</span>
<span class="line-num">407</span> <span class="ruby-ivar">@reconnect_delay</span> = <span class="ruby-ivar">@reconnect_delay</span> <span class="ruby-operator">*</span> <span class="ruby-ivar">@back_off_multiplier</span>
<span class="line-num">408</span>
<span class="line-num">409</span> <span class="ruby-comment"># cap at max reconnect delay</span>
<span class="line-num">410</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@reconnect_delay</span> <span class="ruby-operator">></span> <span class="ruby-ivar">@max_reconnect_delay</span>
<span class="line-num">411</span> <span class="ruby-ivar">@reconnect_delay</span> = <span class="ruby-ivar">@max_reconnect_delay</span>
<span class="line-num">412</span> <span class="ruby-keyword">end</span>
<span class="line-num">413</span>
<span class="line-num">414</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">backoff</span>
<span class="line-num">415</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_bool_option" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_bool_option</span><span
class="method-args">(val, default)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>looks up a boolean value in the config</p>
<div class="method-source-code" id="get_bool_option-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">602</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_bool_option</span>(<span class="ruby-identifier">val</span>, <span class="ruby-identifier">default</span>)
<span class="line-num">603</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">pluginconf</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">val</span>, <span class="ruby-identifier">default</span>))
<span class="line-num">604</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_cert_file" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_cert_file</span><span
class="method-args">(poolnum)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the name of the certficate file used by ActiveMQ Will first check if an environment variable MCOLLECTIVE_ACTIVEMQ_POOLX_SSL_CERT exists, where X is the ActiveMQ pool number. If the environment variable doesn't exist, it will try and load the value from the config.</p>
<div class="method-source-code" id="get_cert_file-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">394</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_cert_file</span>(<span class="ruby-identifier">poolnum</span>)
<span class="line-num">395</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">"MCOLLECTIVE_ACTIVEMQ_POOL%s_SSL_CERT"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">poolnum</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">get_option</span>(<span class="ruby-node">"activemq.pool.#{poolnum}.ssl.cert"</span>, <span class="ruby-keyword">false</span>)
<span class="line-num">396</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_env_or_option" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_env_or_option</span><span
class="method-args">(env, opt, default=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>looks in the environment first then in the config file for a specific option, accepts an optional default.</p>
<p>raises an exception when it cant find a value anywhere</p>
<div class="method-source-code" id="get_env_or_option-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">583</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_env_or_option</span>(<span class="ruby-identifier">env</span>, <span class="ruby-identifier">opt</span>, <span class="ruby-identifier">default</span>=<span class="ruby-keyword">nil</span>)
<span class="line-num">584</span> <span class="ruby-keyword">return</span> <span class="ruby-constant">ENV</span>[<span class="ruby-identifier">env</span>] <span class="ruby-keyword">if</span> <span class="ruby-constant">ENV</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">env</span>)
<span class="line-num">585</span> <span class="ruby-keyword">return</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">pluginconf</span>[<span class="ruby-identifier">opt</span>] <span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">pluginconf</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">opt</span>)
<span class="line-num">586</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">default</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">default</span>
<span class="line-num">587</span>
<span class="line-num">588</span> <span class="ruby-identifier">raise</span>(<span class="ruby-node">"No #{env} environment or plugin.#{opt} configuration option given"</span>)
<span class="line-num">589</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_key_file" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_key_file</span><span
class="method-args">(poolnum)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the name of the private key file used by ActiveMQ Will first check if an environment variable MCOLLECTIVE_ACTIVEMQ_POOLX_SSL_KEY exists, where X is the ActiveMQ pool number. If the environment variable doesn't exist, it will try and load the value from the config.</p>
<div class="method-source-code" id="get_key_file-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">386</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_key_file</span>(<span class="ruby-identifier">poolnum</span>)
<span class="line-num">387</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">"MCOLLECTIVE_ACTIVEMQ_POOL%s_SSL_KEY"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">poolnum</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">get_option</span>(<span class="ruby-node">"activemq.pool.#{poolnum}.ssl.key"</span>, <span class="ruby-keyword">false</span>)
<span class="line-num">388</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_option" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_option</span><span
class="method-args">(opt, default=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>looks for a config option, accepts an optional default</p>
<p>raises an exception when it cant find a value anywhere</p>
<div class="method-source-code" id="get_option-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">594</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_option</span>(<span class="ruby-identifier">opt</span>, <span class="ruby-identifier">default</span>=<span class="ruby-keyword">nil</span>)
<span class="line-num">595</span> <span class="ruby-keyword">return</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">pluginconf</span>[<span class="ruby-identifier">opt</span>] <span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">pluginconf</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">opt</span>)
<span class="line-num">596</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">default</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">default</span>.<span class="ruby-identifier">nil?</span>
<span class="line-num">597</span>
<span class="line-num">598</span> <span class="ruby-identifier">raise</span>(<span class="ruby-node">"No plugin.#{opt} configuration option given"</span>)
<span class="line-num">599</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-headers_for" class="method-detail ">
<div class="method-heading">
<span class="method-name">headers_for</span><span
class="method-args">(msg, identity=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="headers_for-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">512</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">headers_for</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">identity</span>=<span class="ruby-keyword">nil</span>)
<span class="line-num">513</span> <span class="ruby-identifier">headers</span> = {}
<span class="line-num">514</span>
<span class="line-num">515</span> <span class="ruby-identifier">headers</span> = {<span class="ruby-string">"priority"</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@msgpriority</span>} <span class="ruby-keyword">if</span> <span class="ruby-ivar">@msgpriority</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="line-num">516</span>
<span class="line-num">517</span> <span class="ruby-identifier">headers</span>[<span class="ruby-string">"timestamp"</span>] = (<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">utc</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">*</span> <span class="ruby-value">1000</span>).<span class="ruby-identifier">to_s</span>
<span class="line-num">518</span>
<span class="line-num">519</span> <span class="ruby-comment"># set the expires header based on the TTL, we build a small additional</span>
<span class="line-num">520</span> <span class="ruby-comment"># timeout of 10 seconds in here to allow for network latency etc</span>
<span class="line-num">521</span> <span class="ruby-identifier">headers</span>[<span class="ruby-string">"expires"</span>] = ((<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">utc</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">ttl</span> <span class="ruby-operator">+</span> <span class="ruby-value">10</span>) <span class="ruby-operator">*</span> <span class="ruby-value">1000</span>).<span class="ruby-identifier">to_s</span>
<span class="line-num">522</span>
<span class="line-num">523</span> <span class="ruby-keyword">if</span> [<span class="ruby-value">:request</span>, <span class="ruby-value">:direct_request</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">msg</span>.<span class="ruby-identifier">type</span>)
<span class="line-num">524</span> <span class="ruby-identifier">target</span> = <span class="ruby-identifier">make_target</span>(<span class="ruby-identifier">msg</span>.<span class="ruby-identifier">agent</span>, <span class="ruby-value">:reply</span>, <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">collective</span>)
<span class="line-num">525</span>
<span class="line-num">526</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">reply_to</span>
<span class="line-num">527</span> <span class="ruby-identifier">headers</span>[<span class="ruby-string">"reply-to"</span>] = <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">reply_to</span>
<span class="line-num">528</span> <span class="ruby-keyword">else</span>
<span class="line-num">529</span> <span class="ruby-identifier">headers</span>[<span class="ruby-string">"reply-to"</span>] = <span class="ruby-identifier">target</span>[<span class="ruby-value">:name</span>]
<span class="line-num">530</span> <span class="ruby-keyword">end</span>
<span class="line-num">531</span>
<span class="line-num">532</span> <span class="ruby-identifier">headers</span>[<span class="ruby-string">"mc_identity"</span>] = <span class="ruby-identifier">identity</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value">:direct_request</span>
<span class="line-num">533</span> <span class="ruby-keyword">end</span>
<span class="line-num">534</span>
<span class="line-num">535</span> <span class="ruby-identifier">headers</span>[<span class="ruby-string">"mc_sender"</span>] = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">identity</span>
<span class="line-num">536</span>
<span class="line-num">537</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">headers</span>
<span class="line-num">538</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-make_target" class="method-detail ">
<div class="method-heading">
<span class="method-name">make_target</span><span
class="method-args">(agent, type, collective)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="make_target-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">540</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">make_target</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">collective</span>)
<span class="line-num">541</span> <span class="ruby-identifier">raise</span>(<span class="ruby-node">"Unknown target type #{type}"</span>) <span class="ruby-keyword">unless</span> [<span class="ruby-value">:directed</span>, <span class="ruby-value">:broadcast</span>, <span class="ruby-value">:reply</span>, <span class="ruby-value">:request</span>, <span class="ruby-value">:direct_request</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">type</span>)
<span class="line-num">542</span> <span class="ruby-identifier">raise</span>(<span class="ruby-node">"Unknown collective '#{collective}' known collectives are '#{@config.collectives.join ', '}'"</span>) <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">collectives</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">collective</span>)
<span class="line-num">543</span>
<span class="line-num">544</span> <span class="ruby-identifier">agents_multiplex</span> = <span class="ruby-identifier">get_bool_option</span>(<span class="ruby-string">"activemq.agents_multiplex"</span>, <span class="ruby-string">"false"</span>)
<span class="line-num">545</span> <span class="ruby-identifier">target</span> = {<span class="ruby-value">:name</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:headers</span> <span class="ruby-operator">=></span> {}}
<span class="line-num">546</span>
<span class="line-num">547</span> <span class="ruby-keyword">case</span> <span class="ruby-identifier">type</span>
<span class="line-num">548</span> <span class="ruby-keyword">when</span> <span class="ruby-value">:reply</span>
<span class="line-num">549</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:name</span>] = [<span class="ruby-string">"/queue/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">collective</span>, <span class="ruby-value">:reply</span>, <span class="ruby-node">"#{Config.instance.identity}_#{$$}"</span>, <span class="ruby-constant">Client</span>.<span class="ruby-identifier">request_sequence</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">"."</span>)
<span class="line-num">550</span>
<span class="line-num">551</span> <span class="ruby-keyword">when</span> <span class="ruby-value">:broadcast</span>
<span class="line-num">552</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">agents_multiplex</span>
<span class="line-num">553</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:name</span>] = [<span class="ruby-string">"/topic/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">collective</span>, <span class="ruby-value">:agents</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">"."</span>)
<span class="line-num">554</span> <span class="ruby-keyword">else</span>
<span class="line-num">555</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:name</span>] = [<span class="ruby-string">"/topic/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">collective</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-value">:agent</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">"."</span>)
<span class="line-num">556</span> <span class="ruby-keyword">end</span>
<span class="line-num">557</span>
<span class="line-num">558</span> <span class="ruby-keyword">when</span> <span class="ruby-value">:request</span>
<span class="line-num">559</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">agents_multiplex</span>
<span class="line-num">560</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:name</span>] = [<span class="ruby-string">"/topic/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">collective</span>, <span class="ruby-value">:agents</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">"."</span>)
<span class="line-num">561</span> <span class="ruby-keyword">else</span>
<span class="line-num">562</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:name</span>] = [<span class="ruby-string">"/topic/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">collective</span>, <span class="ruby-identifier">agent</span>, <span class="ruby-value">:agent</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">"."</span>)
<span class="line-num">563</span> <span class="ruby-keyword">end</span>
<span class="line-num">564</span>
<span class="line-num">565</span> <span class="ruby-keyword">when</span> <span class="ruby-value">:direct_request</span>
<span class="line-num">566</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:name</span>] = [<span class="ruby-string">"/queue/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">collective</span>, <span class="ruby-value">:nodes</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">"."</span>)
<span class="line-num">567</span>
<span class="line-num">568</span> <span class="ruby-keyword">when</span> <span class="ruby-value">:directed</span>
<span class="line-num">569</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:name</span>] = [<span class="ruby-string">"/queue/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">collective</span>, <span class="ruby-value">:nodes</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">"."</span>)
<span class="line-num">570</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:headers</span>][<span class="ruby-string">"selector"</span>] = <span class="ruby-node">"mc_identity = '#{@config.identity}'"</span>
<span class="line-num">571</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:id</span>] = <span class="ruby-string">"%s_directed_to_identity"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">collective</span>
<span class="line-num">572</span> <span class="ruby-keyword">end</span>
<span class="line-num">573</span>
<span class="line-num">574</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:id</span>] = <span class="ruby-identifier">target</span>[<span class="ruby-value">:name</span>] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:id</span>]
<span class="line-num">575</span>
<span class="line-num">576</span> <span class="ruby-identifier">target</span>
<span class="line-num">577</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-publish" class="method-detail ">
<div class="method-heading">
<span class="method-name">publish</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a message to the ActiveMQ connection</p>
<div class="method-source-code" id="publish-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">449</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">publish</span>(<span class="ruby-identifier">msg</span>)
<span class="line-num">450</span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">base64_encode!</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@base64</span>
<span class="line-num">451</span>
<span class="line-num">452</span> <span class="ruby-identifier">target</span> = <span class="ruby-identifier">target_for</span>(<span class="ruby-identifier">msg</span>)
<span class="line-num">453</span>
<span class="line-num">454</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value">:direct_request</span>
<span class="line-num">455</span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">discovered_hosts</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">node</span><span class="ruby-operator">|</span>
<span class="line-num">456</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:headers</span>] = <span class="ruby-identifier">headers_for</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">node</span>)
<span class="line-num">457</span>
<span class="line-num">458</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Sending a direct message to ActiveMQ target '#{target[:name]}' with headers '#{target[:headers].inspect}'"</span>)
<span class="line-num">459</span>
<span class="line-num">460</span> <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">publish</span>(<span class="ruby-identifier">target</span>[<span class="ruby-value">:name</span>], <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">payload</span>, <span class="ruby-identifier">target</span>[<span class="ruby-value">:headers</span>])
<span class="line-num">461</span> <span class="ruby-keyword">end</span>
<span class="line-num">462</span> <span class="ruby-keyword">else</span>
<span class="line-num">463</span> <span class="ruby-identifier">target</span>[<span class="ruby-value">:headers</span>].<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">headers_for</span>(<span class="ruby-identifier">msg</span>))
<span class="line-num">464</span>
<span class="line-num">465</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Sending a broadcast message to ActiveMQ target '#{target[:name]}' with headers '#{target[:headers].inspect}'"</span>)
<span class="line-num">466</span>
<span class="line-num">467</span> <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">publish</span>(<span class="ruby-identifier">target</span>[<span class="ruby-value">:name</span>], <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">payload</span>, <span class="ruby-identifier">target</span>[<span class="ruby-value">:headers</span>])
<span class="line-num">468</span> <span class="ruby-keyword">end</span>
<span class="line-num">469</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-receive" class="method-detail ">
<div class="method-heading">
<span class="method-name">receive</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Receives a message from the ActiveMQ connection</p>
<div class="method-source-code" id="receive-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">418</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">receive</span>
<span class="line-num">419</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-string">"Waiting for a message from ActiveMQ"</span>)
<span class="line-num">420</span>
<span class="line-num">421</span> <span class="ruby-comment"># When the Stomp library > 1.2.0 is mid reconnecting due to its reliable connection</span>
<span class="line-num">422</span> <span class="ruby-comment"># handling it sets the connection to closed. If we happen to be receiving at just</span>
<span class="line-num">423</span> <span class="ruby-comment"># that time we will get an exception warning about the closed connection so handling</span>
<span class="line-num">424</span> <span class="ruby-comment"># that here with a sleep and a retry.</span>
<span class="line-num">425</span> <span class="ruby-keyword">begin</span>
<span class="line-num">426</span> <span class="ruby-identifier">msg</span> = <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">receive</span>
<span class="line-num">427</span> <span class="ruby-keyword">rescue</span> <span class="ruby-operator">::</span><span class="ruby-constant">Stomp</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span><span class="ruby-operator">::</span><span class="ruby-constant">NoCurrentConnection</span>
<span class="line-num">428</span> <span class="ruby-identifier">sleep</span> <span class="ruby-value">1</span>
<span class="line-num">429</span> <span class="ruby-keyword">retry</span>
<span class="line-num">430</span> <span class="ruby-keyword">end</span>
<span class="line-num">431</span>
<span class="line-num">432</span> <span class="ruby-comment"># In older stomp gems an attempt to receive after failed authentication can return nil</span>
<span class="line-num">433</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">nil?</span>
<span class="line-num">434</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">MessageNotReceived</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">exponential_back_off</span>), <span class="ruby-string">"No message received from ActiveMQ."</span>
<span class="line-num">435</span>
<span class="line-num">436</span> <span class="ruby-keyword">end</span>
<span class="line-num">437</span>
<span class="line-num">438</span> <span class="ruby-comment"># We expect all messages we get to be of STOMP frame type MESSAGE, raise on unexpected types</span>
<span class="line-num">439</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">command</span> <span class="ruby-operator">!=</span> <span class="ruby-string">'MESSAGE'</span>
<span class="line-num">440</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Unexpected '#{msg.command}' frame. Headers: #{msg.headers.inspect} Body: #{msg.body.inspect}"</span>)
<span class="line-num">441</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnexpectedMessageType</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">exponential_back_off</span>),
<span class="line-num">442</span> <span class="ruby-node">"Received frame of type '#{msg.command}' expected 'MESSAGE'"</span>
<span class="line-num">443</span> <span class="ruby-keyword">end</span>
<span class="line-num">444</span>
<span class="line-num">445</span> <span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">msg</span>.<span class="ruby-identifier">body</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-value">:base64</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@base64</span>, <span class="ruby-value">:headers</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">headers</span>)
<span class="line-num">446</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ssl_parameters" class="method-detail ">
<div class="method-heading">
<span class="method-name">ssl_parameters</span><span
class="method-args">(poolnum, fallback)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the <a href="../SSL.html"><code>SSL</code></a> paramaters for a specific connection</p>
<div class="method-source-code" id="ssl_parameters-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">349</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ssl_parameters</span>(<span class="ruby-identifier">poolnum</span>, <span class="ruby-identifier">fallback</span>)
<span class="line-num">350</span> <span class="ruby-identifier">params</span> = {
<span class="line-num">351</span> <span class="ruby-value">:cert_file</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">get_cert_file</span>(<span class="ruby-identifier">poolnum</span>),
<span class="line-num">352</span> <span class="ruby-value">:key_file</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">get_key_file</span>(<span class="ruby-identifier">poolnum</span>),
<span class="line-num">353</span> <span class="ruby-value">:ts_files</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">get_option</span>(<span class="ruby-node">"activemq.pool.#{poolnum}.ssl.ca"</span>, <span class="ruby-keyword">false</span>),
<span class="line-num">354</span> <span class="ruby-value">:ciphers</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">get_option</span>(<span class="ruby-node">"activemq.pool.#{poolnum}.ssl.ciphers"</span>, <span class="ruby-keyword">false</span>),
<span class="line-num">355</span> }
<span class="line-num">356</span>
<span class="line-num">357</span> <span class="ruby-identifier">raise</span> <span class="ruby-string">"cert, key and ca has to be supplied for verified SSL mode"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:cert_file</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:key_file</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:ts_files</span>]
<span class="line-num">358</span>
<span class="line-num">359</span> <span class="ruby-identifier">raise</span> <span class="ruby-node">"Cannot find certificate file #{params[:cert_file]}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:cert_file</span>])
<span class="line-num">360</span> <span class="ruby-identifier">raise</span> <span class="ruby-node">"Cannot find key file #{params[:key_file]}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:key_file</span>])
<span class="line-num">361</span>
<span class="line-num">362</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:ts_files</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">","</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ca</span><span class="ruby-operator">|</span>
<span class="line-num">363</span> <span class="ruby-identifier">raise</span> <span class="ruby-node">"Cannot find CA file #{ca}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">ca</span>)
<span class="line-num">364</span> <span class="ruby-keyword">end</span>
<span class="line-num">365</span>
<span class="line-num">366</span> <span class="ruby-keyword">begin</span>
<span class="line-num">367</span> <span class="ruby-operator">::</span><span class="ruby-constant">Stomp</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLParams</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>)
<span class="line-num">368</span> <span class="ruby-keyword">rescue</span> <span class="ruby-constant">NameError</span>
<span class="line-num">369</span> <span class="ruby-identifier">raise</span> <span class="ruby-string">"Stomp gem >= 1.2.2 is needed"</span>
<span class="line-num">370</span> <span class="ruby-keyword">end</span>
<span class="line-num">371</span>
<span class="line-num">372</span> <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="line-num">373</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">fallback</span>
<span class="line-num">374</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Failed to set full SSL verified mode, falling back to unverified: #{e.class}: #{e}"</span>)
<span class="line-num">375</span> <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span>
<span class="line-num">376</span> <span class="ruby-keyword">else</span>
<span class="line-num">377</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Failed to set full SSL verified mode: #{e.class}: #{e}"</span>)
<span class="line-num">378</span> <span class="ruby-identifier">raise</span>(<span class="ruby-identifier">e</span>)
<span class="line-num">379</span> <span class="ruby-keyword">end</span>
<span class="line-num">380</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-stomp_version" class="method-detail ">
<div class="method-heading">
<span class="method-name">stomp_version</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="stomp_version-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">305</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stomp_version</span>
<span class="line-num">306</span> <span class="ruby-operator">::</span><span class="ruby-constant">Stomp</span><span class="ruby-operator">::</span><span class="ruby-constant">Version</span><span class="ruby-operator">::</span><span class="ruby-constant">STRING</span>
<span class="line-num">307</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-stomp_version_supports_heartbeat-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">stomp_version_supports_heartbeat?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="stomp_version_supports_heartbeat-3F-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">309</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stomp_version_supports_heartbeat?</span>
<span class="line-num">310</span> <span class="ruby-keyword">return</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">versioncmp</span>(<span class="ruby-identifier">stomp_version</span>, <span class="ruby-string">"1.2.10"</span>) <span class="ruby-operator">>=</span> <span class="ruby-value">0</span>
<span class="line-num">311</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-subscribe" class="method-detail ">
<div class="method-heading">
<span class="method-name">subscribe</span><span
class="method-args">(agent, type, collective)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Subscribe to a topic or queue</p>
<div class="method-source-code" id="subscribe-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">472</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subscribe</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">collective</span>)
<span class="line-num">473</span> <span class="ruby-identifier">source</span> = <span class="ruby-identifier">make_target</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">collective</span>)
<span class="line-num">474</span>
<span class="line-num">475</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@subscriptions</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">source</span>[<span class="ruby-value">:id</span>])
<span class="line-num">476</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Subscribing to #{source[:name]} with headers #{source[:headers].inspect.chomp}"</span>)
<span class="line-num">477</span> <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">source</span>[<span class="ruby-value">:name</span>], <span class="ruby-identifier">source</span>[<span class="ruby-value">:headers</span>], <span class="ruby-identifier">source</span>[<span class="ruby-value">:id</span>])
<span class="line-num">478</span> <span class="ruby-ivar">@subscriptions</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">source</span>[<span class="ruby-value">:id</span>]
<span class="line-num">479</span> <span class="ruby-keyword">end</span>
<span class="line-num">480</span> <span class="ruby-keyword">rescue</span> <span class="ruby-operator">::</span><span class="ruby-constant">Stomp</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span><span class="ruby-operator">::</span><span class="ruby-constant">DuplicateSubscription</span>
<span class="line-num">481</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">error</span>(<span class="ruby-node">"Received subscription request for #{source.inspect.chomp} but already had a matching subscription, ignoring"</span>)
<span class="line-num">482</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-target_for" class="method-detail ">
<div class="method-heading">
<span class="method-name">target_for</span><span
class="method-args">(msg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="target_for-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">493</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">target_for</span>(<span class="ruby-identifier">msg</span>)
<span class="line-num">494</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value">:reply</span>
<span class="line-num">495</span> <span class="ruby-identifier">target</span> = {<span class="ruby-value">:name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">request</span>.<span class="ruby-identifier">headers</span>[<span class="ruby-string">"reply-to"</span>], <span class="ruby-value">:headers</span> <span class="ruby-operator">=></span> {}}
<span class="line-num">496</span> <span class="ruby-keyword">elsif</span> [<span class="ruby-value">:request</span>, <span class="ruby-value">:direct_request</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">msg</span>.<span class="ruby-identifier">type</span>)
<span class="line-num">497</span> <span class="ruby-identifier">target</span> = <span class="ruby-identifier">make_target</span>(<span class="ruby-identifier">msg</span>.<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">type</span>, <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">collective</span>)
<span class="line-num">498</span> <span class="ruby-keyword">else</span>
<span class="line-num">499</span> <span class="ruby-identifier">raise</span> <span class="ruby-node">"Don't now how to create a target for message type #{msg.type}"</span>
<span class="line-num">500</span> <span class="ruby-keyword">end</span>
<span class="line-num">501</span>
<span class="line-num">502</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">target</span>
<span class="line-num">503</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-unsubscribe" class="method-detail ">
<div class="method-heading">
<span class="method-name">unsubscribe</span><span
class="method-args">(agent, type, collective)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>UnSubscribe to a topic or queue</p>
<div class="method-source-code" id="unsubscribe-source">
<pre> <span class="ruby-comment"># File lib/mcollective/connector/activemq.rb</span>
<span class="line-num">485</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unsubscribe</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">collective</span>)
<span class="line-num">486</span> <span class="ruby-identifier">source</span> = <span class="ruby-identifier">make_target</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">collective</span>)
<span class="line-num">487</span>
<span class="line-num">488</span> <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">"Unsubscribing from #{source[:name]}"</span>)
<span class="line-num">489</span> <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">unsubscribe</span>(<span class="ruby-identifier">source</span>[<span class="ruby-value">:name</span>], <span class="ruby-identifier">source</span>[<span class="ruby-value">:headers</span>], <span class="ruby-identifier">source</span>[<span class="ruby-value">:id</span>])
<span class="line-num">490</span> <span class="ruby-ivar">@subscriptions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">source</span>[<span class="ruby-value">:id</span>])
<span class="line-num">491</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|