| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| <meta charset="UTF-8"> |
| <title>Configuration</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>Configuration |
| |
| <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><a name="Configuration-ShortOverview"></a></p> |
| |
| <h1>Short Overview</h1> |
| |
| <p><a name="Configuration-ConfigurationProperties"></a></p> |
| |
| <h2>Configuration Properties</h2> |
| |
| <ul> |
| <li><em>openejb.home</em> - OpenEJB home (installation) directory path. All relative paths are resolved against the property unless openejb.base is set. Unless set, the value is assigned to the <em>user.dir</em> Java property.</li> |
| <li><em>openejb.base</em> - OpenEJB base directory path. If set, the directory pointed by the property is searched for resources before openejb.home.</li> |
| <li><em>openejb.configuration</em> - OpenEJB configuration file path.</li> |
| <li><em>openejb.loader</em> - OpenEJB loader that's responsible for loading EJBs. There are 3 different loader types: <br /> |
| <em>* <em>tomcat-webapp</em> - set it when inside of Tomcat scoped at just the webapp, aka. <a href="collapsed-ear.html">Collapsed EAR</a> |
| <em></em> <em>tomcat</em> - set it when inside of Tomcat scoped for all webapps to share |
| <em></em> <em>system</em> (also: bootstrap) |
| *</em> <em>embedded</em> (also: noload)</li> |
| <li><em>openejb.configurator</em> (default: <em>org.openejb.alt.config.ConfigurationFactory</em> ) - a class that builds org.openejb.alt.assembler.classic.OpenEjbConfiguration object; implements the org.openejb.alt.assembler.classic.OpenEjbConfigurationFactory interface</li> |
| <li><em>openejb.descriptors.output</em> - possible values: true|false - When set OpenEJB saves deployment descriptors - ejb-jar.xml and openejb-jar.xml</li> |
| </ul> |
| |
| <p><a name="Configuration-ConfigurationFile"></a></p> |
| |
| <h2>Configuration File</h2> |
| |
| <p>Show a config file with the elements hyperlinked.</p> |
| |
| <pre><code><?xml version="1.0"?> |
| <openejb> |
| <Container id="Default CMP Container" ctype="CMP_ENTITY"> |
| Global_TX_Database c:/my/app/conf/postgresql.cmp_global_database.xml |
| Local_TX_Database c:/my/app/conf/postgresql.cmp_local_database.xml |
| </Container> |
| <Connector id="Default JDBC Database"> |
| JdbcDriver org.postgresql.Driver |
| JdbcUrl jdbc:postgresql://localhost/mydb |
| UserName username |
| Password password |
| </Connector> |
| <SecurityService id="Default Security Service"/> |
| <TransactionService id="Default Transaction Manager"/> |
| <Deployments jar="c:/my/app/employee.jar"/> |
| <Deployments dir="beans/" /> |
| </openejb> |
| </code></pre> |
| |
| <h1>Basic Layout</h1> |
| |
| <p>Basically, openejb.base is the source for 100% of all configuration |
| information and third party config files (log4j, castor, instantdb, |
| whatever). This includes finding where the, possibly many, <Deployment> |
| entries in the openejb.conf point. The openejb.home is where the code |
| loading OpenEJB will look for all the OpenEJB libraries. Usually |
| openejb.base is not explicitly set and defaults to the value of |
| openejb.home, so many people are used to only dealing with openejb.home.</p> |
| |
| <p>The point of having and openejb.base and openejb.home was basically to |
| allow several independently configured instances of OpenEJB running on a |
| system (perhaps embedded in Swing apps, in Tomcat, running as a standalone |
| Server, or even in Groovy as Mr. Strachan did!) but without the need to |
| copy all the OpenEJB system libraries everywhere.</p> |
| |
| <p><em>openejb.home</em> |
| * can be set explicitly via a system property. |
| * if not set it default's to user.dir, which is the current working |
| directory.</p> |
| |
| <p><em>openejb.base</em> |
| * can be set explicitly via a system property. |
| * If not set it default's to openejb.home.</p> |
| |
| <p><em>openejb.configuration</em> |
| * can be set to explicitly point to the file containing your |
| configuration. |
| * If set to a relative path, we first look in user.dir/your-conf-file, |
| then in openejb.base/your-conf-file |
| * If not set we check in openejb.base/conf/openejb.conf |
| * If no conf file is found, we create one in |
| openejb.base/conf/openejb.conf</p> |
| |
| <p><em>relative paths in openejb.conf</em> |
| * Deployment entries are resolved relative to openejb.base. |
| * Containers use openejb.base to resolve their own config files. For |
| example, Castor JDO to loads the database.xml and all other files from the |
| openejb.base directory. |
| * Resource adapters that are embedded usually have config files of their |
| own and are also loaded from the openeb.base.</p> |
| |
| <p><em>log files</em> |
| * The log4.configuration file is resolved relative to openejb.base. |
| * The properties in the config file that point to files are also resolved |
| relative to openejb.base.</p> |
| |
| <p><em>OpenEJB libraries</em> |
| * The jars in the lib and dist directories under openejb.home are added |
| to the classpath.</p> |
| |
| <h2>Summary</h2> |
| |
| <p>A summary of the above in a different notation:</p> |
| |
| <pre><code>openejb.home = user.dir (can be set explicitly) |
| openejb.base = openejb.home (can be set explicitly) |
| openejb.conf = openejb.base/conf/openejb.conf (can be set explicitly) |
| logging.conf = openejb.base/conf/logging.conf (can be set explicitly) |
| deployments = paths listed in openejb.conf (relative paths resolved from openejb.base) |
| Classpath includes openejb.home/lib and openejb.home/dist |
| </code></pre> |
| |
| <h2>Example layout</h2> |
| |
| <p>In this one the openejb.home and openejb.base are set, everything else is |
| defaulted. The openejb.conf file as been updated to point to the ejb jars |
| by name (abc-ejbs.jar and xyz-ejbs.jar).</p> |
| |
| <p>An example layout:</p> |
| |
| <pre><code>/usr/local/openejb (openejb.home) |
| /usr/local/openejb/lib (in classpath) |
| /usr/local/openejb/dist (in classpath) |
| /home/jsmith/foo_app (openejb.base) |
| /home/jsmith/foo_app/conf/openejb.conf |
| /home/jsmith/foo_app/conf/logging.conf |
| /home/jsmith/foo_app/abc-ejbs.jar (Deployment entry in openejb.conf) |
| /home/jsmith/foo_app/xyz-ejbs.jar (Deployment entry in openejb.conf) |
| /home/jsmith/foo_app/logs/ |
| </code></pre> |
| |
| <h2>Another Example layout</h2> |
| |
| <p>In this example openejb.home and openejb.base are setup as well as the |
| explicit paths for the openejb and log4j configuration files.</p> |
| |
| <p>An example layout:</p> |
| |
| <pre><code>/usr/local/openejb (openejb.home) |
| /usr/local/openejb/lib (in classpath) |
| /usr/local/openejb/dist (in classpath) |
| /home/jsmith/foo_app (openejb.base) |
| /home/jsmith/foo_app/openejb.xml (openejb.configuration) |
| /home/jsmith/foo_app/abc-ejbs.jar (Deployment entry in openejb.xml) |
| /home/jsmith/foo_app/xyz-ejbs.jar (Deployment entry in openejb.xml) |
| /home/jsmith/foo_app/log4j.conf (log4j.configuration) |
| /home/jsmith/foo_app/mylogs/ (logging dir as defined in log4j.conf) |
| </code></pre> |
| |
| |
| |
| |
| <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> |
