view page history | view next version >>
Using Window Scope Tutorial
WindowScoped is a custom scope added by ICEfaces 2.0 to JSF 2. The purpose of this scope is to fill the niche between ViewScoped and SessionScoped by providing a slightly longer object lifespan than ViewScoped, but without the overhead of SessionScoped.
This tutorial assumes the reader has an understanding of JSF and ICEfaces and creating and working with projects related to those technologies. The focus is not to teach those basics, but instead to learn more about WindowScoped.
The goal of this tutorial is to create a basic ICEfaces 2.0 project and examine the differences between View, Window, and Session scoped beans. The example will contain two basic pages that are navigated between, and some output information about our various scopes so we can see when a bean is created and destroyed.
Here is the entire list of steps worked through during this tutorial:
Development Tools Used
The following tools were used to create the project.
- Eclipse IDE for Java EE Developers - Version Helios
- Tomcat 7.x Web Server
- Java 6.x
- ICEfaces 2.0 Beta 2
1. Make the windowScope Project
- Using Eclipse create a new Dynamic Web Project called windowScope
- Target runtime: Apache Tomcat v7.0
- Dynamic web module version: 3.0
- Configuration: JavaServer Faces v2.0 Project (Mojarra)
2. Add ICEfaces
Add the icefaces.jar to your project from the ICEfaces 2 bundle. This can be added to the project through a custom User Library or by putting it into windowScope/WEB-INF/lib/. The approach doesn't matter as long as the jar is included in the deployed war file.
3. Create 3 Beans with Different Scopes
3a. Create ViewBean.java
Create a new Java class file called ViewBean in the package org.icefaces.tutorial.windowscope.beans and paste the code below:
package org.icefaces.tutorial.windowscope.beans; import java.io.Serializable; import java.sql.Timestamp; import javax.faces.bean.ManagedBean; import javax.faces.bean.ViewScoped; @ManagedBean(name="viewBean") @ViewScoped public class ViewBean implements Serializable { private Timestamp created; public ViewBean() { created = new Timestamp(System.currentTimeMillis()); } public Timestamp getCreated() { return created; } public void setCreated(Timestamp created) { this.created = created; } }
3b. Create SessionBean.java
Create a new Java class file called SessionBean in the package org.icefaces.tutorial.windowscope.beans and paste the code below:
package org.icefaces.tutorial.windowscope.beans; import java.io.Serializable; import java.sql.Timestamp; import javax.faces.bean.ManagedBean; import javax.faces.bean.SessionScoped; @ManagedBean(name="sessionBean") @SessionScoped public class SessionBean implements Serializable { private Timestamp created; public SessionBean() { created = new Timestamp(System.currentTimeMillis()); } public Timestamp getCreated() { return created; } public void setCreated(Timestamp created) { this.created = created; } }
3c. Create WindowBean.java
Create a new Java class file called WindowBean in the package org.icefaces.tutorial.windowscope.beans and paste the code below:
package org.icefaces.tutorial.windowscope.beans; import java.io.Serializable; import java.sql.Timestamp; import javax.faces.bean.CustomScoped; import javax.faces.bean.ManagedBean; @ManagedBean(name="windowBean") @CustomScoped(value = "#{window}") public class WindowBean implements Serializable { private Timestamp created; public WindowBean() { created = new Timestamp(System.currentTimeMillis()); } public Timestamp getCreated() { return created; } public void setCreated(Timestamp created) { this.created = created; } }