Author: jbalunas(a)redhat.com Date: 2010-10-04 17:44:13 -0400 (Mon, 04 Oct 2010) New Revision: 19439 Modified: trunk/archetypes/rf-gae-sample/readme.txt trunk/archetypes/rf-gae-sample/src/main/resources/archetype-resources/pom.xml trunk/archetypes/rf-gae-sample/src/main/resources/archetype-resources/readme.txt Log: RF-9411 Updated archetype, and readme files to describe deploying to GAE SDK developer server Modified: trunk/archetypes/rf-gae-sample/readme.txt =================================================================== --- trunk/archetypes/rf-gae-sample/readme.txt 2010-10-04 21:42:02 UTC (rev 19438) +++ trunk/archetypes/rf-gae-sample/readme.txt 2010-10-04 21:44:13 UTC (rev 19439) @@ -1,51 +1,46 @@ RichFaces 4 Archetype -BUILDING THE ARCHETYPE +GENERATING THE PROJECT -just execute mvn clean install in the root folder +This archetype creates a simple RichFaces 4 application with all the settings and custom artifacts you need to perform deploy to GAE cloud. -APPLICATION CREATION - -This archetype creates a simple RichFaces 4 application with all the settings and custom artifacts you need to perform deply to GAE cloud. - 1) To generate a project from the archetype, run mvn archetype:generate -DarchetypeGroupId=org.richfaces.archetypes -DarchetypeArtifactId=richfaces-archetype-gae -DarchetypeVersion=<richfaces-version> -DgroupId=<yourGroupId> -DartifactId=<yourArtifactId> -Dversion=1.0-SNAPSHOT -2) To build the project for deploy to GAE cloud, run +2) Navigate into the new project directory and build by running: mvn clean install -*BEFORE NEXT STEP - you should setup your GAE account at http://appspot.com and register new application there. -(read more at http://code.google.com/intl/ru/appengine/docs/python/gettingstarted/uploa...) +*BEFORE NEXT STEP: + -- You should setup your GAE account at http://appspot.com + -- Register your new application there. By default the applications name is "rf-${artifactId}" + -- Download and install the GAE SDK for deployment and local server tools -3) Then just execute appcfg from GAE SDK(link) to publish to your account: +3) Execute appcfg from GAE SDK to publish to your account: appcfg update <PATH: "generated-application-target-folder/output application folder"> -NOTE:Do not forget to register your own application name and make sure that the demo uses the same name accordingly. By default the applications name is "rf-${artifactId}" - - -4) now visit your application using http://<application-name>.appspot.com +4) Once uploaded, visit your application using http://<application-name>.appspot.com 4.1) check all the information about deployed application at https://appengine.google.com/dashboard?&app_id=<your-application-i... +NOTE: +During build the "org.richfaces.cdk:maven-resource-plugin" executed and generated static resources(web-app\static-resources\) for all skins in order to +solve the compatibility problem with GAE and java2D API. -PAY ATTENTION: -during build with GAE profile - our org.richfaces.cdk:maven-resource-plugin executed and generates static resources(web-app\static-resources\) for all the skins in order to -solve the compatibility problem with GAE which restricts java2D usage(our dynamic resources works using that dependency) - -NOTES about additional artifacts in webapp folder: +NOTE: about additional artifacts in webapp folder: 1) java-gae-jsf-ri - contains modified WebConfiguration.java class which will be put to Web-inf\classes when building with GAE profile. It solves compatibilities issues exist in GAE for JSF applications. -2) Webapp-gae folder contains GAE descriptor(appengine-web.xml) and modified application web.xml. Them will be placed to WEb-inf folder after build with GAE profile. web.xml -should be different in order to use static resources generated by plugin instead of dynamic resources. And also restricts threading with +2) Webapp-gae folder contains GAE descriptor(appengine-web.xml) and modified application web.xml. They will be placed in the WEB-INF folder. The web.xml +is different in order to use static resources generated by plugin instead of dynamic resources. And also restricts threading with com.sun.faces.enableThreading context parameter as GAE not allows threads. ============================================================================================================ -LOCAL DEPLOYMENT -you still could deploy your application as usually using -1) mvn clean install -2) put to tomcat6\webapps -3) run server -4) enjoy going to http:\\localhost:8080\<app-name> \ No newline at end of file +LOCAL DEPLOYMENTS +To test your application on your local machine you can use GAE SDK development server. +1) Build archetype as above +2) Navigate GAE SDK /bin +3) Execute" + ./dev_appserver.sh <PATH: "generated-application-target-folder/output application folder"> +4) Once loaded, access your application at http:\\localhost:8080\ \ No newline at end of file Modified: trunk/archetypes/rf-gae-sample/src/main/resources/archetype-resources/pom.xml =================================================================== --- trunk/archetypes/rf-gae-sample/src/main/resources/archetype-resources/pom.xml 2010-10-04 21:42:02 UTC (rev 19438) +++ trunk/archetypes/rf-gae-sample/src/main/resources/archetype-resources/pom.xml 2010-10-04 21:44:13 UTC (rev 19439) @@ -130,74 +130,6 @@ </plugins> </build> - <profiles> - <profile> - <id>jee6</id> - <build> - <plugins> - <plugin> - <artifactId>maven-war-plugin</artifactId> - <configuration> - <webappDirectory>${project.build.directory}/${project.build.finalName}-jee6</webappDirectory> - </configuration> - </plugin> - </plugins> - </build> - - <dependencies> - <dependency> - <groupId>com.sun.faces</groupId> - <artifactId>jsf-api</artifactId> - <scope>provided</scope> - </dependency> - <dependency> - <groupId>com.sun.faces</groupId> - <artifactId>jsf-impl</artifactId> - <scope>provided</scope> - </dependency> - <dependency> - <groupId>javax.transaction</groupId> - <artifactId>jta</artifactId> - <version>1.1</version> - <scope>provided</scope> - </dependency> - </dependencies> - </profile> - <profile> - <id>release</id> - <build> - <plugins> - <plugin> - <artifactId>maven-war-plugin</artifactId> - <executions> - <execution> - <id>jee6</id> - <phase>package</phase> - <goals> - <goal>war</goal> - </goals> - <configuration> - <webappDirectory>${project.build.directory}/${project.build.finalName}-jee6</webappDirectory> - <classifier>jee6</classifier> - <packagingExcludes>WEB-INF/lib/jsf-api*,WEB-INF/lib/jsf-impl*</packagingExcludes> - <warSourceExcludes>WEB-INF/lib/jsf-api*,WEB-INF/lib/jsf-impl*</warSourceExcludes> - </configuration> - </execution> - </executions> - <configuration> - <webResources> - <resource> - <directory>${basedir}/src/main/java</directory> - <targetPath>/WEB-INF/src</targetPath> - </resource> - </webResources> - </configuration> - </plugin> - </plugins> - </build> - </profile> - </profiles> - <dependencyManagement> <dependencies> <dependency> @@ -252,8 +184,8 @@ <classifier>jdk15</classifier> <scope>test</scope> </dependency> + <!-- GAE PROFILE DEPENDENCIES --> - <dependency> <groupId>org.glassfish.web</groupId> <artifactId>el-impl</artifactId> @@ -288,6 +220,5 @@ <version>2.9.1</version> <scope>runtime</scope> </dependency> - </dependencies> </project> Modified: trunk/archetypes/rf-gae-sample/src/main/resources/archetype-resources/readme.txt =================================================================== --- trunk/archetypes/rf-gae-sample/src/main/resources/archetype-resources/readme.txt 2010-10-04 21:42:02 UTC (rev 19438) +++ trunk/archetypes/rf-gae-sample/src/main/resources/archetype-resources/readme.txt 2010-10-04 21:44:13 UTC (rev 19439) @@ -1,38 +1,37 @@ -Project generated with richfaces-archetype-gae +RichFaces 4 Archetype -1) To build the project for deploy to GAE cloud, run +1) Build by running: mvn clean install -*BEFORE NEXT STEP - you should setup your GAE account at http://appspot.com and register new application there. -(read more at http://code.google.com/intl/ru/appengine/docs/python/gettingstarted/uploa...) +*BEFORE NEXT STEP: + -- You should setup your GAE account at http://appspot.com + -- Register your new application there. By default the applications name is "rf-${artifactId}" + -- Download and install the GAE SDK for deployment and local server tools -2) Then just execute appcfg from GAE SDK(link) to publish to your account: - appcfg update <PATH: "generated-application-target-folder/output application folder"> +3) Execute appcfg from GAE SDK to publish to your account: + appcfg update <PATH: "generated-application-target-folder/output application folder"> -NOTE:Do not forget to register your own application name and make sure that the demo uses the same name accordingly. By default the applications name is "rf-${artifactId}" +4) Once uploaded, visit your application using http://<application-name>.appspot.com +4.1) check all the information about deployed application at https://appengine.google.com/dashboard?&app_id=<your-application-i... +NOTE: +During build the "org.richfaces.cdk:maven-resource-plugin" executed and generated static resources(web-app\static-resources\) for all skins in order to +solve the compatibility problem with GAE and java2D API. -3) now visit your application using http://<application-name>.appspot.com -3.1) check all the information about deployed application at https://appengine.google.com/dashboard?&app_id=<your-application-i... - - -PAY ATTENTION: -during build with GAE profile(default one) - our org.richfaces.cdk:maven-resource-plugin executed and generates static resources(web-app\static-resources\) for all the skins in order to -solve the compatibility problem with GAE which restricts java2D usage(our dynamic resources works using that dependency) - -NOTES about additional artifacts in webapp folder: +NOTE: about additional artifacts in webapp folder: 1) java-gae-jsf-ri - contains modified WebConfiguration.java class which will be put to Web-inf\classes when building with GAE profile. It solves compatibilities issues exist in GAE for JSF applications. -2) Webapp-gae folder contains GAE descriptor(appengine-web.xml) and modified application web.xml. Them will be placed to WEb-inf folder after build with GAE profile. web.xml -should be different in order to use static resources generated by plugin instead of dynamic resources. And also restricts threading with +2) Webapp-gae folder contains GAE descriptor(appengine-web.xml) and modified application web.xml. They will be placed in the WEB-INF folder. The web.xml +is different in order to use static resources generated by plugin instead of dynamic resources. And also restricts threading with com.sun.faces.enableThreading context parameter as GAE not allows threads. ============================================================================================================ -LOCAL DEPLOYMENT -you still can deploy your application to a local tomcat instance. -1) mvn clean install -2) put target war into tomcat6 webapp directory -3) Launch tomcat -4) Go to http:\\localhost:8080\<app-name> \ No newline at end of file +LOCAL DEPLOYMENTS +To test your application on your local machine you can use GAE SDK development server. +1) Build archetype as above +2) Navigate GAE SDK /bin +3) Execute" + ./dev_appserver.sh <PATH: "generated-application-target-folder/output application folder"> +4) Once loaded, access your application at http:\\localhost:8080\ \ No newline at end of file