| <!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>Details on openejb-jar</h1> |
| </div> |
| </div> |
| </div> |
| <div class="row"> |
| |
| <div class="col-md-12"> |
| <h1 id="_what_is_an_openejb_jar_xml" class="sect0">What is an openejb-jar.xml?</h1> |
| <div class="paragraph"> |
| <p>This is the file created by the Deploy Tool that maps your bean’s |
| deployment descriptor (ejb-jar.xml) to actual containers and resources |
| declared in your OpenEJB configuration (openejb.conf). In fact, the |
| Deploy tool really does nothing more than create this file and put it in |
| your jar, that’s it.</p> |
| </div> |
| <h1 id="_when_is_the_openejb_jar_xml_used" class="sect0">When is the openejb-jar.xml used?</h1> |
| <div class="paragraph"> |
| <p>At startup, any jar containing a openejb-jar.xml is loaded by the |
| container system. The configuration tools will go looking in all the |
| directories and jars you have declared in your openejb.conf with the |
| element. For every jar file it finds, it will look inside for an |
| openejb-jar.xml. If it finds one, it will attempt to load and deploy it |
| into the container system.</p> |
| </div> |
| <h1 id="_do_i_even_need_the_deploy_tool_then" class="sect0">Do I even need the deploy tool then?</h1> |
| <div class="paragraph"> |
| <p>Nope. Typically you would only use the deploy tool to create your |
| openejb-jar.xml, then just keep your openejb-jar.xml in your CVS (or |
| other repository). If you learn how to maintain this openejb-jar.xml |
| file, you’ll never need the deploy tool again! You can do all your |
| builds and deploys automatically.</p> |
| </div> |
| <h1 id="_where_do_i_put_the_openejb_jar_xml_in_my_jar" class="sect0">Where do I put the openejb-jar.xml in my jar?</h1> |
| <div class="paragraph"> |
| <p>The openejb-jar.xml file just goes in the META-INF directory of your jar |
| next to the ejb-jar.xml file.</p> |
| </div> |
| <h1 id="_is_the_file_format_easy" class="sect0">Is the file format easy?</h1> |
| <div class="paragraph"> |
| <p>If you can understand the ejb-jar.xml, the openejb-jar.xml should be a |
| breeze.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This is the openejb-jar.xml that is created by the Deploy tool in the |
| Hello World example. As you can see, the file format is extremely |
| simple.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-xml" data-lang="xml"><?xml version="1.0"?> |
| <openejb-jar xmlns="http://www.openejb.org/openejb-jar/1.1"> |
| <ejb-deployment ejb-name="Hello" |
| deployment-id="Hello" |
| container-id="Default Stateless Container"/> |
| </openejb-jar></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The <em>ejb-name</em> attribute is the name you gave the bean in your |
| ejb-jar.xml. The <em>deployment-id</em> is the name you want to use to lookup |
| the bean in your client’s JNDI namespace. The <em>container-id</em> is the name |
| of the container in your openejb.conf file that you would like the bean |
| to run in. There MUST be one <em>ejb-deployment</em> element for each EJB in |
| your jar.</p> |
| </div> |
| <div class="sect1"> |
| <h2 id="_what_if_my_bean_uses_a_jdbc_datasource">What if my bean uses a JDBC datasource?</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Then you simply add a element to your element like this</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-xml" data-lang="xml"><?xml version="1.0"?> |
| <openejb-jar xmlns="http://www.openejb.org/openejb-jar/1.1"> |
| |
| <ejb-deployment ejb-name="Hello" |
| deployment-id="Hello" |
| container-id="Default Stateless Container" > |
| |
| <resource-link res-ref-name="jdbc/basic/entityDatabase" |
| res-id="Default JDBC Database"/> |
| |
| </ejb-deployment> |
| |
| </openejb-jar></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The <em>res-ref-name</em> attribute refers to the element of the bean’s |
| declaration in the ejb-jar.xml. The <em>res-id</em> attribute refers to the id |
| of the declared in your openejb.conf that will handle the connections |
| and provide access to the desired resource.</p> |
| </div> |
| </div> |
| </div> |
| <h1 id="_how_many_resource_link_elements_will_i_need" class="sect0">How many resource-link elements will I need?</h1> |
| <div class="paragraph"> |
| <p>You will need one element for every element in your ejb-jar.xml. So if |
| you had an ejb-jar.xml like the following</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-xml" data-lang="xml"><?xml version="1.0"?> |
| <ejb-jar> |
| <enterprise-beans> |
| <session> |
| <ejb-name>MyExampleBean</ejb-name> |
| <home>com.widget.ExampleHome</home> |
| <remote>com.widget.ExampleObject</remote> |
| <ejb-class>com.widget.ExampleBean</ejb-class> |
| <session-type>Stateless</session-type> |
| <transaction-type>Container</transaction-type> |
| |
| <resource-ref> |
| <description> |
| This is a reference to a JDBC database. |
| </description> |
| <res-ref-name>jdbc/myFirstDatabase</res-ref-name> |
| <res-type>javax.sql.DataSource</res-type> |
| <res-auth>Container</res-auth> |
| </resource-ref> |
| |
| <resource-ref> |
| <description> |
| This is another reference to a JDBC database. |
| </description> |
| <res-ref-name>jdbc/anotherDatabase</res-ref-name> |
| <res-type>javax.sql.DataSource</res-type> |
| <res-auth>Container</res-auth> |
| </resource-ref> |
| |
| </session> |
| </enterprise-beans> |
| </ejb-jar></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Then you would need two elements for that bean in your openejb-jar.xml |
| file as such.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-xml" data-lang="xml"><?xml version="1.0"?> |
| <openejb-jar xmlns="http://www.openejb.org/openejb-jar/1.1"> |
| |
| <ejb-deployment ejb-name="MyExampleBean" |
| deployment-id="MyExampleBean" |
| container-id="Default Stateless Container" > |
| |
| <resource-link res-ref-name="jdbc/myFirstDatabase" |
| res-id="My Oracle JDBC Database"/> |
| |
| <resource-link res-ref-name="jdbc/anotherDatabase" |
| res-id="My PostgreSQL JDBC Database"/> |
| |
| </ejb-deployment> |
| |
| </openejb-jar></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This would require two declarations in your openejb.conf, one with the |
| <em>id</em> attribute set to <em>"My Oracle JDBC Database"</em> , and another with |
| it’s <em>id</em> attribute set to <em>"My PostgreSQL JDBC Database"</em></p> |
| </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/" 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> |
| |
