Java Server Faces (JSF)
Integrating OpenCms with JavaServer Faces is possible. This articles lists all the work that has to be done to use JSF within OpenCms.
Contents |
Prerequisites
Before you start you have to decide on the software versions you want to use. On the Apache website there is a compatibility list for Apache's software stack (Tomcat, MyFaces).
The following combinations are known to work (please extend!):
| Java Runtime | OpenCms | Servlet Container/Application Server | JSF Implementation |
|---|---|---|---|
| 1.5 | 7.0.1 (WebApp 2.4) | Tomcat 6.0.14 | Sun RI 1.1_02 |
| 1.5 | 7.0.1 (WebApp 2.4) | Tomcat 5.5.23 | Sun RI 1.1_02 |
| 1.5 | 7.0.1 (WebApp 2.4) | Tomcat 5.5.23 | MyFaces 1.1.5 |
| 1.5 | 6.2.3 (WebApp 2.3) | Tomcat 6.0.14 | Sun RI 1.1_02 |
| 1.5 | 7.0.2 (WebApp 2.4) | Tomcat 6.0.14 | Sun RI 1.1_02 |
The following seem to NOT work:
- JSF 1.2 in general.
Integrating OpenCms and Java Server Faces
Copy JSF Libraries
First, get the JSF implementation of your choice. Unzip the distribution and search for the JAR files named jsf-api.jar and jsf-impl.jar (usually in the lib directory). Copy these two archives to WEB-INF/lib in your OpenCms installation directory.
Adapt Webapplication Descriptor
Next you have to configure the servlet mapping in WEB-INF/web.xml. Add the following sections:
<servlet>
<servlet-name>Faces Servlet</servlet-name>
<servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>Faces Servlet</servlet-name>
<url-pattern>/faces/*</url-pattern>
</servlet-mapping>
Note that it has been reported, that suffix-mapping (e.g, *.jsf) should work as well but I couldn't get it to work, so I used prefix mapping, i.e. "/faces/*", instead.
Create Faces Configuration
Next you can create a JSF configuration file in WEB-INF/faces-config.xml like this:
<?xml version="1.0"?>
<faces-config xmlns="http://java.sun.com/xml/ns/javaee"
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_1_2.xsd"
version="1.2">
<navigation-rule>
<from-view-id>/opencms/jsf-example.jsp</from-view-id>
<navigation-case>
<from-outcome>login</from-outcome>
<to-view-id>/opencms/jsf-example2.jsp</to-view-id>
</navigation-case>
</navigation-rule>
<managed-bean>
<managed-bean-name>user</managed-bean-name>
<managed-bean-class>com.corejsf.UserBean</managed-bean-class>
<managed-bean-scope>session</managed-bean-scope>
</managed-bean>
</faces-config>
Add Bean Classes
Add bean classes as you need them to WEB-INF/classes or in a JAR file, as you like.
Restart Servlet Container
Restart your servlet container.
Use your JSF pages with the correct URLs
Create you JSF pages and access them with the correct URLs. There is nothing special in creating JSF pages. Just go to OpenCms' workplace, click on "New", select "JSP" as the type for you new JSF page and insert your code.
When you want to access a JSF page use the base URL http://myhost:8080/opencms/faces/opencms/ with the path of the file in workplace appended. For example if you have a file jsf-example.jsp in your root-folder of the /sites/default site, access it via the URL http://myhost:8080/opencms/faces/opencms/jsf-example.jsp.
