The hibernate
quickstart demonstrates how to use Hibernate ORM 5 API over JPA, using Hibernate-Core and Hibernate Bean Validation, and EJB.
What is it?
The hibernate
quickstart is based upon the kitchensink example, but demonstrates how to use Hibernate Object/Relational Mapping (ORM) 5 over JPA in Red Hat JBoss Enterprise Application Platform.
This project is setup to allow you to create a compliant Java EE 7 application using JSF, CDI, EJB, JPA , Hibernate-Core and Hibernate Bean Validation. It includes a persistence unit associated with Hibernate session and some sample persistence and transaction code to help you with database access in enterprise Java.
Considerations for Use in a Production Environment
- H2 Database
-
This quickstart uses the H2 database included with Red Hat JBoss Enterprise Application Platform 7.1. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment.
- Datasource Configuration File
-
This quickstart uses a
*-ds.xml
datasource configuration file for convenience and ease of database configuration. These files are deprecated in JBoss EAP and should not be used in a production environment. Instead, you should configure the datasource using the Management CLI or Management Console. Datasource configuration is documented in the Configuration Guide for Red Hat JBoss Enterprise Application Platform.
System Requirements
The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7.1 or later.
All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See Configure Maven to Build and Deploy the Quickstarts to make sure you are configured correctly for testing the quickstarts.
Use of EAP_HOME
In the following instructions, replace EAP_HOME
with the actual path to your JBoss EAP installation. The installation path is described in detail here: Use of EAP_HOME and JBOSS_HOME Variables.
Add the Correct Dependencies
JBoss EAP provides Hibernate 5 and JPA support.
If you use Hibernate 5 packaged within JBoss EAP, you will need to first import the JPA API.
This quickstart demonstrates usage of Hibernate Session and Hibernate Validators.
If you look at the pom.xml
file in the root of the hibernate quickstart directory, you will see that the dependencies for the Hibernate modules have been added with the scope as provided
.
For example:
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<scope>provided</scope>
<exclusions>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</exclusion>
</exclusions>
</dependency>
Start the JBoss EAP Standalone Server
-
Open a terminal and navigate to the root of the JBoss EAP directory.
-
Start the JBoss EAP server with the default profile by typing the following command.
$ EAP_HOME/bin/standalone.sh
NoteFor Windows, use the EAP_HOME\bin\standalone.bat
script.
Build and Deploy the Quickstart
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type the following command to build the artifacts.
$ mvn clean package wildfly:deploy
This deploys the hibernate/target/hibernate.war
to the running instance of the server.
You should see a message in the server log indicating that the archive deployed successfully.
Access the Application
The application will be running at the following URL: http://localhost:8080/hibernate/.
Server Log: Expected Warnings and Errors
You will see the following warnings in the server log. You can ignore these warnings.
WFLYJCA0091: -ds.xml file deployments are deprecated. Support may be removed in a future version. HHH000431: Unable to determine H2 database version, certain features may not work
Undeploy the Quickstart
When you are finished testing the quickstart, follow these steps to undeploy the archive.
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type this command to undeploy the archive:
$ mvn wildfly:undeploy
Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
You can also start the server and deploy the quickstarts or run the Arquillian tests in Red Hat JBoss Developer Studio or from Eclipse using JBoss tools. For general information about how to import a quickstart, add a JBoss EAP server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.
Deploy the Quickstart to OpenShift Online
Use these instructions to deploy the quickstart to Red Hat OpenShift Online. If you do not yet have an OpenShift Online account and are interested in signing up for one, see Choose a Plan in the OpenShift Online documentation located on the Red Hat Customer Portal. For information about running JBoss EAP on Red Hat OpenShift Online, see Getting Started with JBoss EAP for OpenShift Online, also located on the Red Hat Customer Portal.
Create and Deploy the Quickstart Project
Follow these instructions to deploy this quickstart to OpenShift Online.
-
Browse to OpenShift Online console and login with your credentials.
-
On the View All Projects or Welcome to Project page, click Create Project.
-
On the Create Project page, enter the following information:
Name: hibernate Display Name hibernate Description: hibernate
-
Click Create to create the project.
-
On the My Projects page, choose your new hibernate and click Browse Catalog.
-
Choose JBoss EAP CD (no https) and then click Next to view the Information page.
-
Click Next to navigate to the Configuration page. . . Enter the following information. You can leave the remaining fields as they are.
Add to Project: hibernate Application Name: hibernate Custom http Route Hostname: (leave blank) Git Repository URL: https://github.com/jboss-developer/jboss-eap-quickstarts/ Git Reference: openshift Context directory: hibernate
-
Click the Create button.
-
Click on the Continue to the project overview link.
-
You should see "Build #1 is running …" with the console log below.
Cloning ... Downloading ... Building ... Copying ... Pushing ...
-
At the end of the build, you should see "Push successful".
-
Click View Full Log to see the entire log.
-
-
Click the Overview tab to see the
hibernate
deployment. -
Click on the application URL on the right side of the page to view the running application. It should be in the following pattern:
http://APPLICATION_NAME-PROJECT_NAME.PORT.HOST.openshiftapps.com
Delete the Quickstart Project
Follow these instructions to delete the project from OpenShift Online.
-
Go to the View All Projects page and select Delete Project from the drop down list to the right of the hibernate project.
-
Type the name of the project to confirm, and then click Delete
Debug the Application
If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
$ mvn dependency:sources
Note
|
You might see the following message when you run the command. It indicates the source is not provided in the third-party
|