JBoss RichFaces with Spring

This article is going to show you how to build a RichFaces application with Spring. We are going to replace the standard JSF managed beans with Spring beans. We will first use an XML-based configuration approach and then switch to an annotations approach in Spring.

(Note - The Project Template for this article can be downloaded here)

If you want first to try RichFaces with standard JSF managed beans, no problem. Start with this article.

To make it possible to create the application in just under an hour, we are not going to persist any data into a database. To keep things simple, we will keep the data in memory. Of course it's not very difficult to add a persistence layer to this application. Spring provides many tools to do that.

Finally an article on how to use RichFaces with Spring Web Flow, is something that I'm saving for a future article.

What Are We Going to Build?

A pretty common request that I hear is how do you build a wizard in RichFaces. So, that's exactly what we are going to build. You come into a bar and on each table there is a screen via which you place an order. You click to start an order, a wizard is launched where you enter all the required information and place the order.  We will also have the ability to view all placed orders. Additionally, we will be able to change the look and feel of the ordering screen using RichFaces’ skinnability feature.

Note: All screen shots show a custom skin which you are going to create later.

 

JBoss RichFaces

JBoss RichFaces is a framework that consists of three main parts: AJAX (rich) enabled JSF components, skinnability, and CDK (Component Development Kit). RichFaces UI components are divided into two tag libraries a4j: and rich:. Both tag libraries offer out-of-the-box AJAX enabled JSF components. Skinnability enables you to skin a JSF application with default or custom skins (themes). Finally, the CDK is a facility for creating, generating and testing rich JSF components.

RichFaces is not a JSF implementation. RichFaces UI components are just extra AJAX JSF components that work with any JSF implementation (1.1, 1.2, 2.0), any view technology (Facelets, JSP), and are integrated with 3rd party components (MyFaces, Tomahawk, Trinidad, etc).

AttachmentSize
richfaces-spring-wizard.zip11.15 MB
0
Average: 4.5 (6 votes)

(Note: Opinions expressed in this article and its replies are the opinions of their respective authors and not those of DZone, Inc.)

Comments

Aleksandar Vidakovic replied on Mon, 2009/02/16 - 6:04pm

Salut Max,

interesting article. I've been experimenting with Richfaces and Spring for a while and would be extremely interested in the SpringWebflow integration...

Cheers,

Aleks

wismax replied on Tue, 2009/02/17 - 9:57am

Hello Max,

 

I'm trying to build my richbar application but when I click on the next button of the first wizard page, nothing happens. So I'd like to check your project but I can't find any link in your article. Where can I download your project files ?

Thanks !

 

Wis

Nitin Bharti replied on Tue, 2009/02/17 - 10:19am in response to: wismax

Hi Wis,

 I believe  you can download the project template from here -- http://drop.io/usoalrd

I will add this to the main article as well. Sorry about that.

Thanks,

Nitin

Gene De Lisa replied on Wed, 2009/02/25 - 9:08am

"In the “real” world, you would probably use Maven 2, but, to keep things simple and concentrate on RichFaces and Spring, we are going to use a ready-made project."

maven projects are "ready-made" and they don't have the disadvantages of the approach you have taken.

Other than that this is nothing more a mediocre do this do that tutorial.

Omar Palomino S... replied on Sun, 2009/03/08 - 10:28pm in response to: vidakovic

Hi Max and Aleksandar,

 I'm also interesting in Spring Webflow integration [navigation rules are cumbersome :s]. I have a couple of implementations with both RichFaces, Spring and Jpa, and it's fun and easy to develop this way. Webflow would be a nice addition to this project acthitecture.

taod replied on Fri, 2009/03/13 - 2:34pm

Excellent Article. In case someone want to try it through Maven. Hope the following dependecy setting will save you some time.

        <dependency>
            <groupId>org.richfaces.ui</groupId>
            <artifactId>richfaces-ui</artifactId>
            <version>3.3.0.GA</version>
            <scope>compile</scope>
        </dependency>
       
        <dependency>
            <groupId>org.richfaces.framework</groupId>
            <artifactId>richfaces-api</artifactId>
            <version>3.3.0.GA</version>
            <scope>compile</scope>
        </dependency>
       
        <dependency>
            <groupId>org.richfaces.framework</groupId>
            <artifactId>richfaces-impl</artifactId>
            <version>3.3.0.GA</version>
            <scope>compile</scope>
        </dependency>
       
        <dependency>
            <groupId>org.richfaces.samples</groupId>
            <artifactId>laguna</artifactId>
            <version>3.3.0.GA</version>
            <scope>compile</scope>
        </dependency>
       
        <dependency>
            <groupId>commons-beanutils</groupId>
            <artifactId>commons-beanutils</artifactId>
            <version>1.8.0</version>
            <scope>compile</scope>
        </dependency>
       
        <dependency>
            <groupId>commons-collections</groupId>
            <artifactId>commons-collections</artifactId>
            <version>3.2.1</version>
            <scope>compile</scope>
        </dependency>
       
        <dependency>
            <groupId>commons-digester</groupId>
            <artifactId>commons-digester</artifactId>
            <version>2.0</version>
            <scope>compile</scope>
        </dependency>
       
        <dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>1.1.1</version>
            <scope>compile</scope>
        </dependency> 

        <!-- JBoss RichFaces Repository -->
         <repository>
            <releases>
                <enabled>true</enabled>
             </releases>
             <snapshots>
                <enabled>false</enabled>
                <updatePolicy>never</updatePolicy>
             </snapshots>
             <id>repository.jboss.com</id>
             <name>Jboss Repository for Maven</name>
             <url>
                http://repository.jboss.com/maven2/
             </url>
             <layout>default</layout>
        </repository>   

maxkatz replied on Mon, 2009/03/16 - 10:53am in response to: taod

Thanks taod!

salemba replied on Tue, 2009/03/17 - 6:44pm

First, thanks for the great work :)

but

<cite> (Note - The Project Template for this article can be downloaded from http://drop.io/usoalrd) </cite>

 what is the pass for download ?

thanks in advance!

ander.santos replied on Wed, 2009/03/18 - 9:28am

Hi Buddy,

 

This article is just great, I have been looking for a steb by step like this one, for at least a month.

 

I just couldn't download the template for this project, could you please send it by e-mail to me, that link where you say to click for download is broken and the one in the first page os this article, I just couldn't use...

 

thanks,

Anderson

ander.dev@gmail.com

JeanChastain replied on Wed, 2009/03/18 - 4:27pm

I would like to download the code, too.  I've done everything you said to do and can't get it to deploy to JBoss and was wondering if you had some configuration you didn't tell us about.

samset replied on Sat, 2009/03/21 - 12:01pm in response to: JeanChastain

hi, it's been quite some time i am trying to make richfaces 3.3 work with spring 2.0 webflow. Can somebody tell me how to download the source code. I visited http://drop.io/usoalrd, it's asking for password. What am i suppose to enter there ?

or, can you send me through email ?

Appreciate your help!

 

 

aseem.monga replied on Tue, 2009/03/31 - 7:59am

A very good introduction. Can someone provide the password for downloading the project template?

juanjogoa24 replied on Wed, 2009/04/01 - 7:03pm

A very good ...could you please send it by e-mail to me  password

 

 thanks

 

juanjogoa24@gmail.com 

 

 

 

.  

 

 

maxkatz replied on Sat, 2009/04/11 - 11:47am

Link to download project template has been updated.

davutuysal replied on Fri, 2009/04/17 - 9:48am

Thanks Max. It was great article!

shan2856 replied on Sat, 2009/04/25 - 1:36am

Hi Max, I am going through your article as we speak. You writing is always so to-the-point. I like it very much. However the zip file is not working. Can you check if you get the opportunity? Shantanu

Donovan Makund replied on Sun, 2009/04/26 - 3:11pm in response to: maxkatz

The zip file cannot be extracted once downloaded.

shan2856 replied on Thu, 2009/04/30 - 1:57am

As Donovan has pointed out, the zip file can not be extracted once downloaded. Can anyone please send the proper template zip to shanroam@yahoo.com. I would be immensely greatful.

maxkatz replied on Tue, 2009/05/05 - 1:45pm

Let's try this file. Here is what you need to do:

Download the template

In Eclipse:

  1. Select File/Import/General/Existing Project into Workspase
  2. Click Next
  3. Check 'Select arhcive file' option and browse to downloaded file
  4. Follow the wizards steps

shan2856 replied on Thu, 2009/05/07 - 8:08am

I somehow cannot download the file from the link that Max provided in the last post. Any help would be greatly appreciated.

maxkatz replied on Tue, 2009/05/19 - 6:05pm in response to: shan2856

I'm not sure why the link is not working. Try this one: http://www.filedropper.com/richfaces-spring

Donovan Makund replied on Sat, 2009/06/06 - 11:48am

Hello Max, I was able to implement a prototype using Richfaces 3.3.1, Spring 2.5.5, JSF 1.2 with Spring managing all the beans. I am now trying to add Facelets 1.1.14 into the mix for template features. Have you tried this combination before?

maxkatz replied on Fri, 2009/06/12 - 11:18am in response to: dmakund

If you look in my template, I used Facelets. So yes, you can (and should) use Facelets.

atmohsin replied on Tue, 2009/06/16 - 2:30pm

Hi i am not able to run the application.Getting following exception javax.faces.FacesException: UIInclude component j_id10 could't include page with path at org.ajax4jsf.taglib.html.facelets.IncludeHandler.applyNextHandler(IncludeHandler.java:83) at com.sun.facelets.tag.jsf.ComponentHandler.apply(ComponentHandler.java:169) at com.sun.facelets.tag.jsf.ComponentHandler.applyNextHandler(ComponentHandler.java:314) at com.sun.facelets.tag.jsf.ComponentHandler.apply(ComponentHandler.java:169) at com.sun.facelets.tag.CompositeFaceletHandler.apply(CompositeFaceletHandler.java:47) at com.sun.facelets.tag.jsf.ComponentHandler.applyNextHandler(ComponentHandler.java Please help me Mohsin

martinhaas replied on Mon, 2009/06/22 - 5:50am

None of the links above is working. Another source where I can download the project? The linked project is corrupt and all other links in the comments are broken.

maxkatz replied on Mon, 2009/06/22 - 3:26pm in response to: atmohsin

Is this the full stack trace?

maxkatz replied on Mon, 2009/06/22 - 3:29pm in response to: martinhaas

Let's try one more time: http://drop.io/pnbhzls

stuba999 replied on Thu, 2009/07/16 - 10:26am

Hi Max,

Firstly thanks for this article it's good to have a straigthforward example of using these frameworks together.

 I do have a problem running this on a was 6.1 instance. (However I don't think this is the issue here). I've placed the code into an existing webb app project to prove the spring framework can run in an existing richfaces / facelets implementation

 My stack trace on requesting http://localhost:9080/MyProjectName/start.jsf is as follows

java.io.NotSerializableException: bar.service.OrderService
at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1113)
at java.io.ObjectOutputStream.defaultWriteFields(ObjectOutputStream.java:1467)
at java.io.ObjectOutputStream.writeSerialData(ObjectOutputStream.java:1439)
at java.io.ObjectOutputStream.writeOrdinaryObject(ObjectOutputStream.java:1382)
at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1111)
at java.io.ObjectOutputStream.writeObject(ObjectOutputStream.java:325)
at java.util.HashMap.writeObject(HashMap.java:1290)
at sun.reflect.GeneratedMethodAccessor13.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:618)
at java.io.ObjectStreamClass.invokeWriteObject(ObjectStreamClass.java:973)
at java.io.ObjectOutputStream.writeSerialData(ObjectOutputStream.java:1431)
at java.io.ObjectOutputStream.writeOrdinaryObject(ObjectOutputStream.java:1382)
at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1111)
at java.io.ObjectOutputStream.writeArray(ObjectOutputStream.java:1343)
at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1107)
at java.io.ObjectOutputStream.writeArray(ObjectOutputStream.java:1343)
at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1107)
at java.io.ObjectOutputStream.writeArray(ObjectOutputStream.java:1343)
at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1107)
at java.io.ObjectOutputStream.writeArray(ObjectOutputStream.java:1343)
at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1107)
at java.io.ObjectOutputStream.writeArray(ObjectOutputStream.java:1343)
at java.io.ObjectOutputStream.writeObject0(ObjectOutputStream.java:1107)
at java.io.ObjectOutputStream.writeObject(ObjectOutputStream.java:325)
at com.sun.faces.renderkit.ResponseStateManagerImpl.writeState(ResponseStateManagerImpl.java:269)
at javax.faces.render.ResponseStateManager.writeState(ResponseStateManager.java:166)
at org.ajax4jsf.application.AjaxStateManager.writeState(AjaxStateManager.java:294)
at org.ajax4jsf.application.AjaxStateManager.writeState(AjaxStateManager.java:256)
at com.sun.facelets.FaceletViewHandler.renderView(FaceletViewHandler.java:606)
at org.ajax4jsf.application.ViewHandlerWrapper.renderView(ViewHandlerWrapper.java:100)
at org.ajax4jsf.application.AjaxViewHandler.renderView(AjaxViewHandler.java:176)
at com.sun.faces.lifecycle.RenderResponsePhase.execute(RenderResponsePhase.java:110)
at com.sun.faces.lifecycle.Phase.doPhase(Phase.java:100)
at com.sun.faces.lifecycle.LifecycleImpl.render(LifecycleImpl.java:139)
at javax.faces.webapp.FacesServlet.service(FacesServlet.java:266)
at com.ibm.ws.webcontainer.servlet.ServletWrapper.service(ServletWrapper.java:1103)
at com.ibm.ws.webcontainer.servlet.ServletWrapper.service(ServletWrapper.java:1038)
at com.ibm.ws.webcontainer.filter.WebAppFilterChain.doFilter(WebAppFilterChain.java:145)
at org.ajax4jsf.webapp.BaseXMLFilter.doXmlFilter(BaseXMLFilter.java:178)
at org.ajax4jsf.webapp.BaseFilter.handleRequest(BaseFilter.java:290)
at org.ajax4jsf.webapp.BaseFilter.processUploadsAndHandleRequest(BaseFilter.java:390)
at org.ajax4jsf.webapp.BaseFilter.doFilter(BaseFilter.java:517)
at com.ibm.ws.webcontainer.filter.FilterInstanceWrapper.doFilter(FilterInstanceWrapper.java:190)
at com.ibm.ws.webcontainer.filter.WebAppFilterChain.doFilter(WebAppFilterChain.java:130)
at com.ibm.ws.webcontainer.filter.WebAppFilterChain._doFilter(WebAppFilterChain.java:87)
at com.ibm.ws.webcontainer.filter.WebAppFilterManager.doFilter(WebAppFilterManager.java:834)
at com.ibm.ws.webcontainer.filter.WebAppFilterManager.doFilter(WebAppFilterManager.java:682)
at com.ibm.ws.webcontainer.servlet.ServletWrapper.handleRequest(ServletWrapper.java:566)
at com.ibm.ws.wswebcontainer.servlet.ServletWrapper.handleRequest(ServletWrapper.java:486)
at com.ibm.ws.webcontainer.webapp.WebApp.handleRequest(WebApp.java:3440)
at com.ibm.ws.webcontainer.webapp.WebGroup.handleRequest(WebGroup.java:267)
at com.ibm.ws.webcontainer.WebContainer.handleRequest(WebContainer.java:815)
at com.ibm.ws.wswebcontainer.WebContainer.handleRequest(WebContainer.java:1461)
at com.ibm.ws.webcontainer.channel.WCChannelLink.ready(WCChannelLink.java:118)
at com.ibm.ws.http.channel.inbound.impl.HttpInboundLink.handleDiscrimination(HttpInboundLink.java:458)
at com.ibm.ws.http.channel.inbound.impl.HttpInboundLink.handleNewInformation(HttpInboundLink.java:387)
at com.ibm.ws.http.channel.inbound.impl.HttpInboundLink.ready(HttpInboundLink.java:267)
at com.ibm.ws.tcp.channel.impl.NewConnectionInitialReadCallback.sendToDiscriminators(NewConnectionInitialReadCallback.java:214)
at com.ibm.ws.tcp.channel.impl.NewConnectionInitialReadCallback.complete(NewConnectionInitialReadCallback.java:113)
at com.ibm.ws.tcp.channel.impl.AioReadCompletionListener.futureCompleted(AioReadCompletionListener.java:165)
at com.ibm.io.async.AbstractAsyncFuture.invokeCallback(AbstractAsyncFuture.java:217)
at com.ibm.io.async.AsyncChannelFuture.fireCompletionActions(AsyncChannelFuture.java:161)
at com.ibm.io.async.AsyncFuture.completed(AsyncFuture.java:136)
at com.ibm.io.async.ResultHandler.complete(ResultHandler.java:195)
at com.ibm.io.async.ResultHandler.runEventProcessingLoop(ResultHandler.java:743)
at com.ibm.io.async.ResultHandler$2.run(ResultHandler.java:873)
at com.ibm.ws.util.ThreadPool$Worker.run(ThreadPool.java:1473)

 

Do you have any idea why I'm getting a NotSerializeableException thrown when trying to instantiate this bean? (presumeably through Spring DI ?(I'm a newbie when it comes to jsf and spring))

Thanks 

Stuart

maxkatz replied on Thu, 2009/07/16 - 10:47am

Not sure why you get this exception, the server is trying to save/restore the class from somewhere. Try adding implements java.io.Serializable to the class.

stuba999 replied on Thu, 2009/07/16 - 11:00am in response to: maxkatz

Thanks Max.

 I thought that might (and did) do the trick.  As a newbie just wondered if the stack trace might shed any light on why the exception was throwing.

 

Keep the articles coming . Thanks again

 Stuart

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.