Richfaces 4 quick tutorial

Important notice: Richfaces framework reached End of Life in 2016. Therefore, you cannot expect fixes or enhancements unless you fork the project and upgrade yourself the framework.
We recommend reading these guidelines, if you want to modernize your Richfaces application: How to migrate Richfaces Web applications to another Web UI

The RichFaces project is an advanced UI component framework for creating advanced JSF application leveraging rich component features and Ajax capabilities. Let’s see how to get started with the RichFaces release 4.

At first download the final release 4.X.X of Richfaces framework from here.

The distribution when unpacked contains the following folders:

folderarchetypes Can be used to create a basic Richfaces application generated with  Maven
artifacts Contains Richfaces libraries
docs Contains the JavaDocs for Richfaces
examples Contains the Richfaces core demo suite

Creating your first Richfaces 4 application

In order to create a Richfaces application you have several option: you can either use Maven for picking up the correct libraries or manually configure your web application libs.

Using Maven to pick up Richfaces libs

For Maven-based projects configure you can simply add to your pom.xml Richfaces dependencies:


Refer to JBoss’s Maven Guide here for further details about JBoss’s Maven repository

Configuring manually your Richfaces libs

If you want to configure manually Richfaces libraries in your project, you have to add to following jars in your WEB-INF/lib:

Library Where to find it
archiverichfaces-core-impl-4.0.0.Final.jar Richfaces core distribution
archiverichfaces-core-api-4.0.0.Final.jar Richfaces core distribution
archiverichfaces-components-ui-4.0.0.Final.jar Richfaces core distribution
archiverichfaces-components-api-4.0.0.Final.jar Richfaces core distribution
archivesac-1.3.jar Third-party lib. Get it here
archivecssparser-0.9.5.jar Third-party lib. Get it here
archiveguava-r08.jar Third-party lib. Get it here

The last step is configuring your web.xml to map your URL pattern with the Faces Servlet and a bare bone faces-config.xml which states you are using JSF 2.0 specification.

Here’s WEB-INF/web.xml

<?xml version="1.0" encoding="ASCII"?>
<web-app xmlns:xsi="" xmlns=""
    xmlns:web="" xsi:schemaLocation="" version="3.0">
        <servlet-name>Faces Servlet</servlet-name>
        <servlet-name>Faces Servlet</servlet-name>

And your WEB-INF/faces-config.xml

<?xml version="1.0" encoding="UTF-8"?>




Coding your first RichFaces page

Ok. Now we’re ready to test that your set up was correct. Add a simple test.xhtml page to your web root:

<ui:composition xmlns=""

    <rich:panel header="Richfaces running on JBoss AS 7">

        <li>RichFaces is a component library for JSF</li>
        <li>easily integrating AJAX capabilities.</li>


Notice the ui:composition tag which points out the name space definitions for JSF and Richfaces tags.

We will see if JBoss AS 7 (Beta2) can digest Richfaces stuff. Export your application in a sample.war archive and place it under the deployments folder of the standalone server.

If you deploy a packaged archive it will be automatically deployed by JBoss 7. Expanded directories would require a xxx.war.dodeploy empty file in the deployments folder.

Request your page with http://localhost:8080/sample/test.jsf

This would produce the following not-so-rich HelloWorld page:

richfaces 4 tutorial

Besides this simple stuff, you can extend your JSF 2 capabilities with lots of new features, including a full set of Ajax enabled components, the new client-side validation expanding the JSR 303 bean validation, Push components and Advanced queueing.

Following here is a sample demo which contains JSR 303 Bean validation on the Name field and auto-field completion on the State field:

<ui:composition xmlns=""


 <rich:panel header="Richfaces sample validation and auto-completion">
     <h:outputText value="Enter your name" />
     <h:inputText id="name" value="#{}">
        <rich:validator />

     <rich:message for="name" />
     <br />

     <h:outputText value="Enter your state" />
     <rich:autocomplete value="#{userBean.state}" minChars="1" autocompleteMethod="#{userBean.autocomplete}" />



The ManagedBean UserBean contains the method autocomplete which has the ArrayList of suggestions for the “state” field. It contains also the “name” field which has a validation expression coded on it:

public class UserBean {

    public List<String> autocomplete(String prefix) {

        ArrayList<String> result = new ArrayList<String>();

        return result;

    @Size(min=3, max=12,message="Must be between 3 and 12 chars")
    private String name;

    private String state;

    public String getState() {
        return state;

    public String getName() {
        return name;


When requested, the sample page would produce for the field name:

richfaces 4 tutorial

And for the state field:

richfaces 4 tutorial