Skip to content

Commit

Permalink
HHH-10812 Addressing review remarks
Browse files Browse the repository at this point in the history
  • Loading branch information
gunnarmorling authored and sebersole committed Jun 29, 2016
1 parent 62b5cf6 commit 94389ee
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions documentation/src/main/asciidoc/topical/wildfly/Wildfly.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,21 @@

The http://wildfly.org/[WildFly application server] comes with Hibernate as the default JPA provider out of the box.
This means that you don't need to package Hibernate ORM with the applications you deploy on WildFly,
instead the application server will automatically enable Hibernate support if it detects that your application works with JPA/Hibernate.
instead the application server will automatically enable Hibernate support if it detects that your application is using JPA.

There may be times though where a newer version of Hibernate ORM is available than the one coming with a given WildFly release.
For that case the Hibernate ORM project provides a ZIP file containing the required modules to update a WildFly installation to newer versions.
The module ZIP file is available from SourceForge and BinTray, alike the ZIP/TAR.GZ distributions (TODO: Add link).
As of Hibernate ORM 5.1.1, a ZIP file for upgrading WildFly 10 to that Hibernate version (from 5.0.x) is provided.
The general goal is to provide a ZIP file for bringing new versions of Hibernate ORM to the WildFly version current at the time of the Hibernate release.
For that case the Hibernate ORM project provides ZIP files containing the required modules to update a WildFly installation to newer versions of Hibernate when they are released.
Our goal is to provide a module ZIP file targeted at the WildFly version current at the time of the Hibernate release (e.g. WildFly 10 for Hibernate 5.1.x and 5.2.x).
The module ZIP files are available from https://sourceforge.net/projects/hibernate/files/hibernate-orm/[SourceForge] and https://bintray.com/hibernate/bundles/hibernate-orm[BinTray], alike the full ZIP/TAR.GZ distributions.

Once downloaded, extract the contents of the ZIP file into the _modules_ directory of your WildFly installation
(shut down the application server before, should it be running).
Note that the Hibernate ORM modules coming with WildFly will remain untouched,
i.e. you can switch between the original version and the new version from the ZIP file as needed as a matter of configuration.

The module system of the application server uses what's called "slots" to differentiate between several versions of one module.
By default, slot "main" of the Hibernate ORM modules will be used to provide JPA support for given deployments (representing the Hibernate version coming with WildFly itself).
In order to use another slot, specify the following two property in the _persistence.xml_ file of your application:
The module system of the application server identifies modules using a name and a version.
By default, the module _org.hibernate:main_ will be used to provide JPA support for given deployments (_main_ representing the Hibernate version coming with WildFly itself).
In order to use another version specify the identifier of the Hibernate ORM module to use via the following property in the _persistence.xml_ file of your application:

[[wildfly-using-custom-hibernate-orm-version]]
.Using a specific version of Hibernate ORM
Expand Down Expand Up @@ -51,4 +50,4 @@ That way you can update your WildFly server with further micro updates of the sa
without having to adapt your _persistence.xml_ upon each micro update.
Note that you can have several micro updates of the same release family next to each other within a WildFly instance
and switch between them by means of the properties shown above.
If you are specifying just the minor version as module slot, the modules from the ZIP file you unpacked last will be used.
If you are specifying just the minor version, the modules from the ZIP file you unpacked last will be used.

0 comments on commit 94389ee

Please sign in to comment.