UI-Component Sets
Project Documentation

Tutorial : Configuring MyFaces 2 to run on Google App Engine with Eclipse

Google App Engine support for MyFaces 2 made trunk and it is released with MyFaces Core 2.0.0-beta-3. In this tutorial, I will explain how to use it. I assume that you have basic Eclipse, JSF and Facelets knowledge.

You can find IDE-independent instructions here. Additionally, there is a tutorial for IntelliJ IDEA here.

Here is the complete source code and the Eclipse project of the example application (which I took from Facelets Tutorial) that I configured to run on Google App Engine.

I deployed the application explained in this tutorial to: http://myfaces2-tutorial.latest.aliok-com-tr-test.appspot.com/guess.jsf

In order to run Myfaces on Google App Engine, you need to complete the steps below. Configuration explained in this document is tested with Google App Engine 1.3.2.

Table of Content

    Setting up the environment

    1. Download Eclipse here, preferably IDE for JEE Developers.
    2. Install Google Eclipse Plugin with this guide.

    Creating the Project and Placing the Jars

    1. Create a Web Application Project (uncheck "Use Google Web Toolkit" if you won't use GWT)Creating the ProjectCreating the Project
    2. Download Myfaces Core here. We need "MyFaces Core 2.0.0-beta-3" or a later version. Extract files below and put them into war/WEB-INF/lib.
      • lib/myfaces-api-2.x.x.jar
      • lib/myfaces-impl-2.x.x.jar
      • lib/commons-logging-1.x.x.jar
      • lib/commons-beanutils-1.x.x.jar
      • lib/commons-codec-1.x.jar
      • lib/commons-collections-3.x.jar
      • lib/commons-digester-x.x.jar (I tested with version 1.8)
      • lib/commons-discovery-0.x.jar

        Here is the war/WEB-INF/lib so far:


        Please note that some jars (i.e. jdo2-api-2.3-eb.jar) are put by Google App Engine Eclipse plugin when the project is created.

    3. Download el-api and el-impl and put them into war/WEB-INF/lib. You can see the war/WEB-INF/lib so far below.war/WEB-INF/lib
    4. Add lines below into war/WEB-INF/web.xml.
           <web-app ...
                     We need to set annotation lifecycle provider manually as 
                     Other providers use some classes that are restricted on Google App Engine.    
                      Need to set a secret to avoid javax.crypto.BadPaddingException.
                      "param-value" must be Base64 encoded.
                      More details: http://wiki.apache.org/myfaces/Secure_Your_Application
                     Facelets configuration fragment
                    <servlet-name>Faces Servlet</servlet-name>
                    <servlet-name>Faces Servlet</servlet-name>
    5. Make sure that you use the JSF 2 header in your faces-config.
      <?xml version="1.0"  encoding="UTF-8"?>
      <faces-config xmlns="http://java.sun.com/xml/ns/javaee"
      xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facesconfig_2_0.xsd"
    6. Add the following line into war/WEB-INF/appengine-web.xml:
    7. Now you can add your stuff (pages, beans, etc.). You cannot use JSP as view technology on Google App Engine. You must use Facelets, which is the default view technology in JSF 2.

    Deploying to App Engine Development Server (Your Local Server)

    Right click on the project and select "Run As -> Web Application". This will start Google App Engine development server. You can see the port information on the console (default is 8888).

    Deployment to Local Development Server

    Deploying to Google App Engine

    1. Right-click on the project and select "Properties".
    2. Select "Google"->"App Engine".
    3. Select "Use Google App Engine" if not selected, and type your "Application ID". Press OK and close the dialog.Configuring the Google App Engine Project
    4. Right click on the project and select "Google" -> "Deploy to App Engine"
    5. Enter your account information, and the application will be deployed on your-app-id.appspot.com.Deployment to Google App Engine
    6. The URL for the application I deployed is : http://myfaces2-tutorial.latest.aliok-com-tr-test.appspot.com/guess.jsf