• Dependencies
• Deliverables
• General Installation
• Demos
• Platform Information

Dependencies of ADF Faces include:

• Either JSF 1.1.01 reference implementation or MyFaces 1.0.8 or later, and their respective dependencies. Please note that ADF requires JSF 1.1, and cannot run on a server that only supports JSF 1.0.
• The ADF Share library (adfshare.jar)

The ADF Faces deliverables are:

• adf-faces-api.jar: public APIs of ADF Faces, all in the oracle.adf.view.faces package
• adf-faces-impl.jar: private APIs of ADF Faces, all in the oracle.adfinternal.view.faces package

Developers are strongly encouraged to compile against the API JAR only - this will ensure that you are only using public APIs. (Note that use of any APIs in oracle.adfinternal is entirely and permanently not supported.) JDK 1.4,which is a part of JDeveloper 9.0.5.2, is required to compile.

ADF Faces is designed to run on any J2EE-compliant application server. To install ADF Faces outside of a JDeveloper-based environment, take the following steps:

1. Install either JSF 1.1.01 reference implementation or MyFaces 1.0.8 or later, and their respective dependencies. Please consult your application server provider for documentation on this step.
2. Install the ADF Faces libraries and dependencies in WEB-INF/lib .
3. Register the ADF Faces filter in your WEB-INF/web.xml :

     <filter>
       <filter-name>adfFaces</filter-name>
       <filter-class>oracle.adf.view.faces.webapp.AdfFacesFilter</filter-class>
     </filter>
   
     <filter-mapping>
       <filter-name>adfFaces</filter-name>
       <!-- This assumes that the FacesServlet has been registered -->
       <!-- under the name "faces" -->
       <servlet-name>faces</servlet-name>
     </filter-mapping>
   
   

4. Tell JSF to use the ADF Faces RenderKit by adding the following to your faces-config.xml:

     <application>
       <default-render-kit-id>
         oracle.adf.core
       </default-render-kit-id>
     </application>
   
   

5. Register the ResourceServlet that would be used for serving the resources at runtime(images, javascripts and styles):

    <servlet>
     <servlet-name>resources</servlet-name>
     <servlet-class>oracle.adf.view.faces.webapp.ResourceServlet</servlet-class>
    </servlet>
   
   <servlet-mapping>
       <servlet-name>resources</servlet-name>
       <url-pattern>/adf/*</url-pattern>
   </servlet-mapping>
   
   

In addition, it is strongly recommended that you enable client-side state saving, again in WEB-INF/web.xml . ADF Faces offers a much improved version of client-side state saving that is a significant improvement over standard server-side state saving. State is still saved in the HttpSession , but a token is sent to the client to disambiguate instances of a page, and session-based state is serializable to support failover.

  <context-param>
    <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
    <param-value>client</param-value>
  </context-param>

The demos are available in adf-faces-demo.war.

One of the demos allows you to check email. If you are not running in a J2EE 1.3 (or higher) server you will need to add the jars listed below to adf-faces-demo/WEB-INF/lib. For example you will need to follow these steps if you are using Tomcat, but not if you are using OC4J or JDeveloper (in JDeveloper you do need to add the available J2EE library).

• JavaMail - go to download button for "Download JavaMail API Implementation Version 1.2 " and download 'javamail-1_2.zip'. Extract the jar:
  • mail.jar
• JavaBeans Activation Framework - go to the download button and download 'jaf-1_0_2-upd.zip'. Extract the jar:
  • activation.jar

To access the demos, start at index.jspx.

The following is not a list of officially supported platforms, rather this list is just to provide information about deploying the demo WAR on different platforms. The following setup information is all for Windows, but the release runs on any Java platform which meets the dependency requirements.

                     <servlet-mapping>
                       <servlet-name>jsp</servlet-name>
                       <url-pattern>*.jspx</url-pattern>
                     </servlet-mapping>
                 

Please see the FAQ for additional setup information.