Red Hat

Developer Materials

kitchensink-rf: Example Using Multiple Java EE 6 Technologies with RichFaces

What is it?

This is your project! It is a sample, deployable Maven 3 project to help you get your foot in the door developing with Java EE 6 on Red Hat JBoss Enterprise Application Platform 6.2 or later.

This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0 with RichFaces 4, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java.

This application builds on top of the standard JSF approach, by incorporating the RichFaces project to provide a set of components, allowing for a rich user experience. RichFaces builds on top of the JSF standard, and is a fully portable solution compatible with all JSF implementations.

The kitchensink quickstart is built using Vanilla JSF for its front end. With this kitchensink-rf quickstart, we build on top of the JSF user interface, augmenting it with RichFaces JSF components and capabilities. Some key points to make note of while running the application:

  • Ajax push: This application makes use of ajax push. When a member is created in one browser, the member list is updated in all open browsers.

    Try this yourself, by opening two different browsers, create a new member in one browser, and watch for the list to be updated in both browsers.

  • Ajax: All page updates are made with an ajax call, increasing the page responsiveness, and leading to a more native feeling application.

  • Client-side validation: By simply nesting a tag in the input elements, we wire them with RichFaces client-side validation capabilities. The inputs are validated locally using javascript, without requiring a round-trip to the server.

  • Popups: Click the view link next to a member in the member list to view a popup with the member details. To close the popup, click the "X" in the top right-hand corner, or click anywhere on the background mask.

  • Mobile support: view the application form a webkit powered browser on a mobile device to try out the mobile version of the application. Alternatively, view the mobile version on your desktop by navigating to the url: http://localhost:8080/jboss-kitchensink-rf/mobile/

System requirements

The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform (EAP) 6.1 or later with the Red Hat JBoss Web Framework Kit (WFK) 2.6.

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

Configure Maven

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

Start the JBoss EAP Server

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

     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 line and navigate to the root directory of this quickstart.
  3. Type this command to build and deploy the archive:

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

Access the application

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

Undeploy the Archive

  1. Make sure you have started the JBoss EAP server as described above.
  2. Open a command line 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 Arquillian Tests

This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.

NOTE: The following commands assume you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Run the Arquillian Tests for complete instructions and additional options.

  1. Make sure you have started the JBoss EAP server as described above.
  2. Open a command line and navigate to the root directory of this quickstart.
  3. Type the following command to run the test goal with the following profile activated:

     mvn clean test -Parq-jbossas-remote
    

Run the Arquillian Functional Tests

This quickstart provides Arquillian functional tests as well. They are located in the functional-tests/ subdirectory under the root directory of this quickstart. Functional tests verify that your application behaves correctly from the user's point of view. The tests open a browser instance, simulate clicking around the page as a normal user would do, and then close the browser instance.

To run these tests, you must build the main project as described above.

  1. Open a command line and navigate to the root directory of this quickstart.
  2. Build the quickstart WAR using the following command:

     mvn clean package
    
  3. Navigate to the functional-tests/ directory in this quickstart.
  4. If you have a running instance of the JBoss EAP server, as described above, run the remote tests by typing the following command:

     mvn clean verify -Parq-jbossas-remote
    
  5. If you prefer to run the functional tests using managed instance of the JBoss EAP server, meaning the tests will start the server for you, type fhe following command:

     mvn clean verify -Parq-jbossas-managed
    

Run the Quickstart in JBoss Developer Studio or Eclipse

You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts

Debug the Application

If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.

mvn dependency:sources
mvn dependency:resolve -Dclassifier=javadoc

Recent Changelog

  • May 29, 2014(Emil Cervenan):Squashed README files update. WFK 2.5 version replaced with 2.6
  • May 14, 2014(Marek Novotný):updated README.md info about WFK 2.6
  • Mar 27, 2014(Sande Gilda):WFK2 555 Replace JBOSS_HOME with EAP_HOME
  • Feb 24, 2014(Rafael Benevides):WFK2 391 Update richfaces Quickstarts with https github.com richfaces jdf quickstarts releases tag 4.3.5.Final
  • Feb 17, 2014(Sande Gilda):JDF 614 Update WFK version from 2.4 to 2.5
  • Feb 7, 2014(Sande Gilda):Fix violations in the richfaces quickstart README files
  • Nov 25, 2013(Oliver Kiss):Functional tests for helloworld kitchensink and RichFaces quickstarts
  • Oct 22, 2013(Sande Gilda):JDF 528 Fix broken links to documentation and other minor cleanup
  • Oct 2, 2013(Sande Gilda):JDF 503 Remove AS 7 references add versions general cleanup remove temp repo from settings
  • Oct 1, 2013(Rafael Benevides):Replaced Richfaces submodule by QSs on commit aa58dfb89ce845e7e133aa2a0fb6af621cc14d5d
Avg:
Your Rating:
×