Author: rsmeral Date: 2013-06-13 09:02:27 -0400 (Thu, 13 Jun 2013) New Revision: 15563 Modified: branches/enterprise/WFK-2_1/examples/blog/README.md branches/enterprise/WFK-2_1/examples/booking/README.md branches/enterprise/WFK-2_1/examples/contactlist/README.md branches/enterprise/WFK-2_1/examples/excel/README.md branches/enterprise/WFK-2_1/examples/groovybooking/README.md branches/enterprise/WFK-2_1/examples/hibernate/README.md branches/enterprise/WFK-2_1/examples/itext/README.md branches/enterprise/WFK-2_1/examples/jee6/README.md branches/enterprise/WFK-2_1/examples/jpa/README.md branches/enterprise/WFK-2_1/examples/mail/README.md branches/enterprise/WFK-2_1/examples/messages/README.md branches/enterprise/WFK-2_1/examples/nestedbooking/README.md branches/enterprise/WFK-2_1/examples/openid/README.md branches/enterprise/WFK-2_1/examples/quartz/README.md branches/enterprise/WFK-2_1/examples/readme.txt branches/enterprise/WFK-2_1/examples/registration/README.md branches/enterprise/WFK-2_1/examples/remoting/chatroom/README.md branches/enterprise/WFK-2_1/examples/remoting/helloworld/README.md branches/enterprise/WFK-2_1/examples/restbay/README.md branches/enterprise/WFK-2_1/examples/seambay/README.md branches/enterprise/WFK-2_1/examples/seamdiscs/README.md branches/enterprise/WFK-2_1/examples/seampay/README.md branches/enterprise/WFK-2_1/examples/seamspace/README.md branches/enterprise/WFK-2_1/examples/spring/README.md branches/enterprise/WFK-2_1/examples/tasks/README.md branches/enterprise/WFK-2_1/examples/ui/README.md Log: Fixed examples/README.md + minor formatting change in all examples README.md Modified: branches/enterprise/WFK-2_1/examples/blog/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/blog/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/blog/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -11,13 +11,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the blog-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-blog Modified: branches/enterprise/WFK-2_1/examples/booking/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/booking/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/booking/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -13,13 +13,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the booking-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-booking Modified: branches/enterprise/WFK-2_1/examples/contactlist/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/contactlist/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/contactlist/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the contactlist-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-contactlist Modified: branches/enterprise/WFK-2_1/examples/excel/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/excel/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/excel/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the excel-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-excel Modified: branches/enterprise/WFK-2_1/examples/groovybooking/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/groovybooking/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/groovybooking/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -11,12 +11,12 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the groovybooking-web directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/groovybooking-web Modified: branches/enterprise/WFK-2_1/examples/hibernate/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/hibernate/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/hibernate/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the hibernate-web directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/hibernate-web Modified: branches/enterprise/WFK-2_1/examples/itext/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/itext/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/itext/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the itext-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-itext Modified: branches/enterprise/WFK-2_1/examples/jee6/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/jee6/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/jee6/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -12,13 +12,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the jee6-web directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy * Open this URL in a web browser: http://localhost:8080/jee6-web Modified: branches/enterprise/WFK-2_1/examples/jpa/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/jpa/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/jpa/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the jpa-web directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/jpa-web Modified: branches/enterprise/WFK-2_1/examples/mail/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/mail/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/mail/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -11,13 +11,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the mail-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-mail Modified: branches/enterprise/WFK-2_1/examples/messages/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/messages/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/messages/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the messages-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-messages Modified: branches/enterprise/WFK-2_1/examples/nestedbooking/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/nestedbooking/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/nestedbooking/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -13,13 +13,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the nestedbooking-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-nestedbooking Modified: branches/enterprise/WFK-2_1/examples/openid/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/openid/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/openid/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the openid-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-openid Modified: branches/enterprise/WFK-2_1/examples/quartz/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/quartz/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/quartz/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the quartz-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-quartz Modified: branches/enterprise/WFK-2_1/examples/readme.txt =================================================================== --- branches/enterprise/WFK-2_1/examples/readme.txt 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/readme.txt 2013-06-13 13:02:27 UTC (rev 15563) @@ -1,80 +1,78 @@ Seam Example EE6 Applications ============================= This directory contains the Seam example applications, which have all been -tested on the latest release of JBoss EAP 6.0. Consult the readme.txt file in each of +tested on the latest release of JBoss EAP 6.0. Consult the `README.md` file in each of the examples to see details. -Deploying and Testing an Example Application -============================================ +The name of each example, refered to later as `${example.name}`, is equivalent to the name of the folder. +---------------------------------------------------------------------- + +## Deploying and Testing an Example Application + These are general instructions for deploying Seam examples. Take a look at the -readme.txt in the example to see if there are any specific instructions. +`README.md` file in the example to see if there are any specific instructions. -How to Build and Deploy an Example on JBoss EAP 6 -------------------------------------------------- +### How to Build and Deploy an Example on EAP 6 1. Download and unzip JBoss EAP 6 - https://access.redhat.com/downloads + https://access.redhat.com/downloads 2. Make sure you have set up WFK and EAP 6 Maven repositories. More details how to do that, you can read in JBoss Web Framework Kit documentation book called Maven Repository Guide. 3. Build the example by running the following command from the Seam - "examples/${example.name}" directory: + `examples/${example.name}` directory: - mvn clean install + mvn clean install - NOTE: Firstly, this command will also run unit tests on that example. To skip the tests add - -Dmaven.test.skip=true to the maven call. Secondly, there is an option to deploy an "exploded" - archive. For this purpose, use -Pexploded maven profile. + _NOTE: There is an option to create an "exploded" archive. For this purpose, use `-Pexploded` maven profile._ -4. Deploy the example by running the following command from "examples/${example.name}/{example.name}-ear" directory if -that is EAR packaged type example or from "examples/${example.name}/{example.name}-war" if that is WAR packaged type example: +4. Deploy the example by running the following command from the `examples/${example.name}/{example.name}-ear` + directory in case of an EAR packaged example or from `examples/${example.name}/{example.name}-war` + in case of a WAR packaged example: - mvn jboss-as:deploy + mvn jboss-as:deploy To undeploy the example, run: - mvn jboss-as:undeploy + mvn jboss-as:undeploy 5. Point your web browser to: - http://localhost:8080/seam-${example.name} + http://localhost:8080/seam-${example.name} - Recall that ${example.name} is the name of the example folder unless the - folder begins with seam, in which the prefix "seam" is omitted. The - context path is set in META-INF/application.xml for EAR deployments. + The context path is set to the final name of the EAR archive. However, WAR deployments use a different naming convention for the context path. If you deploy a WAR example, point your web browser to: - http://localhost:8080/${example.name}-web + http://localhost:8080/${example.name}-web The WAR examples are: - spring, jpa, hibernate, groovybooking + spring, jpa, hibernate, groovybooking. -NOTE: The examples use the H2 default database embedded in JBoss EAP 6 +_NOTE: The examples use the H2 default database embedded in JBoss EAP 6._ -Running The Integration Tests ------------------------------ +### Running The Integration Tests -Integration tests are executed during building of the application using: +Integration tests can be executed during a build of the application using: - mvn clean install -Darquillian=jbossas-remote-7 + mvn clean install -Darquillian=jbossas-{managed,remote}-7 -Running functional tests on an example -======================================= +## Running functional tests on an example -The following steps describe executing of functional tests in general. If particular example -does not contain certain profile, it is simply ignored during the maven call. +The following steps describe executing of functional tests in general. +Some examples are not covered with functional tests and thus don't contain +the `${example.name}-ftest` folder. * Start JBoss EAP 6 Server -* Set JBOSS_HOME environment property, respectively +* Set `JBOSS_HOME` environment property, respectively To run functional tests: -* mvn clean verify -Pftest-jbossas + mvn clean test -f ${example.name}/${example.name}-ftest/pom.xml \ No newline at end of file Modified: branches/enterprise/WFK-2_1/examples/registration/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/registration/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/registration/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the registration-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-registration Modified: branches/enterprise/WFK-2_1/examples/remoting/chatroom/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/remoting/chatroom/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/remoting/chatroom/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the chatroom-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-chatroom Modified: branches/enterprise/WFK-2_1/examples/remoting/helloworld/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/remoting/helloworld/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/remoting/helloworld/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the helloworld-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-helloworld Modified: branches/enterprise/WFK-2_1/examples/restbay/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/restbay/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/restbay/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -11,13 +11,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the restbay-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-restbay Modified: branches/enterprise/WFK-2_1/examples/seambay/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/seambay/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/seambay/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the seambay-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-seambay Modified: branches/enterprise/WFK-2_1/examples/seamdiscs/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/seamdiscs/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/seamdiscs/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -32,13 +32,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the seamdiscs-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-seamdiscs Modified: branches/enterprise/WFK-2_1/examples/seampay/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/seampay/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/seampay/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the seampay-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-seampay Modified: branches/enterprise/WFK-2_1/examples/seamspace/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/seamspace/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/seamspace/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -12,13 +12,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the seamspace-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-seamspace Modified: branches/enterprise/WFK-2_1/examples/spring/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/spring/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/spring/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -11,12 +11,12 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the spring-web directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/spring-web Modified: branches/enterprise/WFK-2_1/examples/tasks/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/tasks/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/tasks/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the tasks-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-tasks Modified: branches/enterprise/WFK-2_1/examples/ui/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/ui/README.md 2013-06-13 12:49:09 UTC (rev 15562) +++ branches/enterprise/WFK-2_1/examples/ui/README.md 2013-06-13 13:02:27 UTC (rev 15563) @@ -10,13 +10,13 @@ 1. In the example root directory run: - mvn clean install + mvn clean install 2. Set JBOSS_HOME environment property. 3. In the ui-ear directory run: - mvn jboss-as:deploy + mvn jboss-as:deploy 4. Open this URL in a web browser: http://localhost:8080/seam-ui