| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| <meta charset="UTF-8"> |
| <title>Embedded 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>Embedded 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="EmbeddedConfiguration-Defaults,OverridesandOrder"></a></p> |
| |
| <h1>Defaults, Overrides and Order</h1> |
| |
| <p>When booting up OpenEJB for testing via the <code>LocalInitialContextFactory</code> |
| or the newer <code>EJBContainer.createEJBContainer()</code> API part of EJB 3.1 there |
| is quite a bit of flexibility to how things are configured.</p> |
| |
| <p>OpenEJB will function fine with no configuration at all and will happily |
| create things as needed and select defaults for everything. So in a real |
| sense configuration is all about overriding those defaults. There are |
| several places to put your overrides and an a specific order how they are |
| applied. Here they are in order of preference; 1 = highest, 5 = lowest. |
| <div class="row"><div class="span8"> |
| <strong>InitialContext</strong></p> |
| |
| <ol> |
| <li>InitialContext properties</li> |
| <li>jndi.properties from the classpath</li> |
| <li>System properties</li> |
| <li>openejb.xml declarations/properties</li> |
| <li>service-jar.xml declarations/properties (internal concept)</div> |
| <div class="span8"> |
| <strong>EJBContainer API</strong></li> |
| <li>EJBContainer.createEJBContainer(Map) entries</li> |
| <li>System properties</li> |
| <li>openejb.xml declarations/properties</li> |
| <li>service-jar.xml declarations/properties (internal concept) |
| </div></div></li> |
| </ol> |
| |
| <p>It opens up some interesting possibilities in how you configure your |
| environment. You could do 100% of your configuration in your test case via |
| InitialContext propertes, or you could do say 80% in a jndi.properties file |
| or openejb.xml file and 20% in your test case via InitialContext |
| properties. You can put 100% of your configuration in a <code>jndi.properties</code> or |
| <code>openejb.xml</code> file and override them via <code>InitialContext</code> properties.</p> |
| |
| <p>You can manage the properties how you wish and there is no need for |
| redundant definitions if you do not want them.</p> |
| |
| <p><a name="EmbeddedConfiguration-Whatisconfigurable?"></a></p> |
| |
| <h1>What is configurable?</h1> |
| |
| <p>Everything you can configure via an openejb.xml (minus the <Deployment> |
| element) can be configured/overridden via properties. See <a href="configuring-containers-in-tests.html">Configuring Containers in Tests</a> |
| and <a href="configuring-datasources-in-tests.html">Configuring DataSources in Tests</a>.</p> |
| |
| <p>Everything in your logging.properties can be configured/overridden via |
| properties. See <a href="configuring-logging-in-tests.html">Configuring Logging in Tests</a>.</p> |
| |
| <p>The properties of persistence units declared in a persistence.xml can be |
| configured/overridden via properties. See <a href="configuring-persistenceunits-in-tests.html">Configuring PersistenceUnits in Tests</a>.</p> |
| |
| <p>OpenEJB has many flags that can also be set as properties. See <a href="properties-listing.html">OpenEJB Properties</a> |
| for details on those.</p> |
| |
| <p><a name="EmbeddedConfiguration-ExampleofusingInitialContextproperties"></a></p> |
| |
| <h1>Example of using InitialContext properties</h1> |
| |
| <pre><code>Properties p = new Properties(); |
| |
| // set the initial context factory |
| p.put("java.naming.factory.initial ", "org.apache.openejb.client.LocalInitialContextFactory"); |
| |
| // change some logging |
| p.put("log4j.category.OpenEJB.options ", " debug"); |
| p.put("log4j.category.OpenEJB.startup ", " debug"); |
| p.put("log4j.category.OpenEJB.startup.config ", " debug"); |
| |
| // create some resources |
| p.put("movieDatabase", "new://Resource?type=DataSource"); |
| p.put("movieDatabase.JdbcDriver ", " org.hsqldb.jdbcDriver"); |
| p.put("movieDatabase.JdbcUrl ", " jdbc:hsqldb:mem:moviedb"); |
| |
| // override properties on your "movie-unit" persistence unit |
| p.put("movie-unit.hibernate.dialect ", "org.hibernate.dialect.HSQLDialect"); |
| |
| // set some openejb flags |
| p.put("openejb.jndiname.format ", " {ejbName}/{interfaceClass}"); |
| p.put("openejb.descriptors.output ", " true"); |
| p.put("openejb.validation.output.level ", " verbose"); |
| |
| InitialContext initialContext = new InitialContext(p); |
| </code></pre> |
| |
| <p><a name="EmbeddedConfiguration-Exampleofusingjndi.properties"></a></p> |
| |
| <h1>Example of using jndi.properties</h1> |
| |
| <p>Here's an example of the same properties being specified via a |
| <code>jndi.properties file</code>. This file just needs to be placed in the classpath, |
| not in a subdirectory of a path in the classpath such as META-INF, but at |
| the root of any of the paths in the classpath.</p> |
| |
| <pre><code># set the initial context factory |
| java.naming.factory.initial = org.apache.openejb.client.LocalInitialContextFactory |
| |
| # change some logging |
| log4j.category.OpenEJB.options = debug |
| log4j.category.OpenEJB.startup = debug |
| log4j.category.OpenEJB.startup.config = debug |
| |
| # create some resources |
| movieDatabase = new://Resource?type=DataSource |
| movieDatabase.JdbcDriver = org.hsqldb.jdbcDriver |
| movieDatabase.JdbcUrl = jdbc:hsqldb:mem:moviedb |
| |
| # override properties on your "movie-unit" persistence unit |
| movie-unit.hibernate.dialect = org.hibernate.dialect.HSQLDialect |
| |
| # set some openejb flags |
| openejb.jndiname.format = {ejbName}/{interfaceClass} |
| openejb.descriptors.output = true |
| openejb.validation.output.level = verbose |
| </code></pre> |
| |
| <p>Then OpenEJB can be booted via the <code>InitialContext</code> as normal. Properties |
| can still be used to override any of the above properties:</p> |
| |
| <pre><code>Properties p = new Properties(); |
| |
| p.put("openejb.validation.output.level ", " medium"); |
| |
| InitialContext initialContext = new InitialContext(p); |
| </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> |
