| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| <meta charset="UTF-8"> |
| <title>Changing JMS Implementations</title> |
| <meta name="description" content="Apache TomEE"> |
| <meta name="author" content="Apache TomEE"> |
| <meta name="google-translate-customization" content="f36a520c08f4c9-0a04e86a9c075ce9-g265f3196f697cf8f-10"> |
| <meta http-equiv="Pragma" content="no-cache"> |
| <meta http-equiv="Expires" content="0"> |
| <meta http-equiv="Cache-Control" content="no-store, no-cache, must-revalidate, max-age=0"> |
| |
| <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> |
| <!--[if lt IE 9]> |
| <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> |
| <![endif]--> |
| |
| <!-- Le styles --> |
| <link href="./resources/css/bootstrap.css" rel="stylesheet"> |
| <link href="./resources/css/prettify.css" rel="stylesheet"> |
| <!--link href="./resources/css/bootstrap-mods.css" rel="stylesheet"--> |
| <link href="./resources/css/main.css" rel="stylesheet"> |
| <link href="./resources/font-awesome-4.6.3/css/font-awesome.min.css" rel="stylesheet"> |
| |
| <script type="text/javascript"> |
| var t = encodeURIComponent(document.title.replace(/^\s+|\s+$/g,"")); |
| var u = encodeURIComponent(""+document.URL); |
| |
| function fbshare () { |
| window.open( |
| "http://www.facebook.com/sharer/sharer.php?u="+u, |
| 'Share on Facebook', |
| 'width=640,height=426'); |
| }; |
| function gpshare () { |
| window.open( |
| "https://plus.google.com/share?url="+u, |
| 'Share on Google+', |
| 'width=584,height=385'); |
| }; |
| function twshare () { |
| window.open( |
| "https://twitter.com/intent/tweet?url="+u+"&text="+t, |
| 'Share on Twitter', |
| 'width=800,height=526'); |
| }; |
| function pinshare () { |
| window.open("//www.pinterest.com/pin/create/button/?url="+u+"&media=http%3A%2F%2Ftomee.apache.org%2Fresources%2Fimages%2Ffeather-logo.png&description="+t, |
| 'Share on Pinterest', |
| 'width=800,height=526'); |
| }; |
| </script> |
| |
| <!-- Le fav and touch icons --> |
| <link rel="shortcut icon" href="./favicon.ico"> |
| <link rel="apple-touch-icon" href="./resources/images/apple-touch-icon.png"> |
| <link rel="apple-touch-icon" sizes="72x72" href="./resources/images/apple-touch-icon-72x72.png"> |
| <link rel="apple-touch-icon" sizes="114x114" href="./resources/images/apple-touch-icon-114x114.png"> |
| |
| <script src="./resources/js/prettify.js" type="text/javascript"></script> |
| <script src="./resources/js/jquery-latest.js"></script> |
| <script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script> |
| <script src="./resources/js/common.js"></script> |
| <script src="./resources/js/prettyprint.js"></script> |
| <!--script src="//assets.pinterest.com/js/pinit.js" type="text/javascript" async></script//--> |
| |
| <script type="text/javascript"> |
| |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-2717626-1']); |
| _gaq.push(['_setDomainName', 'apache.org']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| |
| </script> |
| </head> |
| |
| <body> |
| |
| <div class="topbar" data-dropdown="dropdown"> |
| <div class="fill"> |
| <div class="container"> |
| <a class="brand" href="./index.html">Apache TomEE</a> |
| <ul class="nav"> |
| <li class="dropdown"> |
| <a class="dropdown-toggle" data-toggle="dropdown" href="#"> |
| Apache |
| <b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <!-- <li><a href="./misc/whoweare.html">Who we are?</a></li> --> |
| <!-- <li><a href="./misc/heritage.html">Heritage</a></li> --> |
| <li><a href="http://www.apache.org">Apache Home</a></li> |
| <!-- <li><a href="./misc/resources.html">Resources</a></li> --> |
| <li><a href="./misc/contact.html">Contact</a></li> |
| <li><a href="./misc/legal.html">Legal</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li class="divider"/> |
| <li><a href="http://www.apache.org/security">Security</a></li> |
| </ul> |
| </li> |
| <li><a href="./index.html">Home</a></li> |
| <li><a href="./downloads.html">Downloads</a></li> |
| <li><a href="./documentation.html">Documentation</a></li> |
| <li><a href="./examples-trunk/index.html">Examples</a></li> |
| <li><a href="./support.html">Support</a></li> |
| <li><a href="./contribute.html">Contribute</a></li> |
| <li><a href="./security/index.html">Security</a></li> |
| </ul> |
| |
| <!-- Google CSE Search Box Begins --> |
| <FORM class="pull-right" id="searchbox_010475492895890475512:_t4iqjrgx90" action="http://www.google.com/cse"> |
| <INPUT type="hidden" name="cx" value="010475492895890475512:_t4iqjrgx90"> |
| <INPUT type="hidden" name="cof" value="FORID:0"> |
| <INPUT size="18" width="130" style="width:130px" name="q" type="text" placeholder="Search"> |
| </FORM> |
| <!--<SCRIPT type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_010475492895890475512:_t4iqjrgx90"></SCRIPT>--> |
| <!-- Google CSE Search Box Ends --> |
| </div> |
| </div> |
| </div> |
| |
| <div class="container"> |
| |
| |
| <div class="page-header"> |
| <small><a href="./index.html">Home</a></small><br> |
| <h1>Changing JMS Implementations |
| |
| <div style="float: right; position: relative; bottom: -10px; "> |
| <a onclick="javascript:gpshare()" class="gp-share sprite" title="Share on Google+">share [gp]</a> |
| <a onclick="javascript:fbshare()" class="fb-share sprite" title="Share on Facebook">share [fb]</a> |
| <a onclick="javascript:twshare()" class="tw-share sprite" title="Share on Twitter">share [tw]</a> |
| <a onclick="javascript:pinshare()" class="pin-share sprite" title="Share on Pinterest">share [pin]</a> |
| <a data-toggle="modal" href="#edit" class="edit-page" title="Contribute to this Page">contribute</a> |
| </div> |
| </h1> |
| </div> |
| |
| <p>ActiveMQ is the default JMS provider in Apache TomEE and OpenEJB.</p> |
| |
| <p>Changing JMS implementation is as simple as using that implementation's Java EE Connector. The connector which will be a <code>.rar</code> file should be bundled with the application in a <code>.ear</code> |
| file. All JMS usage in that <code>.ear</code> will favor the JMS ConnectionFactory and Topic and Queue implementations |
| that are configured in the <code>.rar</code> file rather than ActiveMQ.</p> |
| |
| <p>If the JMS implementation does not have a <code>.rar</code> file, there are still some options for wiring in an alternate implementation.</p> |
| |
| <h1>Generic JMS Resource Adapter</h1> |
| |
| <p>If the JMS implementation does not have a Resource Archive (<code>.rar</code> file) that defines a compliant Resource Adapter, the <a href="http://genericjmsra.java.net/">Generic Resource Adapter for JMS</a> should work fine.</p> |
| |
| <p>To use this Adapter in TomEE or OpenEJB you'll need to create a <code>service-jar.xml</code> file and include that in a jar file and add it to the <code><tomee.home>/lib/</code> directory. |
| Then you can declare <code>ConnectionFactory</code>, <code>Topic</code>, and <code>Queue</code> and more via the <code>tomee.xml</code> file.</p> |
| |
| <p>The one below should be considered boiler plate. Updating it to contain some useful default values for your JMS implementation would be good. These values can be overridden in the <code>tomee.xml</code> or <code>openejb.xml</code></p> |
| |
| <p>Let's say that the following file lives in the jar at <code>META-INF/org.superbiz/service-jar.xml</code></p> |
| |
| <pre><code><?xml version="1.0" encoding="UTF-8"?> |
| <ServiceJar> |
| <ServiceProvider |
| id="genericra" |
| service="Resource" |
| types="GenericJMSRA" |
| class-name="com.sun.genericra.GenericJMSRA"> |
| UserName |
| Password |
| ProviderIntegrationMode |
| ConnectionFactoryClassName |
| QueueConnectionFactoryClassName |
| TopicConnectionFactoryClassName |
| XAConnectionFactoryClassName |
| XAQueueConnectionFactoryClassName |
| XATopicConnectionFactoryClassName |
| UnifiedDestinationClassName |
| TopicClassName |
| QueueClassName |
| SupportsXA |
| ConnectionFactoryProperties |
| JndiProperties |
| CommonSetterMethodName |
| RMPolicy |
| LogLevel |
| DeliveryType |
| UseFirstXAForRedelivery |
| </ServiceProvider> |
| |
| <ServiceProvider |
| id="ConnectionFactory" |
| service="Resource" |
| types="javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory, javax.jms.TopicConnectionFactory, QueueConnectionFactory, TopicConnectionFactory" |
| class-name="com.sun.genericra.outbound.ManagedJMSConnectionFactory"> |
| ConnectionFactoryJndiName |
| ClientId |
| ConnectionValidationEnabled |
| ResourceAdapter |
| </ServiceProvider> |
| |
| <ServiceProvider |
| id="Queue" |
| service="Resource" |
| types="javax.jms.Queue, Queue" |
| class-name="com.sun.genericra.outbound.QueueProxy"> |
| DestinationJndiName |
| ResourceAdapter |
| UserName |
| Password |
| JndiProperties |
| QueueClassName |
| </ServiceProvider> |
| |
| <ServiceProvider |
| id="Topic" |
| service="Resource" |
| types="javax.jms.Topic, Topic" |
| class-name="com.sun.genericra.outbound.TopicProxy"> |
| DestinationJndiName |
| ResourceAdapter |
| UserName |
| Password |
| JndiProperties |
| TopicClassName |
| </ServiceProvider> |
| </ServiceJar> |
| </code></pre> |
| |
| <p>It is strongly recommended to not leave the values in the service-jar.xml file blank as shown above. It is |
| possible to setup several sets of defaults in a <code>service-jar.xml</code> or via several <code>service-jar.xml</code> files.</p> |
| |
| <p>Once this file is packed in a jar and added to the <code><tomee.home>/lib</code> or <code><openejb.home>/lib</code> directory, you can |
| then declare and configure "instances" of these things in your <code>tomee.xml</code> or <code>openejb.xml</code> config file as follows:</p> |
| |
| <pre><code><Resource id="My Generic Adapter" type="GenericJMSRA" provider="org.superbiz:genericra"> |
| AdapterProperty1 PropertyValue1 |
| AdapterProperty2 PropertyValue2 |
| ... |
| </Resource> |
| </code></pre> |
| |
| <p>Or in properties like so:</p> |
| |
| <pre><code>myGenericAdapter = new://Resource?type=GenericJMSRA&provider=org.superbiz:genericra |
| myGenericAdapter.AdapterProperty1 = PropertyValue1 |
| myGenericAdapter.AdapterProperty2 = PropertyValue2 |
| </code></pre> |
| |
| <p>This is basically the same as all configuration in TomEE/OpenEJB, but with the addition that you must |
| specify the <code>provider</code> attribute so the server knows where to look for the <code>service-jar.xml</code> file that |
| defines the resource and all its defaults.</p> |
| |
| <p>In this example:</p> |
| |
| <ul> |
| <li>the file is <code>META-INF/org.superbiz/service-jar.xml</code></li> |
| <li>so the <code>provider</code> attribute is <code>org.superbiz</code></li> |
| </ul> |
| |
| <p>You can use whatever prefix you like for the <code>provider</code> id, though for obvious reasons we'd advise not using <code>org.apache.openejb</code> or <code>org.apache.tomee</code> in the prefix.</p> |
| |
| |
| |
| |
| <div id="edit" class="modal hide fade in" style="display: none; "> |
| <div class="modal-header"> |
| <a class="close" data-dismiss="modal">x</a> |
| |
| <h3>Thank you for contributing to the documentation!</h3> |
| </div> |
| <div class="modal-body"> |
| <h4>Any help with the documentation is greatly appreciated.</h4> |
| <p>All edits are reviewed before going live, so feel free to do much more than fix typos or links. If you see a page that could benefit from an entire rewrite, we'd be thrilled to review it. Don't be surprised if we like it so much we ask you for help with other pages :)</p> |
| <small>NOTICE: unless indicated otherwise on the pages in question, all editable content available from apache.org is presumed to be licensed under the Apache License (AL) version 2.0 and hence all submissions to apache.org treated as formal Contributions under the license terms.</small> |
| <!--[if gt IE 6]> |
| <h4>Internet Explorer Users</h4> |
| <p>If you are not an Apache committer, click the Yes link and enter a <i>anonymous</i> for the username and leave the password empty</p> |
| <![endif]--> |
| |
| </div> |
| <div class="modal-footer"> |
| Do you have an Apache ID? |
| <a href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))" class="btn">Yes</a> |
| <a href="javascript:void(location.href='https://anonymous:@cms.apache.org/redirect?uri='+escape(location.href))" class="btn">No</a> |
| </div> |
| </div> |
| <script src="./resources/js/bootstrap-modal.js"></script> |
| |
| <footer> |
| <p>Copyright © 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> |
| </footer> |
| |
| </div> <!-- /container --> |
| |
| <!-- Javascript |
| ================================================== --> |
| <!-- Placed at the end of the document so the pages load faster --> |
| <script src="./resources/js/bootstrap-dropdown.js"></script> |
| |
| </body> |
| </html> |
