This tutorial illustrates the following aspects of JSF.
- Various UI components of JSF (Text box, Combo box, Select box, Radio button, submit button).
- Associating validations to UI components.
- Configuring navigation rules using eclipse wizard.
- Configuring JSF managed beans.
- Associating managed bean actions to events.
- Using JPA to persist the data captured in JSPs through managed beans.
The tutorial is divided into the following sections.
In order to develop, deploy and run the application, the following environment is required.
- Sun JDK 5.0+ (J2SE 1.5)
- Eclipse 126.96.36.199 (Eclipse Classic package of Europa distribution), which is platform specific
- Web Tools Platform (WTP) 2.0.1
- Data Tools Platform (DTP) 1.5.1
- Eclipse Modeling Framework (EMF) 2.3.1
- Graphical Editing Framework (GEF) 3.3.1
The entire application can be downloaded from this link.
Setting up the Eclipse environment
- Download Apache Geronimo and install it on the server. Look into Getting and installing Geronimo for instructions.
- Install the eclipse IDE and download geronimo eclipse plugin and install it on top of eclipse. Look into Installing Geronimo Eclipse Plugin for instructions.
- Create a runtime environment for Apache Geronimo in Eclipse. Look into Defining Geronimo server runtimes and servers for instructions to install a runtime for Apache Geronimo.
Creating WEB application with entities
This section is organized in the following steps:
Creating a dynamic Web project and defining JSF capabilities
- Start the eclipse wizard and right click on the Project Explorer and click on the New -> Dynamic Web Project
- Enter the project name as EmployeeWEB and click on the Next button.
- On the New Dynamic Web Project wizard, check on the Project Facet checkboxes and select the version values as below screen shot, and click on the Next button.
- On the Web Module wizard, make sure that Generate Deployment Descriptor is checked as below and click on the Next button.
- On the Geronimo Deployment Plan wizard, provide the moduleId values as below screen shot and click on the Next button.
- On the JSF Capabilities wizard, check the second radio button and click on the New button by the side of the combo box. This will open Create JSF Implementation Library wizard.
- Provide the Library Name as MyJSFLibrary and add the following jars by clicking on the Add button. Finally, click on the Finish button.
- Now, on the JSF Capabilities wizard, add the URL Mapping Patterns as *.jsf and click on the Finish button.
- This will create EmployeeWEB application in the Project Explorer as below screen shot.
- Right click on the WEB-INF folder and navigate to New -> Folder and create a folder by name tld as given in the screen shot below.
- Copy myfaces_core.tld and myfaces_html.tld files into the tld folder. These *.tld files are available in the myfaces-impl-1.2.6.jar file.
- We are going to use JPA to connect to EmployeeDB database created in the embedded Derby database. JPA uses persistence.xml file for configuration. Create a META-INF folder in the EmployeeWEB -> build -> classes folder in the Project Explorer. The contents of the persistence.xml are as follows.
Implementing persistence for the application
- Right click on the EmployeeWEB and navigate to New -> Class and create Employee.java as given in the below screen shot. Click on the Finish button after providing the values.
- The contents of the com.jpa.sample.Employee are as follows. This is the entity class used with JPA for persistence.
- Similarly, create sample.jsf.Employee. The contents of the class are as follows. This is the managed bean used by JSF.
Defining UI components
- Right click on the EmployeeWEB project and create index.jsp as follows.
The contents of the index.jsp are as follows.
- Similarly, create addEmployee.jsp and the contents are as follows.
- Similarly, create editEmployee.jsp and the contents are as follows.
- Similarly, create RetrieveEmployee.jsp and the contents are as follows.
- Open the geronimo-web.xml and replace the existing contents with the following contents. We explain the contents later when creating the datasource.
Configuring JSF managed beans and associating managed bean actions to events
- Click on the faces-config.xml to open Faces Configuration Editor.
- Click on the ManagedBean tab below and Click on the Add button. This will open New Managed Bean Wizard.
- Click on the Browse button and search for sample.jsf.Employee class and click on the OK button.
- Click on the Next button on the New Managed Bean Wizard. On the next screen, select Scope as request and click on the Next button.
- Click on the Next button and finally, click on the Finish button. This will bring up the following screen shot as below.
- Click on the Navigation Rule tab and move the mouse over Palette to bring it to the front.
- Click on the Page and move the mouse over main area and click once. This will bring up Select JSP File wizard. Select the index.jsp and click on the OK button.
- Similarly, add other JSPs also to the main area as follows.
- Bring the Palette to the front and click on the Link.
- Place the mouse on addEmployee.jsp on the main area and click once and move it to index.jsp and click once.
- Similarly, click the mouse over RetrieveEmployee.jsp and move the mouse to index.jsp and click once.
- Click the mouse over RtrieveEmployee.jsp and move the mouse over editEmployee.jsp and click once.
- Click the mouse over editEmployee.jsp and move the mouse over RetrieveEmployee.jsp and click once.
The above actions create navigation rules and look like the screen shot below.
- Press the escape button once and click on the link between addEmployee.jsp and index.jsp. On the Properties window at the bottom, go to the From Outcome textbox and provide the value as saveEmployee.
- Similarly, Click on the link between RetrieveEmployee.jsp and index.jsp, and on the Properties window at the bottom, go to the From Outcome textbox and provide the value as cancel.
- Similarly, Click on the link between RetrieveEmployee.jsp and editEmployee.jsp, and on the Properties window at the bottom, go to the From Outcome textbox and provide the value as retrieveEmployee.
- Similarly, Click on the link between editEmployee.jsp and RetrieveEmployee.jsp, and on the Properties window at the bottom, go to the From Outcome textbox and provide the value as saveEmployee.
- Click on Source to view the XML content generated out of these navigations rules and configuration. The contents should be as follows.
This finishes the WEB application creation and JSF configuration. Export the EmployeeWEB to a EmployeeWEB.war file.
Setting up the database tables and the Datasource
- Start the geronimo server and click on the Console Navigation -> Embedded DB -> DB manager. Enter EmployeeDB in the Create DB textbox as shown in the below screen shot and click on the Create button.
- Create the Employee table by entering the below SQL statement and clicking on the Run SQL button as shown in the below screen shot.
- Click on the Console Navigation -> Services -> Database Pools, and click on the Using the Geronimo database pool wizard link to create a new datasource.
- On the next screen, enter EmployeeDS in the Name of Database Pool textbox and select Derby embedded in the Database Type combo box. Click on the Next button.
- On the next screen, select the configuration in the Driver JAR select box and enter EmployeeDB in the Database Name textbox, and click on the Deploy button at the bottom.
- This will deploy the EmployeeDS database pool. The moduleId of the database pool is console.dbpool/EmployeeDS/1.0/rar which is declared as a dependency in the geronimo-web.xml. This is because, JPA uses this database source to persist entities.
Deploying the (war) application
Deploy the EmployeeWEB.war file using the command prompt as follows.
C:\Geronimo-2.1\bin>deploy.bat --user system --password manager deploy EmployeeWEB.war
Using GERONIMO_BASE: C:\Geronimo-2.1
Using GERONIMO_HOME: C:\Geronimo-2.1
Using GERONIMO_TMPDIR: var\temp
Using JRE_HOME: C:\SDK-May-31-2007\jre
Deployed EmployeeJSF/WEB/1.0/car @ /EmployeeWEB
Running the application
- Open a browser window and hit the URL http://localhost:8080/EmployeeWEB/. This will bring up the below screen.
- Click on the Add employee details link to get the below screen to add employees into the database. Just click on the Save button without entering any values. The JSF complains with validation errors as below.
- Enter the values as given in the screen below and click on the Save button. This will take back to the main page.
- Click on the Edit employee details link to get the below screen. Enter Employee No value as 10 and click on the Retrieve button.
- This will bring up the details of the employee whose employee number is 10. We can edit the values as required and click on the Save button.