Red Hat

Developer Materials

helloworld-rf: Helloworld with a JSF Richfaces Front End

  • Author: Brian Leathem
  • Contributors: Sande Gilda, Matous Jobanek, Emil Cervenan, Marek Novotný, Rafael Benevides , Oliver Kiss
  • Published: Nov 12, 2014
  • Level: Beginner
  • Technologies:CDI, JSF, RichFaces
  • Target Product:WFK

What is it?

The helloworld-rf quickstart is based on the helloworld quickstart, but demonstrates how to create a Java EE 6 compliant application using JSF 2.1, CDI 1.0, and RichFaces 4.5.

In this example, a standard JSF h:inputText component is AJAX enabled using the RichFaces a4j:ajax tag. This triggers the application server to re-render only a subsection of the page on a browser event.

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.7.

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.

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/
     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-helloworld-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-helloworld-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 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

  • Nov 12, 2014(Sande Gilda):WFK2 784 Update versions of JSF and RichFaces plus remove redundant line from kitchensink rf
  • Nov 11, 2014(Sande Gilda):JDF 787 Modify README metadata to optimize for Google search
  • Nov 7, 2014(Matous Jobanek):updated versions of WFK and EAP in files
  • May 29, 2014(Emil Cervenan):Squashed README files update. WFK 2.5 version replaced with 2.6
  • May 14, 2014(Marek Novotný):updated 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 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
Your Rating: