Author: jbalunas(a)redhat.com Date: 2011-02-18 13:08:38 -0500 (Fri, 18 Feb 2011) New Revision: 21782 Modified: trunk/examples/richfaces-showcase/readme.txt Log: RF-10531 updated readme with encryption information Modified: trunk/examples/richfaces-showcase/readme.txt =================================================================== --- trunk/examples/richfaces-showcase/readme.txt 2011-02-18 18:06:24 UTC (rev 21781) +++ trunk/examples/richfaces-showcase/readme.txt 2011-02-18 18:08:38 UTC (rev 21782) @@ -1,11 +1,7 @@ -'richfaces-showcase' is an application intended to show RichFaces components in action. It contains set of small use-cases implemented using RichFaces components. -Except basic samples - use-cases for demo choosen from most popular questions at user forums - so you will be able to find much useful information there and will be able -just to re-use some code to implement the same cases for your applications. +RichFaces showcase is an application intended to show RichFaces components in action. It contains set of small use-cases implemented using RichFaces components. These use-cases for the demo are chosen from most popular questions on the user forums. You will be able to find a lot of useful information and will be able to re-use some of it to implement the same cases for your applications. - 1 Building and Running the application - 1.1. Requirements - Maven 2.1.0 or later @@ -16,7 +12,6 @@ - Eclipse IDE + JBoss Tools (to explore and run the application in IDE). - You're free to use any other IDE also but we haven't tested an application in other environments. - 1.3 Build/Deploy 1.3.1) Tomcat @@ -37,22 +32,28 @@ 2) Publishing to Google Application Engine -In M2 we completed resource plugin which generates static resources and that allow us to create Google App Engine compatible application using RichFaces. +We have completed a resource plugin which generates static resources which allow us to create Google App Engine compatible applications using RichFaces. This means deploying to and working with GAE is a piece of cake. Here is how you can deploy your own RichFaces showcase example. + +--) Update the GAE application name, and register it with google. Do this by updating the /webapp-gae/WEB-INF/appengine-web.xml following the GAE standard documentation. + +--) Only if using MyFaces: Configure the MyFaces encryption secret values in the /webapp-gae/WEB-INF/web.xml. Replace the "-- Insert some secret here --" with a base64 encoded password. This is important because otherwise MyFaces will generate random keys, and this causes issues in a cluster environment like GAE. + +See below for more information: + MyFaces - http://wiki.apache.org/myfaces/Secure_Your_Application + Mojarra - http://wikis.sun.com/display/GlassFish/JavaServerFacesRI#JavaServerFacesR... + +--) Build using: + +mvn clean package -Pgae -Denforcer.skip=true + +note: The enforcer.skip property is only needed if building from SNAPSHOT sources -just execute - * mvn clean package -Pgae -Denforcer.skip=true -(enforcer skipped as resource plugin using snapshot plugin, and required only if you using snapshots sources) +--) Use GAE SDK and the appcfg script just as you would for any other GAE application. -And now you're ready to publish the application to GAE. just use appcfg as for any other one like described at google documentation. Do not forget to register your -own application name and rename the demo application accordingly. - -more details about the resource plugin(it could be highly usefull not only in case of GAE usage but for general cases like serving resources at separate content systems) - -will be published at our wiki and announced at RichFaces usage space. - -There are some additional changes were made in order to make richfaces-showcase GAE compatible: +There are some additional changes that were made in order to make richfaces-showcase GAE compatible: * WebConfiguration class from com.sun.faces were patched removing code which is not compatible with GAE - * web.xml with additional properties for GAE created and placed at src\main\webapp-gae\WEB-INF\ (it replaces common one durinf build with GAE profile) - * check pom.xml GAE profile section in order to check additional dependencies for that configuration. + * web.xml with additional properties for GAE created and placed at src\main\webapp-gae\WEB-INF\ (it replaces common one during build with GAE profile) + * check pom.xml GAE profile section in order to check additional dependencies for that configuration. 3) Working with the project in Eclipse IDE: In order to explore, run and deploy the application in Eclipse IDE you can use one of the following options: