| <!DOCTYPE html> |
| <html lang="en"> |
| |
| <head> |
| <meta charset="UTF-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <title>Apache TomEE</title> |
| <meta name="description" |
| content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." /> |
| <meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" /> |
| <meta name="author" content="Luka Cvetinovic for Codrops" /> |
| <link rel="icon" href="../../favicon.ico"> |
| <link rel="icon" type="image/png" href="../../favicon.png"> |
| <meta name="msapplication-TileColor" content="#80287a"> |
| <meta name="theme-color" content="#80287a"> |
| <link rel="stylesheet" type="text/css" href="../../css/normalize.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/bootstrap.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/owl.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/animate.css"> |
| <link rel="stylesheet" type="text/css" href="../../fonts/font-awesome-4.1.0/css/font-awesome.min.css"> |
| <link rel="stylesheet" type="text/css" href="../../fonts/eleganticons/et-icons.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/jqtree.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/idea.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/cardio.css"> |
| |
| <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="preloader"> |
| <img src="../../img/loader.gif" alt="Preloader image"> |
| </div> |
| <nav class="navbar"> |
| <div class="container"> |
| <div class="row"> <div class="col-md-12"> |
| |
| <!-- Brand and toggle get grouped for better mobile display --> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="/"> |
| <span> |
| |
| |
| <img src="../../img/logo-active.png"> |
| |
| |
| </span> |
| Apache TomEE |
| </a> |
| </div> |
| <!-- Collect the nav links, forms, and other content for toggling --> |
| <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> |
| <ul class="nav navbar-nav navbar-right main-nav"> |
| <li><a href="../../docs.html">Documentation</a></li> |
| <li><a href="../../community/index.html">Community</a></li> |
| <li><a href="../../security/security.html">Security</a></li> |
| <li><a href="../../download-ng.html">Downloads</a></li> |
| </ul> |
| </div> |
| <!-- /.navbar-collapse --> |
| </div></div> |
| </div> |
| <!-- /.container-fluid --> |
| </nav> |
| |
| |
| <div id="main-block" class="container main-block"> |
| <div class="row title"> |
| <div class="col-md-12"> |
| <div class='page-header'> |
| |
| <h1>Changing JMS Implementations</h1> |
| </div> |
| </div> |
| </div> |
| <div class="row"> |
| |
| <div class="col-md-12"> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| Licensed to the Apache Software |
| Foundation (ASF) under one or more contributor license agreements. See |
| the NOTICE file distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file to you under |
| the Apache License, Version 2.0 (the "License"); you may not use this |
| file except in compliance with the License. You may obtain a copy of the |
| License at . <a href="http://www.apache.org/licenses/LICENSE-2.0" class="bare">http://www.apache.org/licenses/LICENSE-2.0</a> . Unless |
| required by applicable law or agreed to in writing, software distributed |
| under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES |
| OR CONDITIONS OF ANY KIND, either express or implied. See the License |
| for the specific language governing permissions and limitations under |
| the License. |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="paragraph"> |
| <p>ActiveMQ is the default JMS provider in Apache TomEE and OpenEJB.</p> |
| </div> |
| <div class="paragraph"> |
| <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> |
| </div> |
| <div class="paragraph"> |
| <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> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_generic_jms_resource_adapter">Generic JMS Resource Adapter</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <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> |
| </div> |
| <div class="paragraph"> |
| <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> |
| </div> |
| <div class="paragraph"> |
| <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> |
| </div> |
| <div class="paragraph"> |
| <p>Let’s say that the following file lives in the jar at |
| <code>META-INF/org.superbiz/service-jar.xml</code></p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-xml" data-lang="xml"><?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> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <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> |
| </div> |
| <div class="paragraph"> |
| <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> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="My Generic Adapter" type="GenericJMSRA" provider="org.superbiz:genericra"> |
| AdapterProperty1 PropertyValue1 |
| AdapterProperty2 PropertyValue2 |
| ... |
| </Resource></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Or in properties like so:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-properties" data-lang="properties">myGenericAdapter = new://Resource?type=GenericJMSRA&provider=org.superbiz:genericra |
| myGenericAdapter.AdapterProperty1 = PropertyValue1 |
| myGenericAdapter.AdapterProperty2 = PropertyValue2</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <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> |
| </div> |
| <div class="paragraph"> |
| <p>In this example:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>the file is <code>META-INF/org.superbiz/service-jar.xml</code></p> |
| </li> |
| <li> |
| <p>so the <code>provider</code> attribute is <code>org.superbiz</code></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <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> |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| </div> |
| <footer> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-sm-6 text-center-mobile"> |
| <h3 class="white">Be simple. Be certified. Be Tomcat.</h3> |
| <h5 class="light regular light-white">"A good application in a good server"</h5> |
| <ul class="social-footer"> |
| <li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li> |
| <li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li> |
| <li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li> |
| </ul> |
| </div> |
| <div class="col-sm-6 text-center-mobile"> |
| <div class="row opening-hours"> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../latest/docs/documentation.html" class="white">Documentation</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li> |
| <li><a href="../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li> |
| <li><a href="../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li> |
| <li><a href="../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li> |
| </ul> |
| </div> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../latest/examples/" class="white">Examples</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li> |
| <li><a href="../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li> |
| <li><a href="../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li> |
| <li><a href="../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li> |
| </ul> |
| </div> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../community/index.html" class="white">Community</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="../../community/contributors.html" class="regular light-white">Contributors</a></li> |
| <li><a href="../../community/social.html" class="regular light-white">Social</a></li> |
| <li><a href="../../community/sources.html" class="regular light-white">Sources</a></li> |
| </ul> |
| </div> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../security/index.html" class="white">Security</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li> |
| <li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li> |
| <li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="row bottom-footer text-center-mobile"> |
| <div class="col-sm-12 light-white"> |
| <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> |
| </div> |
| </div> |
| </div> |
| </footer> |
| <!-- Holder for mobile navigation --> |
| <div class="mobile-nav"> |
| <ul> |
| <li><a hef="../../latest/docs/admin/index.html">Administrators</a> |
| <li><a hef="../../latest/docs/developer/index.html">Developers</a> |
| <li><a hef="../../latest/docs/advanced/index.html">Advanced</a> |
| <li><a hef="../../community/index.html">Community</a> |
| </ul> |
| <a href="#" class="close-link"><i class="arrow_up"></i></a> |
| </div> |
| <!-- Scripts --> |
| <script src="../../js/jquery-1.11.1.min.js"></script> |
| <script src="../../js/owl.carousel.min.js"></script> |
| <script src="../../js/bootstrap.min.js"></script> |
| <script src="../../js/wow.min.js"></script> |
| <script src="../../js/typewriter.js"></script> |
| <script src="../../js/jquery.onepagenav.js"></script> |
| <script src="../../js/tree.jquery.js"></script> |
| <script src="../../js/highlight.pack.js"></script> |
| <script src="../../js/main.js"></script> |
| </body> |
| |
| </html> |
| |
