Red Hat

Developer Materials

hibernate3: How to Use Hibernate 3 in an Application

What is it?

Note: Hibernate 3.x is not a supported configuration in Red Hat JBoss Enterprise Application Platform 6.1 or later.

The sole purpose of the hibernate3 quickstart is to help you understand the changes needed to move your application from Hibernate 3.x to Hibernate 4 in Red Hat JBoss Enterprise Application Platform. This quickstart has the same functionality as the hibernate4 quickstart but uses the Hibernate 3 libraries. Compare this quickstart to the hibernate4 quickstart to see the code and class differences between Hibernate 3 and Hibernate 4.

This quickstart, like the log4j quickstart, demonstrates how to define a module dependency. However, this quickstart goes beyond that and also demonstrates the following:

  • WAR creation - The Maven script and Maven WAR plugin create a WAR archive that includes ONLY the Hibernate 3.x binaries. To understand better how this is achieved, please refer to the pom.xml in the root directory of this quickstart. Additional information can be found in the http://maven.apache.org/plugins/maven-war-plugin documentation.
  • Module exclusion and inclusion - This example demonstrates how to control class loading using dependencies and exclusions in the jboss-deployment-structure.xml file. For more information about this file, see the Red Hat JBoss Enterprise Application Platform Documentation Development Guide.
  • Persistence configuration - Configuration is required to tell the container how to load JPA/Hibernate.

Note: This quickstart uses the H2 database included with Red Hat JBoss Enterprise Application Platform 6. 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!

Note: This quickstart uses a *-ds.xml datasource configuration file for convenience and ease of database configuration. These files are deprecated in JBoss EAP 6.4 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 Administration and 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 6.1 or later.

All you need to build this project is Java 6.0 (Java SDK 1.6) or later, Maven 3.0 or later.

Configure Maven

If you have not yet done so, you must Configure Maven before testing the quickstarts.

Use of EAP_HOME

In the following instructions, replace EAP_HOME with the actual path to your JBoss EAP 6 installation. The installation path is described in detail here: Use of EAP_HOME and JBOSS_HOME Variables.

Start the JBoss EAP Server

  1. Open a command prompt and navigate to the root of the JBoss EAP directory.
  2. The following shows the command line to start the server:

     For Linux:   EAP_HOME/bin/standalone.sh
     For Windows: EAP_HOME\bin\standalone.bat
    

Build and Deploy the Quickstart

NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Build and Deploy the Quickstarts for complete instructions and additional options.

  1. Make sure you have started the JBoss EAP server as described above.
  2. Open a command prompt and navigate to the root directory of this quickstart.
  3. Type this command to build and deploy the archive:

     mvn clean install jboss-as:deploy
    
  4. This will deploy target/jboss-hibernate3.war to the running instance of the server.

Note: You will see the following warnings in the server log.

These warnings are debugging messages that were fixed for Hibernate 4.x but not backported to Hibernate 3.x. You can ignore these warnings.

    WARN  [org.hibernate.cfg.AnnotationBinder] (ServerService Thread Pool -- 155) Package not found or wo package-info.java: org.jboss.as.quickstart.hibernate3.controller
    WARN  [org.hibernate.cfg.AnnotationBinder] (ServerService Thread Pool -- 155) Package not found or wo package-info.java: org.jboss.as.quickstart.hibernate3.model
    WARN  [org.hibernate.cfg.AnnotationBinder] (ServerService Thread Pool -- 155) Package not found or wo package-info.java: org.jboss.as.quickstart.hibernate3.data
    WARN  [org.hibernate.cfg.AnnotationBinder] (ServerService Thread Pool -- 155) Package not found or wo package-info.java: org.jboss.as.quickstart.hibernate3.util

These warnings result from Hibernate 3 calling private classes. As noted above, Hibernate 3 is not supported in JBoss EAP 6.1 or later. You can ignore these messages.

    WARN  [org.jboss.as.dependency.private] (MSC service thread 1-6) JBAS018567: Deployment "deployment.jboss-hibernate3.war" is using a private module ("org.apache.commons.collections:main") which may be changed or removed in future versions without notice.
    WARN  [org.jboss.as.dependency.unsupported] (MSC service thread 1-6) JBAS018568: Deployment "deployment.jboss-hibernate3.war" is using an unsupported module ("org.dom4j:main") which may be changed or removed in future versions without notice.
    WARN  [org.jboss.as.dependency.private] (MSC service thread 1-6) JBAS018567: Deployment "deployment.jboss-hibernate3.war" is using a private module ("org.antlr:main") which may be changed or removed in future versions without notice.
    WARN  [org.jboss.as.dependency.private] (MSC service thread 1-6) JBAS018567: Deployment "deployment.jboss-hibernate3.war" is using a private module ("asm.asm:main") which may be changed or removed in future versions without notice.
    WARN  [org.jboss.as.dependency.private] (MSC service thread 1-6) JBAS018567: Deployment "deployment.jboss-hibernate3.war" is using a private module ("org.javassist:main") which may be changed or removed in future versions without notice.

You will also see the following warning in the server log. You can ignore this warning.

  JBAS010489: -ds.xml file deployments are deprecated. Support may be removed in a future version.

Access the application

The application will be running at the following URL: http://localhost:8080/jboss-hibernate3/.

Undeploy the Archive

  1. Make sure you have started the JBoss EAP server as described above.
  2. Open a command prompt and navigate to the root directory of this quickstart.
  3. When you are finished testing, type this command to undeploy the archive:

     mvn jboss-as: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 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

When you import the hibernate3 quickstart into JBoss Developer Studio, you see the following JSF Faces Config Problem warnings:

    validator-class references to "org.jboss.as.quickstart.hibernate3.util.ValidateEmail" that does not extend javax.faces.validator.Validator
    validator-class references to "org.jboss.as.quickstart.hibernate3.util.ValidateMemberId" that does not extend javax.faces.validator.Validator
    validator-class references to "org.jboss.as.quickstart.hibernate3.util.ValidateName" that does not extend javax.faces.validator.Validator

This is a known JBoss Tools issue. See https://issues.jboss.org/browse/JBIDE-19403. Follow the steps below to resolve these warnings.

  1. Right-click on one of the warning messages in the JBoss Developer Studio Problems window and choose Quick Fix.
  2. This opens a window with the fix Configure Problem Severity for preference 'Invalid Validator Class' selected. Click Finish.
  3. This opens the Preferences dialog for the Faces Config –> Validator.
  4. Change the "Invalid validator class:" severity from Warning to Ignore and click OK.
  5. You are presented with a Validator Settings Changed dialog. Click Yes to do a full rebuild.
  6. All warnings should now be resolved.

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

Recent Changelog

  • Mar 6, 2015(Sande Gilda):Bz1178800 Add information about validator class warnings when importing hibernate3 into JBDS
  • Mar 4, 2015(Sande Gilda):Bz1198744 Update README JBDS instructions to be more clear
  • Feb 10, 2015(Sande Gilda):Bz1188379 Add warning about deprecated deployment files in server log
  • Feb 3, 2015(Sande Gilda):Bz1188379 Update warnings for H2 and use of ds.xml files
  • Feb 3, 2015(Sande Gilda):Update the quickstart README files to point to the new shared EAP_HOME and Build and Deploy instructions
  • Jan 22, 2015(Sande Gilda):Bz1185085 Update README files to use full product name for JBDS
  • Dec 18, 2014(Sande Gilda):Bz1092026 Update README Target Product metadata value remove Product Versions metadata and make sure the full product name is near the top of the files
  • Dec 18, 2014(Sande Gilda):Bz1175766 Add warning about H2 database to quickstarts where it is missing. Also update the message to use full product name
  • Nov 6, 2014(Sande Gilda):Bz1160776 prepare for google search and fix typos
  • Oct 30, 2014(Sande Gilda):Bz1158059 Replace instances of JDBS with JBDS in README and links
Avg:
Your Rating:
×