Richfaces Java EE 6 application

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

In this tutorial we will continue our training session by adding RichFaces libraries to our example Java EE 6 application. Richfaces is an advanced UI component framework for creating advanced JSF application leveraging rich component features and Ajax capabilities.

At first download the latest 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

Setting up your 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.

You can basically configure Richfaces libraries using two strategies:

  • Use Maven to compile/deploy your project. You can use it as well to generate a Richfaces project from a basic Archetype. This will be covered in another tutorial
  • Add manually Richfaces libraries and dependencies

In the next section we will show how to configure manually your libraries:

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.X.X.Final.jar Richfaces core distribution
archiverichfaces-core-api-4.X.X.Final.jar Richfaces core distribution
archiverichfaces-components-ui-4.X.X.Final.jar Richfaces core distribution
archiverichfaces-components-api-4.X.X.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-10.0.1.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"?>



Upgrading your web page

The changes required to your web page are, at first the namespace declaration under which Richfaces UI components will be executed. This boils down to adding this declaration at the top of your page:

<ui:composition xmlns=""

So this is your Web page engineered for Richfaces 4:

<ui:composition xmlns=""




            <rich:panel header="Richfaces sample"

                <h:outputText value="Enter key:" />
                <br />

                <rich:autocomplete value="#{manager.key}" minChars="1"
                    autocompleteMethod="#{manager.autoComplete}" />
                <br />
                <h:outputText value="Enter value:" />
                <br />
                <h:inputText value="#{manager.value}" />
                <br />
                <br />

                <h:commandButton actionListener="#{}"
                    styleClass="buttons" value="Save key/value" />
                <h:commandButton actionListener="#{manager.clear}"
                    styleClass="buttons" value="Clear cache" />

                <h:messages />


            <br />
            <rich:dataTable value="#{manager.cacheList}" var="item"
                styleClass="table" headerClass="table-header"
                    <f:facet name="header">Key</f:facet>
                    <h:outputText value="#{item.key}" />
                    <f:facet name="header">Value</f:facet>
                    <h:outputText value="#{item.value}" />


As for the other components of your application, we have added two small upgrades:

  1. The autoComplete, which is used to provide a taste of the auto-completion feature to your form:
  2. A size constraint on the “key” field.
package com.sample.bean;

import java.util.ArrayList;
import java.util.List;

import javax.ejb.EJB;
import javax.faces.bean.ManagedBean;
import javax.validation.constraints.Size;

import com.sample.ejb.SingletonBean;
import com.sample.model.Property;

public class PropertyManager {
    SingletonBean ejb;

    ArrayList  cacheList  = new ArrayList ();

    @Size(min=3, max=12,message="Key must be between 3 and 12 chars")
    private String key;
    private String value;

    public String getKey() {
        return key;

    public void setKey(String key) {
        this.key = key;

    public String getValue() {
        return value;

    public void setValue(String value) {
        this.value = value;

    public void save() {
        ejb.put(key, value);

    public void clear() {

    public List<Property> getCacheList() {
        return ejb.getCache();
    public List autoComplete(String prefix) {
        List list = new ArrayList();
        for (Property element: getCacheList()) {
        return list;


Request your page with http://localhost:8080/as7richsample/home.jsf

This would produce the following page (see autocomplete in action):

jboss richfaces tutorial

In case, you would insert an invalid key size, the message will prompt in the message area:

rochfaces 4 tutorial

Fine. You have completed another session of your Java EE 6 training.

You can download the code for this article from here