JSF2 + Primefaces3 + Spring3 & Hibernate4 Integration Project
This article shows how to integrate JSF2, PrimeFaces3, Spring3 and Hibernate4 Technologies. It provides a general project template for Java developers.
Also if Spring is not used for Business and Data Access layer, [url="http://www.onlinetechvision.com/?p=332"]JSF –PrimeFaces & Hibernate Integration Project[/url] can be offered.
Used Technologies :
JDK 1.6.0_31
Spring 3.1.1
JSF 2.1
Hibernate 4.1.0
Primefaces 3.1.1
MySQL Connector 5.1.17
MySQL 5.5.8
c3p0 0.9.1.2
Tomcat 7.0
Maven 3.0.2
STEP 1 : CREATE MAVEN PROJECT
A maven project is created as below. (It can be created by using Maven or IDE Plug-in).
[img]http://dl.iteye.com/upload/attachment/0077/4582/f9601065-8fdd-3922-b398-0cdde0024e6c.png[/img]
STEP 2 : CREATE USER TABLE
A new USER Table is created by executing below script:
STEP 3 : LIBRARIES
Spring, JSF, Hibernate, Primefaces, MySQL and c3p0 dependencies are added to Maven’ s pom.xml.
STEP 4 : CREATE USER MODEL CLASS
A new User Model Class is created.
STEP 5 : CREATE USER MANAGED BEAN CLASS
User Managed Bean is created.
STEP 6 : CREATE IUserDAO INTERFACE
IUserDAO Interface provides methods of Data Access Layer. The data access layer manages all the logic to persist and retrieve the data from database.
STEP 7 : CREATE UserDAO CLASS
UserDAO Class is created by implementing IUserDAO Interface.
STEP 8 : CREATE IUserService INTERFACE
IUserService Interface provides methods to process the business logic.
STEP 9 : CREATE UserService CLASS
UserService Class is created by implementing IUserService Interface.
STEP 10 : CREATE applicationContext.xml
Spring Application Context’ s content is shown as follows :
STEP 11 : CREATE faces-config.xml
JSF Configuration is shown as follows :
STEP 12 : CREATE web.xml
web.xml is configured as follows :
STEP 13 : CREATE index.xhtml
index.xhtml is created as follows :
[img]http://dl.iteye.com/upload/attachment/0077/4584/5d24ef18-d07b-35e8-a954-bf9e4b3f4160.png[/img]
STEP 14 : CREATE success.xhtml
success.xhtml is created as follows :
[img]http://dl.iteye.com/upload/attachment/0077/4586/dd2cd1fd-816c-305b-ac18-a6df9820a5b7.png[/img]
STEP 15 : CREATE error.xhtml
error.xhtml is created as follows :
STEP 16 : DEPLOY PROJECT
After OTV_JSF_Spring_Hibernate Project is deployed to Tomcat, index page can be opened via following URL :
http://ip:port/OTV_JSF_Spring_Hibernate_Project-1.0-SNAPSHOT/pages/index.jsf
REFERENCES :
[url="http://static.springsource.org/spring/docs/3.1.x/spring-framework-reference/html/"]Spring Framework Reference 3.1.x Documentation[/url]
[url="http://www.hibernate.org/docs"]Hibernate 4.x Documentation[/url]
[url="http://primefaces.org/documentation.html"]Primefaces 3.x Documentation[/url]
From:[url]http://www.onlinetechvision.com/?p=566[/url]
Also if Spring is not used for Business and Data Access layer, [url="http://www.onlinetechvision.com/?p=332"]JSF –PrimeFaces & Hibernate Integration Project[/url] can be offered.
Used Technologies :
JDK 1.6.0_31
Spring 3.1.1
JSF 2.1
Hibernate 4.1.0
Primefaces 3.1.1
MySQL Connector 5.1.17
MySQL 5.5.8
c3p0 0.9.1.2
Tomcat 7.0
Maven 3.0.2
STEP 1 : CREATE MAVEN PROJECT
A maven project is created as below. (It can be created by using Maven or IDE Plug-in).
[img]http://dl.iteye.com/upload/attachment/0077/4582/f9601065-8fdd-3922-b398-0cdde0024e6c.png[/img]
STEP 2 : CREATE USER TABLE
A new USER Table is created by executing below script:
CREATE TABLE USER (
id int(11) NOT NULL,
name varchar(45) NOT NULL,
surname varchar(45) NOT NULL,
PRIMARY KEY (`id`)
);
STEP 3 : LIBRARIES
Spring, JSF, Hibernate, Primefaces, MySQL and c3p0 dependencies are added to Maven’ s pom.xml.
3.1.1.RELEASE
org.springframework
spring-core
${spring.version}
org.springframework
spring-context
${spring.version}
org.springframework
spring-web
${spring.version}
org.springframework
spring-tx
${spring.version}
org.springframework
spring-orm
${spring.version}
org.springframework
spring-test
${spring.version}
com.sun.faces
jsf-api
2.1.6
com.sun.faces
jsf-impl
2.1.6
javax.servlet
jstl
1.2
org.primefaces
primefaces
3.1.1
org.hibernate
hibernate-core
4.1.0.Final
javassist
javassist
3.12.1.GA
mysql
mysql-connector-java
5.1.17
c3p0
c3p0
0.9.1.2
STEP 4 : CREATE USER MODEL CLASS
A new User Model Class is created.
package com.otv.model;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.Table;
/**
*
*User Entity
*@author onlinetechvision.com
*@since 25 Mar 2012
*@version 1.0.0
*
*/
@Entity@Table(name="USER")
public class User {
private int id;
private String name;
private String surname;
/**
* Get User Id
*
* @return int - User Id
*/
@Id
@Column(name="ID", unique = true, nullable = false)
public int getId() {
return id;
}
/**
* Set User Id
*
* @param int - User Id
*/
public void setId(int id) {
this.id = id;
}
/**
* Get User Name
*
* @return String - User Name
*/
@Column(name="NAME", unique = true, nullable = false)
public String getName() {
return name;
}
/**
* Set User Name
*
*@param String - User Name
*/
public void setName(String name) {
this.name = name;
}
/**
* Get User Surname
*
* @return String - User Surname
*/
@Column(name="SURNAME", unique = true, nullable = false)
public String getSurname() {
return surname;
}
/**
* Set User Surname
*
* @param String - User Surname
*/
public void setSurname(String surname) {
this.surname = surname;
}
@Override
public String toString() {
StringBuffer strBuff = new StringBuffer();
strBuff.append("id : ").append(getId());
strBuff.append(", name : ").append(getName());
strBuff.append(", surname : ").append(getSurname());
return strBuff.toString();
}
}
STEP 5 : CREATE USER MANAGED BEAN CLASS
User Managed Bean is created.
package com.otv.managed.bean;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import javax.faces.bean.ManagedBean;
import javax.faces.bean.ManagedProperty;
import javax.faces.bean.RequestScoped;
import org.springframework.dao.DataAccessException;
import com.otv.model.User;
import com.otv.user.service.IUserService;
/**
*
* User Managed Bean
*
* @author onlinetechvision.com
* @since 25 Mar 2012
* @version 1.0.0
*
*/
@ManagedBean(name="userMB")
@RequestScoped
public class UserManagedBean implements Serializable {
private static final long serialVersionUID = 1L;
private static final String SUCCESS = "success";
private static final String ERROR = "error";
//Spring User Service is injected...
@ManagedProperty(value="#{UserService}")
IUserService userService;
List userList;
private int id;
private String name;
private String surname;
/**
* Add User
*
* @return String - Response Message
*/
public String addUser() {
try {
User user = new User();
user.setId(getId());
user.setName(getName());
user.setSurname(getSurname());
getUserService().addUser(user);
return SUCCESS;
}catch (DataAccessException e) {
e.printStackTrace();
}
return ERROR;
}
/**
* Reset Fields
*
*/
public void reset() {
this.setId(0);
this.setName("");
this.setSurname("");
}
/**
* Get User List
*
* @return List - User List
*/
public List getUserList() {
userList = new ArrayList();
userList.addAll(getUserService().getUsers());
return userList;
}
/**
* Get User Service
*
* @return IUserService - User Service
*/
public IUserService getUserService() {
return userService;
}
/**
* Set User Service
*
* @param IUserService - User Service
*/
public void setUserService(IUserService userServic{
this.userService = userService;
}
/**
* Set User List
*
* @param List - User List
*/
public void setUserList(List userList) {
this.userList = userList;
}
/**
* Get User Id
*
* @return int - User Id
*/
public int getId() {
return id;
}
/**
* Set User Id
*
* @param int - User Id
*/
public void setId(int id) {
this.id = id;
}
/**
* Get User Name
*
* @return String - User Name
*/
public String getName() {
return name;
}
/**
* Set User Name
*
* @param String - User Name
*/
public void setName(String name) {
this.name = name;
}
/**
* Get User Surname
*
* @return String - User Surname
*/
public String getSurname() {
return surname;
}
/**
* Set User Surname
*
* @param String - User Surname
*/
public void setSurname(String surname) {
this.surname = surname;
}
}
STEP 6 : CREATE IUserDAO INTERFACE
IUserDAO Interface provides methods of Data Access Layer. The data access layer manages all the logic to persist and retrieve the data from database.
package com.otv.user.dao;
import java.util.List;
import com.otv.model.User;
/**
*
* User DAO Interface
*
* @author onlinetechvision.com
* @since 25 Mar 2012
* @version 1.0.0
*
*/
public interface IUserDAO {
/**
* Add User
*
* @param User user
*/
public void addUser(User user);
/**
* Update User
*
* @param User user
*/
public void updateUser(User user);
/**
* Delete User
*
* @param User user
*/
public void deleteUser(User user);
/**
* Get User
*
* @param int User Id
*/
public User getUserById(int id);
/**
* Get User List
*
*/
public List getUsers();}
STEP 7 : CREATE UserDAO CLASS
UserDAO Class is created by implementing IUserDAO Interface.
package com.otv.user.dao;
import java.util.List;
import com.otv.model.User;
import org.hibernate.SessionFactory;
/**
*
* User DAO
*
* @author onlinetechvision.com
* @since 25 Mar 2012
* @version 1.0.0
*
*/
public class UserDAO implements IUserDAO {
private SessionFactory sessionFactory;
/**
* Get Hibernate Session Factory
*
* @return SessionFactory - Hibernate Session Factory
*/
public SessionFactory getSessionFactory() {
return sessionFactory;
}
/**
* Set Hibernate Session Factory
*
* @param SessionFactory - Hibernate Session Factory
*/
public void setSessionFactory(SessionFactory sessionFactory) {
this.sessionFactory = sessionFactory;
}
/**
* Add User
*
* @param User user
*/
@Override
public void addUser(User user) {
getSessionFactory().getCurrentSession().save(user);
}
/**
* Delete User
*
* @param User user
*/
@Override
public void deleteUser(User user) {
getSessionFactory().getCurrentSession().delete(user);
}
/**
* Update User
*
* @param User user
*/
@Override
public void updateUser(User user) {
getSessionFactory().getCurrentSession().update(user);
}
/**
* Get User
*
* @param int User Id
* @return User
*/
@Override
public User getUserById(int id) {
List list = getSessionFactory().getCurrentSession().createQuery("from User where id=?").setParameter(0, id).list();
return (User)list.get(0);
}
/**
* Get User List
*
* @return List - User list
*/
@Override
public List getUsers() {
List list = getSessionFactory().getCurrentSession().createQuery("from User").list();
return list;
}
}
STEP 8 : CREATE IUserService INTERFACE
IUserService Interface provides methods to process the business logic.
package com.otv.user.service;
import java.util.List;
import com.otv.model.User;
/**
*
* User Service Interface
*
* @author onlinetechvision.com
* @since 25 Mar 2012
* @version 1.0.0
*
*/
public interface IUserService {
/**
* Add User
*
* @param User user
*/
public void addUser(User user);
/**
* Update User
*
* @param User user
*/
public void updateUser(User user);
/**
* Delete User
*
* @param User user
*/
public void deleteUser(User user);
/**
* Get User
*
* @param int User Id
*/
public User getUserById(int id);
/**
* Get User List
*
* @return List - User list
*/
public List getUsers();
}
STEP 9 : CREATE UserService CLASS
UserService Class is created by implementing IUserService Interface.
package com.otv.user.service;
import java.util.List;
import org.springframework.transaction.annotation.Transactional; import com.otv.model.User;import com.otv.user.dao.IUserDAO;
/**
*
* User Service
*
* @author onlinetechvision.com
* @since 25 Mar 2012
* @version 1.0.0
*
*/@Transactional(readOnly = true)
public class UserService implements IUserService {
// UserDAO is injected...
IUserDAO userDAO;
/**
* Add User
*
* @param User user
*/
@Transactional(readOnly = false)
@Override
public void addUser(User user) {
getUserDAO().addUser(user);
}
/**
* Delete User
*
* @param User user
*/
@Transactional(readOnly = false)
@Override
public void deleteUser(User user) {
getUserDAO().deleteUser(user);
}
/**
* Update User
*
* @param User user
*/
@Transactional(readOnly = false)
@Override
public void updateUser(User user) {
getUserDAO().updateUser(user);
}
/**
* Get User
*
* @param int User Id
*/
@Override
public User getUserById(int id) {
return getUserDAO().getUserById(id);
}
/**
* Get User List
*
*/
@Override
public List getUsers() {
return getUserDAO().getUsers();
}
/**
* Get User DAO
*
* @return IUserDAO - User DAO
*/
public IUserDAO getUserDAO() {
return userDAO;
}
/**
* Set User DAO
*
* @param IUserDAO - User DAO
*/
public void setUserDAO(IUserDAO userDAO) {
this.userDAO = userDAO;
}
}
STEP 10 : CREATE applicationContext.xml
Spring Application Context’ s content is shown as follows :
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd">
destroy-method="close">
class="org.springframework.orm.hibernate4.LocalSessionFactoryBean">
com.otv.model.User
org.hibernate.dialect.MySQLDialect
true
class="org.springframework.orm.hibernate4.HibernateTransactionManager">
STEP 11 : CREATE faces-config.xml
JSF Configuration is shown as follows :
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facesconfig_2_0.xsd"
version="2.0">
org.springframework.web.jsf.el.SpringBeanFacesELResolver
/pages/index.xhtml
success
/pages/success.xhtml
error
/pages/error.xhtml
STEP 12 : CREATE web.xml
web.xml is configured as follows :
xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
id="WebApp_ID" version="2.5">
OTV_JSF_PrimeFaces_Spring_Hibernate
contextConfigLocation
/WEB-INF/applicationContext.xml
org.springframework.web.context.ContextLoaderListener
org.springframework.web.context.request.RequestContextListener
javax.faces.PROJECT_STAGE
Development
/pages/index.xhtml
Faces Servlet
javax.faces.webapp.FacesServlet
1
Faces Servlet
*.jsf
Faces Servlet
*.faces
STEP 13 : CREATE index.xhtml
index.xhtml is created as follows :
[img]http://dl.iteye.com/upload/attachment/0077/4584/5d24ef18-d07b-35e8-a954-bf9e4b3f4160.png[/img]
xmlns:h="http://java.sun.com/jsf/html"
xmlns:f="http://java.sun.com/jsf/core"
xmlns:p="http://primefaces.org/ui">
Welcome to OTV_JSF_Spring_Hibernate_Project
action="#{userMB.addUser}" ajax="false" />
action="#{userMB.reset}" ajax="false" />
STEP 14 : CREATE success.xhtml
success.xhtml is created as follows :
[img]http://dl.iteye.com/upload/attachment/0077/4586/dd2cd1fd-816c-305b-ac18-a6df9820a5b7.png[/img]
xmlns:h="http://java.sun.com/jsf/html"
xmlns:f="http://java.sun.com/jsf/core"
xmlns:p="http://primefaces.org/ui">
Welcome to OTV_JSF_Spring_Hibernate_Project
style="width: 10%">
STEP 15 : CREATE error.xhtml
error.xhtml is created as follows :
xmlns:h="http://java.sun.com/jsf/html"
xmlns:f="http://java.sun.com/jsf/core"
xmlns:p="http://primefaces.org/ui">
Welcome to JSF_PrimeFaces_Spring_Hibernate Project
STEP 16 : DEPLOY PROJECT
After OTV_JSF_Spring_Hibernate Project is deployed to Tomcat, index page can be opened via following URL :
http://ip:port/OTV_JSF_Spring_Hibernate_Project-1.0-SNAPSHOT/pages/index.jsf
REFERENCES :
[url="http://static.springsource.org/spring/docs/3.1.x/spring-framework-reference/html/"]Spring Framework Reference 3.1.x Documentation[/url]
[url="http://www.hibernate.org/docs"]Hibernate 4.x Documentation[/url]
[url="http://primefaces.org/documentation.html"]Primefaces 3.x Documentation[/url]
From:[url]http://www.onlinetechvision.com/?p=566[/url]