| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <title>Apache MyFaces Trinidad - Initial Setup Guide</title> |
| <meta http-equiv="Content-Style-Type" content="text/css" /> |
| <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
| <link rel="stylesheet" href="../../../book.css" type="text/css"/> |
| </head> |
| <body> |
| <table summary="" cellspacing="0" cellpadding="0" width="100%"> |
| <tr valign="bottom"> |
| <td align="left" width="86%"> |
| <h1>Apache MyFaces Trinidad - Initial Setup Guide</h1> |
| </td> |
| </tr> |
| </table> |
| <hr/> |
| |
| <h2>Overview</h2> |
| This guide intends to aid with the initial setup of a dynamic web application to make use of the <a href="http://myfaces.apache.org/trinidad/index.html">Apache MyFaces Trinidad</a> ("Trinidad") JSF library. |
| While the goal is that this serves as sufficient information to guide the user through initial setup, the Trinidad website should always be considered as the source of complete and current information. |
| This guide is intended for setup of Trinidad for use with the Eclipse Web Tools Platform ("WTP") more than as a general Trinidad setup guide (although the core concepts may not be specific to WTP). |
| |
| <h2>Dynamic Web Project Setup</h2> |
| |
| <h3>JSF Library Configuration</h3> |
| As with all frameworks, Trinidad requires certain libraries to be on the classpath. |
| Some libraries <i>may</i> be provided by the server runtime (for example, a JEE5 server runtime will likely provide a JSF 1.2 implementation and JSTL 1.2). |
| When required libraries are not provided by the server runtime, it is recommended that they be added as one or more JSF Libraries (please refer to <a href="../../tasks/jsf_libs.html">Creating and Updating JSF Libraries</a>).<br/> |
| <br/> |
| The following image demonstrates one approach to setting up required libraries - relevant JSF libraries and their typical Java libraries ("JARs") are outlined in red, JSF Library names and JAR filesystem locations are arbitrary:<br/> |
| <br/> |
| <img src="images/trinidad_initialsetupguide_JSFLibs.png" alt="Example of JSF Libraries"/> |
| <h6 class="CaptionFigColumn">Example of JSF Libraries</h6> |
| <p class="Note"><b>NOTE:</b> The image above shows libraries typically required for a recent version of Trinidad for JSF 1.2 - other versions may have different requirements. Please consult online resources at the <a href="http://myfaces.apache.org/trinidad/index.html">Apache MyFaces Trinidad</a> website for complete and current information.</p> |
| |
| <h3>Dynamic Web Project Configuration</h3> |
| When creating a Dynamic Web Project, specify the use of the <i>JavaServer Faces (v1.1 or v1.2, depending on requirements) Project</i> "Configuration", as shown below:<br/> |
| <br/> |
| <img src="images/trinidad_initialsetupguide_Configuration.png" alt="JavaServer Faces v1.2 Project"/> |
| <h6 class="CaptionFigColumn">JavaServer Faces v1.2 Project</h6> |
| Proceed through the wizard until reaching the <em class="UILabel">JSF Capabilities</em> page. On this page, select the required JSF Libraries as previously created, as shown below:<br/> |
| <br/> |
| <img src="images/trinidad_initialsetupguide_JSFCapabilities.png" alt="JSF Capabilities"/> |
| <h6 class="CaptionFigColumn">JSF Capabilities</h6> |
| <p class="Note"><b>NOTE:</b> If JSF Libraries were created with different names than shown above, the available library names may differ.</p> |
| Complete the wizard to create the Dynamic Web Project. |
| |
| <h2>Web Application Descriptor Additions</h2> |
| Some additions to the web application's descriptor (.../WEB-INF/web.xml) are required, and some additions are optional. |
| <p class="Note"><b>NOTE:</b> Please consult online resources at the <a href="http://myfaces.apache.org/trinidad/index.html">Apache MyFaces Trinidad</a> website for complete and current information.</p> |
| |
| <h3>Required Additions</h3> |
| The following additions need to be made to the web application's descriptor to configure Trinidad's resource servlet (which serves stylesheets, scripts, and images at runtime): |
| <p class="Code"><pre> <servlet> |
| <servlet-name>resources</servlet-name> |
| <servlet-class>org.apache.myfaces.trinidad.webapp.ResourceServlet</servlet-class> |
| </servlet> |
| |
| <servlet-mapping> |
| <servlet-name>resources</servlet-name> |
| <url-pattern>/adf/*</url-pattern> |
| </servlet-mapping></pre></p> |
| The following additions need to be made to the web application's descriptor to configure Trinidad's filter: |
| <p class="Code"><pre> <filter> |
| <filter-name>trinidad</filter-name> |
| <filter-class>org.apache.myfaces.trinidad.webapp.TrinidadFilter</filter-class> |
| </filter> |
| |
| <filter-mapping> |
| <filter-name>trinidad</filter-name> |
| <servlet-name>faces</servlet-name> |
| </filter-mapping></pre></p> |
| <p class="Note"><b>NOTE:</b> The <b>filter-mapping</b> shown above assumes that the standard JSF servlet's <b>servlet-name</b> is specified as "faces" - this may differ depending on user setup, and so should be specified appropriately.</p> |
| |
| <h3>Optional Additions</h3> |
| The following additions to the web application's descriptor are optional, depending on your specific application's requirements: |
| <p class="Code"><pre> <context-param> |
| <param-name>javax.faces.STATE_SAVING_METHOD</param-name> |
| <param-value>client</param-value> |
| </context-param> |
| |
| <context-param> |
| <param-name>javax.faces.DEFAULT_SUFFIX</param-name> |
| <param-value>.jspx</param-value> |
| </context-param> |
| |
| <context-param> |
| <param-name>org.apache.myfaces.trinidad.USE_APPLICATION_VIEW_CACHE</param-name> |
| <param-value>false</param-value> |
| </context-param> |
| |
| <context-param> |
| <param-name>org.apache.myfaces.trinidad.CHECK_FILE_MODIFICATION</param-name> |
| <param-value>false</param-value> |
| </context-param> |
| |
| <context-param> |
| <param-name>org.apache.myfaces.trinidad.CHANGE_PERSISTENCE</param-name> |
| <param-value>session</param-value> |
| </context-param> |
| |
| <context-param> |
| <param-name>org.apache.myfaces.trinidad.resource.DEBUG</param-name> |
| <param-value>false</param-value> |
| </context-param></pre></p> |
| |
| <p class="Note"><b>NOTE:</b> Some of these optional additions are Trinidad-specific, and some are not.</p> |
| |
| <h2>JSF Application Configuration Resource Additions</h2> |
| An addition to the JSF application configuration resource (typically .../WEB-INF/faces-config.xml) is required. |
| <p class="Note"><b>NOTE:</b> Please consult online resources at the <a href="http://myfaces.apache.org/trinidad/index.html">Apache MyFaces Trinidad</a> website for complete and current information.</p> |
| |
| <h3>Required Addition</h3> |
| The following addition needs to be made to the JSF application configuration resource to configure Trinidad's core RenderKit: |
| <p class="Code"><pre> <application> |
| <default-render-kit-id>org.apache.myfaces.trinidad.core</default-render-kit-id> |
| </application></pre></p> |
| |
| </body> |
| </html> |
