| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| <meta charset="UTF-8"> |
| <title>TomEE and Hibernate</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>TomEE and Hibernate |
| |
| <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>Apache TomEE ships with OpenJPA as the default JPA provider, however any valid JPA 2.0 provider can be used.</p> |
| |
| <p>The basic steps are:</p> |
| |
| <ol> |
| <li>Add the Hibernate jars to <code><tomee-home>/lib/</code></li> |
| <li>Configure the webapp or the server to use Hibernate</li> |
| </ol> |
| |
| <p><strong>The atifact versions defined here are just for example, so please feel free to use current library versions.</strong></p> |
| |
| <h1>Webapp Configuration</h1> |
| |
| <p>Any webapp can specify the JPA provider it would like to use via the <code>persistence.xml</code> file, which can be at any of the following locations in a webapp</p> |
| |
| <ul> |
| <li><code>WEB-INF/persistence.xml</code> of the <code>.war</code> file</li> |
| <li><code>META-INF/persistence.xml</code> in any jar located in <code>WEB-INF/lib/</code></li> |
| </ul> |
| |
| <p>A single webapp may have many <code>persistence.xml</code> files and each may use whichever JPA provider it needs.</p> |
| |
| <p>The following is an example of a fairly common <code>persistence.xml</code> for Hibernate</p> |
| |
| <pre><code><persistence version="1.0" |
| xmlns="http://java.sun.com/xml/ns/persistence" |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xsi:schemaLocation="http://java.sun.com/xml/ns/persistence |
| http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"> |
| |
| <persistence-unit name="movie-unit"> |
| <provider>org.hibernate.ejb.HibernatePersistence</provider> |
| <jta-data-source>movieDatabase</jta-data-source> |
| <non-jta-data-source>movieDatabaseUnmanaged</non-jta-data-source> |
| |
| <properties> |
| <property name="hibernate.hbm2ddl.auto" value="create-drop"/> |
| </properties> |
| </persistence-unit> |
| </persistence> |
| </code></pre> |
| |
| <p>Note, TomEE will automatically add the following property unless it is explicitly configured:</p> |
| |
| <pre><code> <property name="hibernate.transaction.manager_lookup_class" |
| value="org.apache.openejb.hibernate.TransactionManagerLookup"/> |
| </code></pre> |
| |
| <h1>Server Configuration</h1> |
| |
| <p>The default JPA provider can be changed at the server level to favor Hibernate over OpenJPA.</p> |
| |
| <p>Using the <code><tomee-home>/conf/system.properties</code> file or any other valid means of setting <code>java.lang.System.getProperties()</code>, the following standard properties can set the detault for any <code>persistence.xml</code> file.</p> |
| |
| <ul> |
| <li><code>javax.persistence.provider</code></li> |
| <li><code>javax.persistence.transactionType</code></li> |
| <li><code>javax.persistence.jtaDataSource</code></li> |
| <li><code>javax.persistence.nonJtaDataSource</code></li> |
| </ul> |
| |
| <p>So, for example, Hibernate can become the default provider via setting</p> |
| |
| <p><code>CATALINA_OPTS=-Djavax.persistence.provider=org.hibernate.ejb.HibernatePersistence</code></p> |
| |
| <p>You <strong>must</strong> of course add the Hibernate libraries to <code><tomee-home>/lib/</code> for this to work.</p> |
| |
| <h1>Hibernate libraries</h1> |
| |
| <p>Jars needed for Hibernate 4.x:</p> |
| |
| <p>Add:</p> |
| |
| <ul> |
| <li><code><tomee-home>/lib/antlr-2.7.7.jar</code></li> |
| <li><code><tomee-home>/lib/dom4j-1.6.1.jar</code></li> |
| <li><code><tomee-home>/lib/hibernate-commons-annotations-4.0.1.Final.jar</code></li> |
| <li><code><tomee-home>/lib/hibernate-core-4.1.4.Final.jar</code></li> |
| <li><code><tomee-home>/lib/hibernate-entitymanager-4.1.4.Final.jar</code></li> |
| <li><code><tomee-home>/lib/hibernate-validator-4.3.0.Final.jar</code></li> |
| <li><code><tomee-home>/lib/jboss-logging-3.1.0.GA.jar</code></li> |
| </ul> |
| |
| <p>Remove (optional):</p> |
| |
| <ul> |
| <li><code><tomee-home>/lib/asm-3.2.jar</code></li> |
| <li><code><tomee-home>/lib/openjpa-2.2.0.jar</code></li> |
| </ul> |
| |
| <h1>Ehcache (optional)</h1> |
| |
| <p>To use Hibernate with Ehcache, add:</p> |
| |
| <ul> |
| <li><code><tomee-home>/lib/hibernate-ehcache-4.1.4.Final.jar</code></li> |
| <li><code><tomee-home>/lib/ehcache-core-2.5.1.jar</code></li> |
| <li><code><tomee-home>/lib/ehcache-terracotta-2.5.1.jar</code></li> |
| <li><code><tomee-home>/lib/terracotta-toolkit-1.4-runtime-4.1.0.jar</code></li> |
| </ul> |
| |
| <h1>Infinispan (optional)</h1> |
| |
| <p>To use Infinispan cache (default Hibernate 2nd level cache) you need the below jars:</p> |
| |
| <pre><code> |
| <lib>org.infinispan:infinispan-core:5.1.4.FINAL</lib> |
| <lib>org.hibernate:hibernate-infinispan:${hibernate.core.version}</lib> |
| <lib>org.jgroups:jgroups:3.0.9.Final</lib> |
| <lib>org.jboss.marshalling:jboss-marshalling-river:1.3.11.GA:</lib> |
| <lib>org.jboss.marshalling:jboss-marshalling:1.3.11.GA</lib> |
| <lib>org.codehaus.woodstox:woodstox-core-asl:4.1.1</lib> |
| <lib>org.codehaus.woodstox:stax2-api:3.1.1</lib> |
| <lib>org.rhq.helpers:rhq-pluginAnnotations:3.0.4</lib> |
| <lib>org.jboss.logmanager:jboss-logmanager:1.2.2.GA</lib> |
| </code></pre> |
| |
| <p>There are many guides on how to use 2nd level cache with JPA 2. |
| You can remove OpenJPA jar so less jars are in <code><tomee-home>/lib</code> folder. |
| Also, be sure to put your Database JDBC driver in <code><tomee-home>/lib</code>.</p> |
| |
| <p>The actual Maven dependencies for your project can be added in the usual way:</p> |
| |
| <pre><code> <!-- Hibernate --> |
| <dependency> |
| <groupId>antlr</groupId> |
| <artifactId>antlr</artifactId> |
| <version>2.7.7</version> |
| </dependency> |
| <dependency> |
| <groupId>dom4j</groupId> |
| <artifactId>dom4j</artifactId> |
| <version>1.6.1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.hibernate.common</groupId> |
| <artifactId>hibernate-commons-annotations</artifactId> |
| <version>4.0.5.Final</version> |
| </dependency> |
| <dependency> |
| <groupId>org.hibernate</groupId> |
| <artifactId>hibernate-core</artifactId> |
| <version>4.2.16.Final</version> |
| </dependency> |
| <dependency> |
| <groupId>org.hibernate</groupId> |
| <artifactId>hibernate-ehcache</artifactId> |
| <version>4.2.16.Final</version> |
| </dependency> |
| <dependency> |
| <groupId>org.hibernate</groupId> |
| <artifactId>hibernate-entitymanager</artifactId> |
| <version>4.2.16.Final</version> |
| </dependency> |
| <dependency> |
| <groupId>org.hibernate</groupId> |
| <artifactId>hibernate-validator</artifactId> |
| <version>4.3.2.Final</version> |
| </dependency> |
| <dependency> |
| <groupId>org.jboss.logging</groupId> |
| <artifactId>jboss-logging</artifactId> |
| <version>3.1.0.GA</version> |
| </dependency> |
| <dependency> |
| <groupId>org.javassist</groupId> |
| <artifactId>javassist</artifactId> |
| <version>3.15.0-GA</version> |
| </dependency> |
| </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> |
