Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Attempt to standardize README.md files.

  • Loading branch information...
commit 8ddd885377872f8f20c05e042e644a6585398589 1 parent fc928e2
@sgilda sgilda authored
Showing with 2,522 additions and 1,657 deletions.
  1. +48 −38 README.md
  2. +55 −18 bean-validation/README.md
  3. +51 −55 bmt/README.md
  4. +45 −22 cdi-injection/README.md
  5. +66 −71 cmt/README.md
  6. +24 −28 ejb-in-ear/README.md
  7. +47 −47 ejb-in-war/README.md
  8. +84 −60 ejb-remote/README.md
  9. +74 −30 ejb-security/README.md
  10. +74 −73 forge-from-scratch/README.md
  11. +61 −12 greeter/README.md
  12. +40 −49 h2-console/README.md
  13. +60 −39 helloworld-errai/README.md
  14. +57 −37 helloworld-gwt/README.md
  15. +29 −10 helloworld-jms/README.md
  16. +49 −37 helloworld-jsf/README.md
  17. +55 −23 helloworld-mdb/README.md
  18. +7 −7 helloworld-mdb/cheatsheets/helloworld-mdb.xml
  19. +61 −14 helloworld-osgi/README.md
  20. +76 −15 helloworld-rs/README.md
  21. +54 −24 helloworld-singleton/README.md
  22. +58 −11 helloworld/README.md
  23. +53 −34 hibernate3/README.md
  24. +59 −60 hibernate4/README.md
  25. +48 −23 jax-rs-client/README.md
  26. +78 −52 jts/README.md
  27. +45 −35 kitchensink-ear/README.md
  28. +59 −65 kitchensink-jsp/README.md
  29. +52 −53 kitchensink/README.md
  30. +47 −46 log4j/README.md
  31. +61 −13 mail/README.md
  32. +57 −9 numberguess/README.md
  33. +54 −30 payment-cdi-event/README.md
  34. +68 −53 richfaces-validation/README.md
  35. +4 −4 richfaces-validation/src/main/webapp/index.xhtml
  36. +53 −33 servlet-async/README.md
  37. +48 −29 servlet-filterlistener/README.md
  38. +71 −26 servlet-security/README.md
  39. +63 −31 shopping-cart/README.md
  40. +33 −43 tasks-jsf/README.md
  41. +33 −63 tasks/README.md
  42. +119 −19 template/README.md
  43. +40 −28 wicket-ear/README.md
  44. +61 −53 wsat-simple/README.md
  45. +52 −58 wsba-coordinator-completion-simple/README.md
  46. +44 −46 wsba-participant-completion-simple/README.md
  47. +45 −31 xml-jaxp/README.md
View
86 README.md
@@ -115,7 +115,7 @@ To run these quickstarts with the provided build scripts, you need the following
3. The JBoss Enterprise Application Platform 6 distribution ZIP or the JBoss AS 7 distribution ZIP.
* For information on how to install and run JBoss, refer to the product documentation.
-4. You can also deploy the quickstarts from Eclipse using JBoss tools. For more information on how to set up Maven and the JBoss tools, refer to the [Getting Started Developing Applications Guide](https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide "Getting Started Developing Applications Guide").
+4. You can also use [JBoss Developer Studio or Eclipse](#useeclipse) to run the quickstarts.
<a id="mavenconfiguration"></a>
@@ -170,7 +170,7 @@ The JBoss server can be started a few different ways.
The README for each quickstart will specify which configuration is required to run the example.
<a id="startserverweb"></a>
-#### Start the JBoss Enterprise Application Platform 6 or JBoss AS 7 Server with the Web Profile
+#### Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
1. Open a command line and navigate to the root of the JBoss directory.
2. The following shows the command line to start the server with the web profile:
@@ -179,7 +179,7 @@ The README for each quickstart will specify which configuration is required to r
For Windows: JBOSS_HOME\bin\standalone.bat
<a id="startserverfull"></a>
-#### Start the JBoss Enterprise Application Platform 6 or JBoss AS 7 Server with the Full Profile
+#### Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Full Profile
1. Open a command line and navigate to the root of the JBoss directory.
2. The following shows the command line to start the server with the full profile:
@@ -188,7 +188,7 @@ The README for each quickstart will specify which configuration is required to r
For Windows: JBOSS_HOME\bin\standalone.bat -c standalone-full.xml
<a id="startservercustom"></a>
-#### Start the JBoss Enterprise Application Platform 6 or JBoss AS 7 Server with the Custom Configuration Options
+#### Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with Custom Configuration Options
1. Open a command line and navigate to the root of the JBoss directory.
2. The following shows the command line to start the server. Replace the CUSTOM_OPTIONS with the custom optional parameters specified in the quickstart.
@@ -201,42 +201,46 @@ The README for each quickstart will specify which configuration is required to r
Review the README file in the root folder of the quickstart for specific details on how to build and run the example. In most cases you do the following:
-1. If required by the quickstart, make sure you [start the JBoss Server](#startjboss) as described in the README.
-2. Build and deploy the quickstarts
- 1. Open a command line and navigate to the root of the directory of the quickstart you want to run.
- 2. Build the archive
- * The command used to build the quickstart depends on the individual quickstart, the server version, and how you configured Maven.
- * If you are running JBoss AS 7, it uses community artifacts available in the Maven central repository, so command line arguments are not usually required.
- * If you are running JBoss Enterprise Application Platform 6 and did not configure the Maven user settings described in [Configure Maven for JBoss Enterprise Application Platform 6](#eap6mavenconfig) above, you need to specify command line arguments.
- * Although some of the quickstarts require special commands, for most of the quickstarts you do the one of the following.
-
- For JBoss Enterprise Application Platform 6, Maven user settings NOT configured:
+1. The command used to build the quickstart depends on the individual quickstart, the server version, and how you configured Maven.
+ * If you are running JBoss Enterprise Application Platform 6 and did not configure the Maven user settings described in [Configure Maven for JBoss Enterprise Application Platform 6](#eap6mavenconfig) above, you need to specify command line arguments.
+ * If you are running JBoss AS 7, it uses community artifacts available in the Maven central repository, so command line arguments are not usually required.
+2. See the README file in each individual quickstart folder for specific details and information on how to run and access the example.
+
+#### Build the Quickstart Archive
+
+In some cases, you may want to build the application to test for compile errors or view the contents of the archive.
+
+1. Open a command line and navigate to the root directory of the quickstart you want to build.
+2. Use this command if you only want to build the archive, but not deploy it:
+
+ For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured):
mvn clean package -s PATH_TO_QUICKSTARTS/example-settings.xml
- For JBoss AS 7 or JBoss Enterprise Application Platform 6, Maven user settings configured:
+ For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured):
mvn clean package
- 3. Deploy the archive built in the previous step by typing the following in the command line:
- mvn jboss-as:deploy
- 4. Alternatively, you can build and deploy the quickstart in one step. As in step 2. above when you built the archive, the command you use depends on the individual quickstart, the server version, and how you configured Maven. Although some of the quickstarts require special commands, for most of the quickstarts you do one of the following:
+#### Build and Deploy the Quickstart Archive
- For JBoss Enterprise Application Platform 6, Maven user settings NOT configured:
+1. Make sure you [start the JBoss Server](#startjboss) as described in the README.
+2. Open a command line and navigate to the root directory of the quickstart you want to run.
+3. Use this command to build and deploy the archive:
- mvn package jboss-as:deploy -s PATH_TO_QUICKSTARTS/example-settings.xml
+ For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured):
- For JBoss AS 7 or JBoss Enterprise Application Platform 6, Maven user settings configured:
+ mvn clean package jboss-as:deploy -s PATH_TO_QUICKSTARTS/example-settings.xml
- mvn package jboss-as:deploy
- 5. The command to undeploy the quickstart is simply:
+ For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured):
- mvn jboss-as:undeploy
- 6. If you want to redeploy a quickstart that uses a database, you should undeploy it first. This ensures the database is cleaned up correctly before the redeploy.
+ mvn clean package jboss-as:deploy
+
+#### Undeploy an Archive
-3. See the README file in each individual quickstart folder for specific details and information on how to run and access the example.
+The command to undeploy the quickstart is simply:
-4. You can also start the JBoss Application Server and deploy the quickstarts using Eclipse. See the [Getting Started Developing Applications Guide](https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide "Getting Started Developing Applications Guide") for more information.
+ mvn jboss-as:undeploy
+
<a id="arquilliantests"></a>
### Run the Arquillian Tests
@@ -244,19 +248,23 @@ Review the README file in the root folder of the quickstart for specific details
Some of the quickstarts provide Arquillian tests. By default, these tests are configured to be skipped, as Arquillian tests require the use of a container.
-You can run these tests using either a managed or remote container.
+You can run these tests using either a remote or managed container.
+
+<a id="testremote"/>
1. Test the quickstart on a Remote Server
* A remote container requires you start the JBoss Enterprise Application Platform 6 or JBoss AS 7 server before running the test. [Start the JBoss Server](#startjboss) as described in the quickstart README file.
* Run the test goal with the following profile activated:
- For JBoss Enterprise Application Platform 6, Maven user settings NOT configured:
+ For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured):
mvn clean test -Parq-jbossas-remote -s PATH_TO_QUICKSTARTS/example-settings.xml
- For JBoss AS 7 or JBoss Enterprise Application Platform 6, Maven user settings configured:
+ For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured):
mvn clean test -Parq-jbossas-remote
+<a id="testmanaged"/>
+
2. Test the quickstart on Managed Server
* This test requires that your server is not running. Arquillian will start the container for you, however, you must first let it know where to find the remote JBoss container.
* Open the test/resources/arquillian.xml file located in the quickstart directory.
@@ -273,16 +281,20 @@ You can run these tests using either a managed or remote container.
* Run the test goal with the following profile activated:
- For JBoss Enterprise Application Platform 6, Maven user settings NOT configured:
+ For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured):
mvn clean test -Parq-jbossas-managed -s PATH_TO_QUICKSTARTS/example-settings.xml
- For JBoss AS 7 or JBoss Enterprise Application Platform 6, Maven user settings configured:
+ For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured):
mvn clean test -Parq-jbossas-managed
The quickstart README should tell you what you should expect to see in the console output and server log when you run the test.
+<a id="useeclipse"/>
+Use JBoss Developer Studio or Eclipse to Run the Quickstarts
+-------------------------------------
+You can also deploy the quickstarts from Eclipse using JBoss tools. For more information on how to set up Maven and the JBoss tools, refer to the [Boss Enterprise Application Platform 6 Beta](http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/6/html/Beta_Documentation/HOME.html) documentation or the [Getting Started Developing Applications Guide](https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide "Getting Started Developing Applications Guide").
<a id="optionalcomponents"></a>
@@ -326,7 +338,7 @@ The following procedures describe how to add a user with the appropriate permiss
Enter the details of the new user to add.
Realm (ManagementRealm) :
- At the prompt, press enter to take the default ManagementRealm
+ If the quickstart README specifies a realm, type it here. Otherwise, press enter to take the default `ManagementRealm`.
5. When prompted, enter the following
Username : admin
@@ -357,14 +369,12 @@ The following procedures describe how to add a user with the appropriate permiss
Enter the details of the new user to add.
Realm (ApplicationRealm) :
- At the prompt, press enter to take the default ApplicationRealm
-5. When prompted, enter the following
+ If the quickstart README specifies a realm, type it here. Otherwise, press enter to take the default `ApplicationRealm`.
+5. When prompted, enter the the Username and Passord. If the quickstart README specifies a Username nad Password, enter them here. Otherwise, use the default Username `quickstartUser` and Password `quickstartPassword`.
Username : quickstartUser
Password : quickstartPassword
-6. When asked "What roles do you want this user to belong to?", enter:
-
- guest
+6. At the next prompt, you will be asked "What roles do you want this user to belong to?". If the quickstart README specifies a role to use, enter that here. Otherwise, type the role: `guest`
<a id="postgresql"></a>
View
73 bean-validation/README.md
@@ -5,37 +5,59 @@ Author: Karel Piwko <kpiwko@redhat.com>
What is it?
-----------
-This is your project! It's a sample, Maven 3 project to help you
-get your foot in the door developing with Java EE 6 on JBoss AS 7 or JBoss Enterprise Application Platform 6.
-This project is setup to allow you to use CDI 1.0, JPA 2.0 and Bean Validation 1.0.
-It includes a persistence unit and some sample persistence code to help
-you get your feet wet with database access in enterprise Java.
+This project demonstrates how to use CDI 1.0, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence code to introduce you to database access in enterprise Java.
+
+This quickstart does not contain a user interface layer. The purpose of this project is to show you how to test bean validation with Arquillian. If you want to see an example of how to test bean validation with a user interface, look at the [kitchensink](../kitchensink/README.html) example.
-It does not contain an user interface layer. The main purpose of the project is
-to show you how to test Bean Validation with Arquillian. If you want to see an
-example how to test Bean Validation via an user interface, check out Kitchensink
-example available at <https://github.com/jbossas/quickstart/tree/master/kitchensink>.
System requirements
-------------------
-All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven
-3.0 or better.
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
-Running the Arquillian tests
-----------------------------
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
+
+Configure Maven
+---------------
+
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
+
+
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
+-------------------------
+
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
+
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
+
+
+Run the Arquillian Tests
+-------------------------
+
+This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.
+
+_NOTE: The following commands assume you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Run the Arquillian Tests](../README.html/#arquilliantests) for complete instructions and additional options._
-This quickstart provides Arquillian tests. See [Run the Arquillian Tests](../README.html/#arquilliantests) for more information on how to set up and run the tests. When asked to start the JBoss Server, this quickstart requires that you start it with the _web_ profile.
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type the following command to run the test goal with the following profile activated:
-### Investigate the Console Output
+ mvn clean test -Parq-jbossas-remote
+
+
+Investigate the Console Output
+----------------------------
When you run the tests, JUnit will present you test report summary:
Tests run: 5, Failures: 0, Errors: 0, Skipped: 0
-If you are interested in more details, check ``target/surefire-reports`` directory.
-You can check console output to verify that Arquillian had really used the real application server.
-Search for lines similar to the following ones in the server output log:
+If you are interested in more details, look in the `target/surefire-reports` directory.
+
+You can also check the server console output to verify that the Arquillian tests deployed to and ran in the application server. Search for lines similar to the following ones in the server output log:
[timestamp] INFO [org.jboss.as.server.deployment] (MSC service thread 1-2) Starting deployment of "test.war"
...
@@ -45,5 +67,20 @@ Search for lines similar to the following ones in the server output log:
...
[timestamp] INFO [org.jboss.as.server] (management-handler-threads - 1) JBAS018558: Undeployed "test.war
+
+
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
+
+
+Debug the Application
+------------------------------------
+
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
+
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
+
View
106 bmt/README.md
@@ -1,96 +1,92 @@
-bmt (Bean Managed Transactions): Stepping Outside the Container (with JPA and JTA)
+bmt: Bean Managed Transactions - Stepping Outside the Container (with JPA and JTA)
=================================================================================
Author: Mike Musgrove
What is it?
-----------
-On occasion the application developer requires finer grained control over the lifecycle of
-JTA transactions and JPA Entity Managers than the defaults provided by the JEE container.
-This example shows how the developer can override these defaults and take control of aspects
-of the lifecycle of JPA and transactions.
+On occasion, the application developer requires finer grained control over the lifecycle of JTA transactions and JPA Entity Managers than the defaults provided by the Java EE container. This example shows how the developer can override these defaults and take control of aspects of the lifecycle of JPA and transactions.
-[But note that a JEE container is designed with robustness in mind so you should
-carefully analyse the scaleabiltiy, concurrency and performance needs of you application
-before taking advantage of these techniques in your own applications.]
+This example demonstrates how to manually manage transaction demarcation while accessing JPA entities in JBoss AS 7:
-The example demonstrates how to manually manage transaction demarcation whilst accessing
-JPA entities in JBoss AS 7:
+* Part 1 shows the developer responsibilities when injecting an Entity Manager into a managed (stateless) bean.
+* Part 2 shows the developer responsibilities when using JPA and transactions with an unmanaged component.
+
+JBoss Enterprise Application Platform 6 and JBoss AS 7 ship with an H2 datasource by default. This example shows how to transactionally insert key value pairs into the H2 database and demonstrates the requirements on the developer with respect to the JPA Entity Manager.
+
+_NOTE: A JEE container is designed with robustness in mind, so you should carefully analyse the scaleabiltiy, concurrency and performance needs of you application before taking advantage of these techniques in your own applications._
-* part 1 shows the developer responsibilities when injecting an Entity Manager into a managed
-(stateless) bean.
-* part 2 shows the developer responsibilities when using JPA and transactions with an unmanaged
-component
System requirements
-------------------
All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
-The application this project produces is designed to be run on a JBoss AS 7 or JBoss Enterprise Application Platform 6.
-The following instructions target JBoss AS 7, but they also apply to JBoss Enterprise Application Platform 6.
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
-Deploying the application
--------------------------
+Configure Maven
+---------------
+
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
-First you need to start JBoss AS 7 (or JBoss Enterprise Application Platform 6). To do this, run
- $JBOSS_HOME/bin/standalone.sh
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
+-------------------------
-or if you are using windows
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
- $JBOSS_HOME/bin/standalone.bat
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
-To deploy the application, you first need to produce the archive to deploy using
-the following Maven goal:
- mvn package
+Build and Deploy the Quickstart
+-------------------------
-You can now deploy the artifact to JBoss AS by executing the following command:
+_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._
- mvn jboss-as:deploy
-This will deploy `target/jboss-as-bmt.war` to the running instance of the AS.
+#### Build and Deploy the Archive
-The application will be running at the following URL <http://localhost:8080/jboss-as-bmt/BMT>.
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
-To undeploy from JBoss AS, run this command:
+ mvn clean package jboss-as:deploy
- mvn jboss-as:undeploy
+4. This will deploy `target/jboss-as-bmt.war` to the running instance of the server.
-If you need to redeploy the war then ensure that you explicitly undeploy it first so that databases
-are cleaned up correctly.
+#### Undeploy the Archive
-You can also start JBoss AS 7 and deploy the project using Eclipse. See the
-<a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a>
-for more information.
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to undeploy the archive:
-Using the application
+ mvn jboss-as:undeploy
+
+
+Access the application
---------------------
-JBoss AS 7 comes with an H2 datasource by default. The example shows how to transactionally
-insert key value pairs into to this H2 database and demonstrates the requirements on the
-developer with respect to the JPA Entity Manager.
+The application will be running at the following URL: <http://localhost:8080/jboss-as-bmt/>.
+
+You will be presented with a simple form for adding key/value pairs and a checkbox to indicate whether the updates should be executed using an unmanaged component. Effectively this will run the transaction and JPA updates in the servlet, not session beans. If the box is checked then the updates will be executed within a session bean method.
-To access the application type the following into a browser:
+1. To list all pairs leave the key input box empty.
+2. To add or update the value of a key fill in the key and value input boxes.
+3. Press the submit button to see the results.
- http://localhost:8080/jboss-as-bmt/BMT
-You will be presented with a simple form for adding key value pairs and a checkbox to indicate
-whether the updates should be executed using an unmanaged component (effectively this will run the transaction
-and JPA updates in the servlet - ie not session beans). If the box is checked then the updates will be
-executed within a session bean method.
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
-To list all pairs leave the key input box empty. To add or update the value of a key fill in
-the key and value input boxes. Press the submit button to see the results.
-Downloading the sources and Javadocs
+Debug the Application
------------------------------------
-If you want to be able to debug into the source code or look at the Javadocs
-of any library in the project, you can run either of the following two
-commands to pull them into your local repository. The IDE should then detect
-them.
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
- mvn dependency:sources
- mvn dependency:resolve -Dclassifier=javadoc
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
View
67 cdi-injection/README.md
@@ -5,49 +5,72 @@ Author: Jason Porter
What is it?
-----------
-This example demonstrates the use of *CDI 1.0 Injection and Qualifiers* in *JBoss AS 7* or *JBoss Enterprise Application Platform 6*
-with JSF as the front-end client.
+This example demonstrates the use of *CDI 1.0 Injection and Qualifiers* in *JBoss AS 7* or *JBoss Enterprise Application Platform 6* with JSF as the front-end client.
-You can test the output at the URL http://localhost:8080/jboss-as-cdi-injection
System requirements
-------------------
-All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven
-3.0 or better.
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
-The application this project produces is designed to be run on a JBoss AS 7.
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
-With the prerequisites out of the way, you're ready to build and deploy.
+Configure Maven
+---------------
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
-Deploying the Application
+
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
+-------------------------
+
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
+
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
+
+
+Build and Deploy the Quickstart
-------------------------
-First you need to start JBoss AS 7 or JBoss Enterprise Application Platform 6. To do this, run
+_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._
- $JBOSS_HOME/bin/standalone.sh
-or if you are using windows
+#### Build and Deploy the Archive
- $JBOSS_HOME/bin/standalone.bat
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
-To deploy the application, you first need to produce the archive to deploy using
-the following Maven goal:
+ mvn clean package jboss-as:deploy
- mvn clean package
+4. This will deploy `target/jboss-as-cdi-injection.war` to the running instance of the server.
-You can now deploy the artifact to JBoss AS by executing the following command:
+#### Undeploy the Archive
- mvn jboss-as:deploy
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to undeploy the archive:
-This will deploy `target/jboss-as-cdi-injection.war`.
+ mvn jboss-as:undeploy
+
+
+Access the application
+---------------------
The application will be running at the following URL <http://localhost:8080/jboss-as-cdi-injection/>.
-To undeploy from JBoss AS, run this command:
- mvn jboss-as:undeploy
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
+
+
+Debug the Application
+------------------------------------
+
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
-You can also start JBoss AS 7 and deploy the project using Eclipse. See the JBoss AS 7
-<a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a> for more information.
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
View
137 cmt/README.md
@@ -1,13 +1,10 @@
-cmt (Container Managed Transactions): Example Using Transactions That Are Managed by the Container
+cmt: Container Managed Transactions - Example Using Transactions That Are Managed by the Container
==================================================================================================
Author: Tom Jenkinson
## What is it?
-This example demonstrates using transactions managed by the container. It is a fairly typical
-scenario of updating a database and sending a JMS message in the same transaction. A simple
-MDB is provided that prints out the message sent but this is not a transactional MDB and is
-purely provided for debugging purposes.
+This example demonstrates how to use transactions managed by the container. It is a fairly typical scenario of updating a database and sending a JMS message in the same transaction. A simple message-driven bean, or MDB, is provided that prints out the message that is sent. This MDB is not transactional and provided only for debugging purposes.
Aspects touched upon in the code:
@@ -17,104 +14,102 @@ Aspects touched upon in the code:
### What are container managed transactions?
-Prior to EJB, getting the right incantation to ensure sound transactional operation of a users
-business logic was a highly specialised skill. Although this still holds true to a great
-extent, EJB has provided a series of improvements to to allow simplified transaction demarcation
-notation that is therefore easier to read and test. With CMT, the EJB container sets the
-boundaries of a transaction, this differs from BMT (bean managed transactions) where the developer
-is responsible for initiating and completing a transaction via the methods begin, commit, rollback
-on a <code>javax.transaction.UserTransaction</code>.
+Prior to EJB, getting the right incantation to ensure sound transactional operation of the business logic was a highly specialised skill. Although this still holds true to a great extent, EJB has provided a series of improvements to to allow simplified transaction demarcation notation that is therefore easier to read and test.
-#### What makes this an example of container managed transactions?
+With CMT, the EJB container sets the boundaries of a transaction. This differs from BMT (bean managed transactions) where the developer is responsible for initiating and completing a transaction via the methods begin, commit, rollback on a <code>javax.transaction.UserTransaction</code>.
-Take a look at <code>org.jboss.as.quickstarts.cmt.ejb.CustomerManagerEJBImpl</code>. You can see that
-this stateless session bean has been marked up with an @javax.ejb.TransactionAttribute annotation.
+### What makes this an example of container managed transactions?
+
+Take a look at <code>org.jboss.as.quickstarts.cmt.ejb.CustomerManagerEJBImpl</code>. You can see that this stateless session bean has been marked up with an @javax.ejb.TransactionAttribute annotation.
The available options for this annotation are as follows:
-* Required - As demonstrated in the example. If a transaction does not already exist,
-this will initiate a transaction and complete it for you, otherwise the business
-logic will be integrated into the existing transaction
-* RequiresNew - If there is already a transaction running, it will be suspended,
-the work performed within a new transaction which is completed at exit of the method
-and then the original transaction resumed.
-* Mandatory - If there is no transaction running, calling a business method with
-is annotated with this will result in an error
-* NotSupported - If there is a transaction running, it will be suspended and no
-transaction will be initiated for this business method
-* Supports - This will run the method within a transaction if a transaction exists,
-alternatively, if there is no transaction running the method will not be executed
-within the scope of a transaction
-* Never - If the client has a transaction running and does not suspend it but calls
-a method annotated with Never then an EJB exception will be raised.
-
-## System requirements
+* Required - As demonstrated in the example. If a transaction does not already exist, this will initiate a transaction and complete it for you, otherwise the business logic will be integrated into the existing transaction.
+* RequiresNew - If there is already a transaction running, it will be suspended, the work performed within a new transaction which is completed at exit of the method and then the original transaction resumed.
+* Mandatory - If there is no transaction running, calling a business method with is annotated with this will result in an error.
+* NotSupported - If there is a transaction running, it will be suspended and no transaction will be initiated for this business method.
+* Supports - This will run the method within a transaction if a transaction exists, alternatively, if there is no transaction running the method will not be executed within the scope of a transaction.
+* Never - If the client has a transaction running and does not suspend it but calls a method annotated with Never then an EJB exception will be raised.
+
+
+JBoss Enterprise Application Platform 6 and JBoss AS 7 ship with an H2 datasource by default. This example shows how to transactionally insert key value pairs into the H2 database and demonstrates the requirements on the developer with respect to the JPA Entity Manager.
+
+
+System requirements
+-------------------
All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
-The application this project produces is designed to be run on a JBoss AS 7 or JBoss Enterprise Application Platform 6.
-The following instructions target JBoss AS 7, but they also apply to JBoss Enterprise Application Platform 6.
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
+
+Configure Maven
+---------------
+
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
+
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Full Profile
+---------------
-## Deploying the application
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the full profile:
-First you need to start JBoss AS 7 (or JBoss Enterprise Application Platform 6)
-with a JMS connection factory in it.
+ For Linux: JBOSS_HOME/bin/standalone.sh -c standalone-full.xml
+ For Windows: JBOSS_HOME\bin\standalone.bat -c standalone-full.xml
+
-For JBoss AS 7 or JBoss Enterprise Application Platform 6:
+Build and Deploy the Quickstart
+-------------------------
- $JBOSS_HOME/bin/standalone.sh -c standalone-full.xml
+_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._
-or if you are using JBoss AS 7 or JBoss Enterprise Application Platform 6 on windows:
- $JBOSS_HOME/bin/standalone.bat -c standalone-full.xml
+#### Build and Deploy the Archive
-To deploy the application, you first need to produce the archive to deploy using
-the following Maven goal:
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
- mvn package
+ mvn clean package jboss-as:deploy
-You can now deploy the artifact to JBoss AS by executing the following command:
+4. This will deploy `target/jboss-as-cmt.war` to the running instance of the server.
- mvn jboss-as:deploy
+#### Undeploy the Archive
-This will deploy `target/jboss-as-cmt.war` to the running instance of the AS.
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to undeploy the archive:
-The application will be running at the following URL <http://localhost:8080/jboss-as-cmt/>.
+ mvn jboss-as:undeploy
-After a user is successfully added to the database, a message is produced container the
-details of the user. An example MDB will dequeue this message and print the contents as such:
+
+Access the application
+---------------------
+
+The application will be running at the following URL: <http://localhost:8080/jboss-as-cmt/>.
+
+You will be presented with a simple form for adding customers to a database.
+
+After a user is successfully added to the database, a message is produced container the details of the user. An example MDB will dequeue this message and print the contents as such:
Received Message: Created customer named: Tom with ID: 1
-To undeploy from JBoss AS, run this command:
-
- mvn jboss-as:undeploy
-If you need to redeploy the war then ensure that you explicitly undeploy it first so that databases
-are cleaned up correctly.
-You can also start JBoss AS 7 and deploy the project using Eclipse. See the JBoss AS 7
-<a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a> for more information.
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
-## Using the application
-JBoss AS 7 comes with an H2 datasource by default. The example shows how to transactionally
-insert key value pairs into to this H2 database and demonstrates the requirements on the
-developer with respect to the JPA Entity Manager.
+Debug the Application
+------------------------------------
-To access the application type the following into a browser:
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
- http://localhost:8080/jboss-as-cmt/
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
-You will be presented with a simple form for adding customers to a database.
-## Downloading the sources and Javadocs
-If you want to be able to debug into the source code or look at the Javadocs
-of any library in the project, you can run either of the following two
-commands to pull them into your local repository. The IDE should then detect
-them.
- mvn dependency:sources
- mvn dependency:resolve -Dclassifier=javadoc
View
52 ejb-in-ear/README.md
@@ -21,11 +21,10 @@ The root `pom.xml` builds each of the subprojects in the above order and deploys
The example follows the common "Hello World" pattern. These are the steps that occur:
1. A JSF page asks the user for their name.
-2. On clicking _Greet_, the name is sent to a managed bean (`Greeter`).
-3. On setting the name, the `Greeter` invokes the `GreeterEJB`, which was injected to the managed bean (notice the field annotated with `@EJB`).
+2. On clicking _Greet_, the name is sent to a managed bean named `Greeter`.
+3. On setting the name, the `Greeter` invokes the `GreeterEJB`, which was injected to the managed bean. Notice the field annotated with `@EJB`.
4. The response from invoking the `GreeterEJB` is stored in a field (message) of the managed bean.
-5. The managed bean is annotated as `@SessionScoped`, so the same managed bean instance is used for the entire session. This ensures that the message is available when the page reloads and is
-displayed to the user.
+5. The managed bean is annotated as `@SessionScoped`, so the same managed bean instance is used for the entire session. This ensures that the message is available when the page reloads and is displayed to the user.
System requirements
-------------------
@@ -41,39 +40,40 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
-Start the JBoss Server
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
-------------------------
-Start the JBoss Enterprise Application Platform 6 or JBoss AS 7 Server with the web profile.
-
1. Open a command line and navigate to the root of the JBoss directory.
2. The following shows the command line to start the server with the web profile:
- For Linux: JBOSS_HOME/bin/standalone.sh
- For Windows: JBOSS_HOME\bin\standalone.bat
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
-Build and Deploy the application
+Build and Deploy the Quickstart
-------------------------
-1. Make sure your server is running.
-2. Open a command line and navigate to the root of the ejb-in-ear quickstart directory.
-3. Type the following in the command line:
- For JBoss Enterprise Application Platform 6, Maven user settings NOT configured:
+_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._
+
- mvn clean package jboss-as:deploy -s PATH_TO_QUICKSTARTS/example-settings.xml
+#### Build and Deploy the Archive
- For JBoss AS 7 or JBoss Enterprise Application Platform 6, Maven user settings configured:
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
- mvn clean package jboss-as:deploy
+ mvn clean package jboss-as:deploy
-4. This will build and deploy `ear/target/jboss-as-ejb-in-ear.ear`.
-5. To undeploy the application, run this command:
+4. This will deploy `target/jboss-as-ejb-in-ear.ear` to the running instance of the server.
- mvn jboss-as:undeploy
+#### Undeploy the Archive
-You can also use Eclipse to start the JBoss Enterprise Application Platform 6 or JBoss AS 7 server and deploy the project. See the <a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a> for more information.
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to undeploy the archive:
+ mvn jboss-as:undeploy
+
Access the application
---------------------
@@ -82,16 +82,12 @@ The application will be running at the following URL <http://localhost:8080/jbos
Enter a name in the input field and click the _Greet_ button to see the response.
-Importing the project into an IDE
-=================================
-
-If you created the project using the Maven archetype wizard in your IDE (Eclipse, NetBeans or IntelliJ IDEA), then there is nothing to do. You should already have an IDE project.
-Detailed instructions for using Eclipse with JBoss AS 7 are provided in the JBoss AS 7 <a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a>.
-If you created the project from the commandline using archetype:generate, then you need to import the project into your IDE. If you are using NetBeans 6.8 or IntelliJ IDEA 9, then all you have to do is open the project as an existing project. Both of these IDEs recognize Maven projects natively.
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
-If you created the project from the command line using `archetype:generate`, you need to import the project into your IDE. If you are using NetBeans 6.8 or IntelliJ IDEA 9, all you have to do is open the project as an existing project. Both of these IDEs recognize Maven projects natively.
Debug the Application
---------------------
View
94 ejb-in-war/README.md
@@ -5,82 +5,82 @@ Author: Paul Robinson
What is it?
-----------
-This example demonstrates the deployment of an *EJB 3.1* bean bundled in a war archive for deployment to *JBoss AS 7*.
+This example demonstrates the deployment of an *EJB 3.1* bean bundled in a war archive for deployment to *JBoss Enterprise Application Platform 6* or *JBoss AS 7*.
The example follows the common "Hello World" pattern. These are the steps that occur:
1. A JSF page asks the user for their name.
-2. On clicking submit, the name is sent to a managed bean (Greeter).
-3. On setting the name, the Greeter invokes the GreeterEJB, which was injected to the managed bean (notice the field annotated with @EJB).
-4. The response from invoking the GreeterEJB is stored in a field (message) of the managed bean.
-5. The managed bean is annotated as @SessionScoped, so the same managed bean instance is used for the entire session. This ensures that the message is available when the page reloads and is
-displayed to the user.
+2. On clicking submit, the name is sent to a managed bean namde `Greeter`.
+3. On setting the name, the `Greeter` invokes the `GreeterEJB`, which was injected to the managed bean. Notice the field annotated with @EJB.
+4. The response from invoking the `GreeterEJB` is stored in a field (message) of the managed bean.
+5. The managed bean is annotated as `@SessionScoped`, so the same managed bean instance is used for the entire session. This ensures that the message is available when the page reloads and is displayed to the user.
System requirements
-------------------
-All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven
-3.0 or better.
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
-The application this project produces is designed to be run on a JBoss AS 7 or JBoss Enterprise Application Platform 6.
-The following instructions target JBoss AS 7, but they also apply to JBoss Enterprise Application Platform 6.
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
-With the prerequisites out of the way, you're ready to build and deploy.
-Deploying the application
+Configure Maven
+-------------
+
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
+
+
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
-------------------------
-First you need to start JBoss AS 7 (or JBoss Enterprise Application Platform 6). To do this, run
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
- $JBOSS_HOME/bin/standalone.sh
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
-or if you are using windows
- $JBOSS_HOME/bin/standalone.bat
+Build and Deploy the Quickstart
+-------------------------
-To deploy the application, you first need to produce the archive to deploy using
-the following Maven goal:
+_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._
- mvn package
-You can now deploy the artifact to JBoss AS by executing the following command:
+#### Build and Deploy the Archive
- mvn jboss-as:deploy
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
-This will deploy `target/jboss-as-ejb-in-war.war`.
+ mvn clean package jboss-as:deploy
-The application will be running at the following URL <http://localhost:8080/jboss-as-ejb-in-war>.
+4. This will deploy `target/jboss-as-ejb-in-war.war` to the running instance of the server.
-To undeploy from JBoss AS, run this command:
+#### Undeploy the Archive
- mvn jboss-as:undeploy
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to undeploy the archive:
+
+ mvn jboss-as:undeploy
+
+
+Access the application
+---------------------
+
+The application will be running at the following URL <http://localhost:8080/jboss-as-ejb-in-war>.
-You can also start JBoss AS 7 and deploy the project using Eclipse. See the JBoss AS 7
-<a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a>
-for more information.
-Importing the project into an IDE
-=================================
-If you created the project using the Maven archetype wizard in your IDE
-(Eclipse, NetBeans or IntelliJ IDEA), then there is nothing to do. You should
-already have an IDE project.
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
-Detailed instructions for using Eclipse with JBoss AS 7 are provided in the
-JBoss AS 7 <a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a>.
-If you created the project from the commandline using archetype:generate, then
-you need to import the project into your IDE. If you are using NetBeans 6.8 or
-IntelliJ IDEA 9, then all you have to do is open the project as an existing
-project. Both of these IDEs recognize Maven projects natively.
+Debug the Application
+------------------------------------
-Downloading the sources and Javadocs
-====================================
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
-If you want to be able to debug into the source code or look at the Javadocs
-of any library in the project, you can run either of the following two
-commands to pull them into your local repository. The IDE should then detect
-them.
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
- mvn dependency:sources
- mvn dependency:resolve -Dclassifier=javadoc
View
144 ejb-remote/README.md
@@ -5,65 +5,94 @@ Authors: Jaikiran Pai and Mike Musgrove
What is it?
-----------
-This example shows how to access an EJB from a remote Java client program. It
-demonstrates the use of *EJB 3.1* and *JNDI* in *JBoss AS 7*.
+This example shows how to access an EJB from a remote Java client application. It demonstrates the use of *EJB 3.1* and *JNDI* in *JBoss Enterprise Application Platform 6* or *JBoss AS 7*.
-There are two parts to the example: a server side component and a remote client program
-that accesses it. Each part is in its own standalone Maven module, however the quickstart
-does provide a top level module to simplify the packaging of the artifacts.
+There are two components to this example:
-The server component is comprised of a stateful and a stateless EJB. It provides both an EJB JAR
-that is deployed to the server and a JAR file containing the remote business interfaces required
-by the remote client application.
+1. A server side component:
+
+ The server component is comprised of a stateful and a stateless EJB. It provides both an EJB JAR that is deployed to the server and a JAR file containing the remote business interfaces required by the remote client application.
+2. A remote client application that accesses the server component.
+
+ The remote client application depends on the remote business interfaces from the server component. This application looks up the stateless and stateful beans via JNDI and invokes a number of methods on them.
+
+Each component is defined in its own standalone Maven module. The quickstart provides a top level Maven module to simplify the packaging of the artifacts.
-The remote client application depends on the remote business interfaces from the server component.
-This program looks up the stateless and stateful beans via JNDI and invokes a number of methods on
-them.
System requirements
-------------------
All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
-The application this project produces is designed to be run on a JBoss AS 7 or EAP 6.
-The following instructions target JBoss AS 7, but they also apply to JBoss EAP 6.
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
+
+Configure Maven
+---------------
-Building and deploying the application
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
+
+
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
-------------------------
-Follow these steps to build, deploy and run the quickstart.
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
+
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
-1. Start JBoss AS 7 (or EAP 6):
- $JBOSS_HOME/bin/standalone.sh
+Build and Deploy the Quickstart
+-------------------------
+
+Since this quickstart builds two separate components, you can not use the standard *Build and Deploy* commands used by most of the other quickstarts. You must follow these steps to build, deploy, and run this quickstart.
-2. Build and install the server side component.
+1. Make sure you have started the JBoss server. See the instructions in the previous section.
+2. Open a command line and navigate to the ejb-remote quickstart directory
+3. Build and install the server side component:
+ * Navigate to the server-side subdirectory:
- cd server-side/
- mvn clean install
+ cd server-side
+ * Build the EJB and client interfaces JARs and install them in your local Maven repository.
- This will build the EJB and client interfaces JARs, and install them in your local Maven repository.
+ For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured):
-3. Deploy the EJB JAR to your server
+ mvn clean install -s PATH_TO_QUICKSTARTS/example-settings.xml
- mvn jboss-as:deploy
+ For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured):
- This maven goal will deploy `server-side/target/jboss-as-ejb-remote-app.jar`. You can check the AS
-console to see information messages regarding the deployment.
+ mvn clean install
+ * Deploy the EJB JAR to your server. This maven goal will deploy `server-side/target/jboss-as-ejb-remote-app.jar`. You can check the JBoss server console to see information messages regarding the deployment.
+ mvn jboss-as:deploy
4. Build and run the client application
+ * Navigate to the server-side subdirectory:
+
+ cd ../client
+ * Compile the client code
+
+ For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured):
+
+ mvn clean compile -s PATH_TO_QUICKSTARTS/example-settings.xml
+
+ For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured):
+
+ mvn clean compile
+ * Execute the client application within Maven
- cd ../client
- mvn clean compile
- mvn exec:exec
-
- This will compile and execute the client application within Maven. Refer to `The Output` below.
-
-Note that you can also start JBoss AS 7 and deploy the project using Eclipse. See the JBoss AS 7
-<a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a>
-for more information.
-
-The Output
+ mvn exec:exec
+
+5. To undeploy the server side component from the JBoss server:
+ * Navigate to the server-side subdirectory:
+
+ cd ../server-side
+ * Type the following command:
+
+ mvn jboss-as:undeploy
+
+
+Investigate the Console Output
-------------------------
When the client application runs, it performs the following steps:
@@ -75,8 +104,6 @@ When the client application runs, it performs the following steps:
5. Sends several method invocations to the stateful bean to increment a field in the bean, displaying the result each time.
6. Sends several method invocations to the stateful bean to decrement a field in the bean, displaying the result each time.
-
-
The output in the terminal window will look like the following:
Obtained a remote stateless calculator for invocation
@@ -110,37 +137,34 @@ The output in the terminal window will look like the following:
Logging statements have been removed from this output here to make it clearer.
-Undeploy the Application
--------------------------
-
-To undeploy the server side component from JBoss AS:
- cd ../server-side
- mvn jboss-as:undeploy
+Build and Run The Quickstart as an Executable JAR
+-------------------------
+The remote client application can also be built as a standalone executable JAR with all of its dependencies.
-Build Executable JAR
--------------------------
+1. Open a command line and navigate to the ejb-remote/client quickstart directory
-The remote client application can also be built as a standalone executable JAR with all of it's
-dependencies.
+ cd client
+2. Type the following in the command line:
- cd client
- mvn clean assembly:assembly
+ mvn clean assembly:assembly
-You can then run the executable JAR using `java -jar`:
+4. You can then run the executable JAR using `java -jar`:
- java -jar target/jboss-as-quickstarts-ejb-remote-client-7.0.2-SNAPSHOT-jar-with-dependencies.jar
+ java -jar target/jboss-as-quickstarts-ejb-remote-client-7.0.2-SNAPSHOT-jar-with-dependencies.jar
+
+
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
-Downloading the sources and Javadocs
-====================================
-If you want to be able to debug into the source code or look at the Javadocs
-of any library in the project, you can run either of the following two
-commands to pull them into your local repository. The IDE should then detect
-them.
+Debug the Application
+------------------------------------
- mvn dependency:sources
- mvn dependency:resolve -Dclassifier=javadoc
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
View
104 ejb-security/README.md
@@ -2,66 +2,95 @@ ejb-security: Using JEE Declarative Security to Control Access to EJB 3
====================
Author: Sherif F. Makary
-This example demonstrates the use of JEE declarative security to control access to EJB 3 and Security in JBoss AS7 and JBoss Enterprise Application Platform 6.
-The example can be deployed using Maven from the command line or from Eclipse using JBoss Tools.
+What is it?
+-----------
+
+This example demonstrates the use of JEE declarative security to control access to EJB 3 and Security in *JBoss Enterprise Application Platform 6* or *JBoss AS 7*.
The following are the steps required to implement EJB security:
-1. Use the security domain `other` that is defined in the application server's default `standalone.xml`
-2. Add the user `user` with password `password` belonging to the role `guest` and realm `ApplicationRealm`. For more information regarding how to add a user using the "add-user" utility, please refer to the README in the root of the quickstarts
-3. A security domain reference for the `other` security domain is added to `WEB-INF/jboss-web.xml`
-4. A security constraint is added to `WEB-INF/web.xml`
-5. Security annotations are added to the EJB declaration
+1. Use the security domain `other` that is defined in the application server default `standalone.xml` configuration file.
+2. Add the user `quickstartUser` with password `quickstartPassword`, belonging to the role `guest` and realm `ApplicationRealm`. The procedure for adding a user is described below.
+3. A security domain reference for the `other` security domain is added to `WEB-INF/jboss-web.xml`.
+4. A security constraint is added to `WEB-INF/web.xml` .
+5. Security annotations are added to the EJB declaration.
+
+When you review the code, note the allowed user role `guest` in the annotation -`@RolesAllowed`- is the same as the user role defined in step 2 above.
+
+System requirements
+-------------------
+
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
+
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
+
+Configure Maven
+---------------
+
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
+
+
+Add an Application User
+---------------
+
+This quickstart uses a secured management interface and requires that you create an application user to access the running application. Instructions to set up an Application user can be found here: [Add an Application User](../README.html/#addapplicationuser)
-Please note the allowed user role `guest` in the annotation -`@RolesAllowed`- is the same as the user role defined in step 2
-For more information, refer to the [Getting Started Developing Applications Guide](https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide).
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
+-------------------------
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
-## Deploying the Quickstart
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
-First you need to start JBoss AS 7 (or JBoss Enterprise Application Platform 6). To do this, run
- $JBOSS_HOME/bin/standalone.sh
+Build and Deploy the Quickstart
+-------------------------
-or if you are using Windows
+_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._
- $JBOSS_HOME/bin/standalone.bat
-To deploy the application, you first need to produce the archive:
+#### Build and Deploy the Archive
- mvn clean package
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
+ mvn clean package jboss-as:deploy
-You can now deploy the artifact to JBoss AS by executing the following command:
+4. This will deploy `target/jboss-as-ejb-security.war` to the running instance of the server.
- mvn jboss-as:deploy
+#### Undeploy the Archive
-This will deploy the application to the running instance of JBoss AS.
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to undeploy the archive:
-## Testing the Quickstart
+ mvn jboss-as:undeploy
+
+
+Access the application
+---------------------
The application will be running at the following URL <http://localhost:8080/jboss-as-ejb-security/>.
When you access the application, you should get a browser login challenge.
-After a successful login using `user`/`password`, the browser will display the following security info:
+After a successful login using `quickstartUser`/`quickstartPassword`, the browser will display the following security info:
Successfully called Secured EJB
- Principal : user
- Remote User : user
+ Principal : quickstartUser
+ Remote User : quickstartUser
Authentication Type : BASIC
-Change the role in the quickstart `/src/main/webapp/WEB-INF/classes/roles.properties` files to `notauthorized`.
-Rebuild the application using by typing the following command:
-
- mvn clean package
+You can now change the role in the quickstart `/src/main/webapp/WEB-INF/classes/roles.properties` files to `notauthorized`.
-Re-deploy the application by typing:
-
- mvn jboss-as:deploy
+Rebuild and redeploy the quickstart following the instructions under **Build and Deploy the Archive** above.
Refresh the browser, clear the active login, and you should get a security exception similar to the following:
@@ -70,3 +99,18 @@ Refresh the browser, clear the active login, and you should get a security excep
type Status report
message Access to the requested resource has been denied
description Access to the specified resource (Access to the requested resource has been denied) has been forbidden.
+
+
+
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
+
+
+Debug the Application
+------------------------------------
+
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
+
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
View
147 forge-from-scratch/README.md
@@ -5,13 +5,11 @@ Author: Lincoln Baxter
What is it?
-----------
-This is an example of creating a fully **Java EE compliant** project **using nothing
-but JBoss Forge.** Once generated, the sample project will be a standard Maven 3
-Java Web project with **JPA 2.0, EJB 3.1, CDI 1.0, JSF 2.0** views for creating, reading, updating
-and deleting records, and complete **JAX-RS** endpoints for all data Entities.
+This quickstart demonstrates how to create a fully **Java EE compliant** project using nothing but **JBoss Forge**.
-But that is not all! You can use Forge on your new or existing projects
-to continue enhancing any application.
+Once generated, the sample project will be a standard Maven 3, Java Web project with **JPA 2.0, EJB 3.1, CDI 1.0, JSF 2.0** with complete **JAX-RS** endpoints for all data Entities. It will also provide views to Create, Read, Update, and Delete records.
+
+But that is not all! You can use Forge on your new or existing projects to continue to enhance any application.
System requirements
-------------------
@@ -20,110 +18,113 @@ The application this project produces is designed to be run on JBoss Enterprise
All you need to build this project is Java 6.0 (Java SDK 1.6) or better, and an JBoss Developer Studio 5 or JBoss Forge version 1.0.0.Final (or higher).
-###JBoss Enterprise Application Platform 6
+### JBoss Enterprise Application Platform 6
+
+If you are using JBoss Enterprise Application Platform 6, Forge is available in JBoss Developer Studio 5.
-If you are using JBoss Enterprise Application Platform 6, Forge is available in JBoss Developer Studio 5. To show the Forge Console, navigate to _Window -> Show View -> Other…_, locate _Forge Console_ and click _OK_. Then click the _Start_ button in top right corner of the view.
+To show the Forge Console, navigate to _Window -> Show View -> Other_, locate _Forge Console_ and click _OK_. Then click the _Start_ button in top right corner of the view.
-###JBoss AS 7
+### JBoss AS 7
If you are using JBoss AS 7, you should install JBoss Forge version 1.0.0.Final or higher. Follow the instructions at [Installing Forge](https://docs.jboss.org/author/display/FORGE/Installation).
-Then, you need to launch Forge from your console
+Open a command line and navigate to the root directory of this quickstart.
- forge
+Launch Forge by typing the following command:
+
+ forge
+
-With the prerequisites out of the way, you are ready to build and deploy.
-Generating, Building, and Deploying the application
+
+Generate, Build, and Deploy the Application
-------------------------
-Change to the directory where this README.md file is located, using the `cd` command.
+In the Forge console, make sure you are in the directory where this README.md file is located:
- forge> cd /path/to/quickstart/forge-from-scratch/
+ forge> cd QUICKSTART_HOME/forge-from-scratch/
-Notice that there is a file called `generate.fsh` in this directory; run from Forge
-using the `run` command:
+Notice that there is a file in this directory named `generate.fsh`. Run this file from Forge using the `run` command:
forge> run generate.fsh
-This command will prompt you for the {project-name} (E.g: 'example'),
-and will also prompt for the top level package. This should be the domain for your
-organization. (E.g: 'com.example')
+This command will prompt you to enter a `project-name`, for example: 'example'
+
+It will also prompt you to enter the top level package. This should be the domain for your organization, for example: 'com.example'
+
+
+What Did This Create?
+-------------------
+This quickstart has created a native Java EE 6 application.
+
+After this command completes, look in your QUICKSTART_HOME/forge-from-scratch/ folder. You will see a folder with the same name as the `project-name` you entered in the prompt above. Browse through this project to see the code that was generated as a result of this command.
+
+For a full description of what was generated by running this script and details on the structure of the application, visit the [Forge UI Scaffolding Guide](https://docs.jboss.org/author/display/FORGE/UI+Scaffolding)
+
+
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
+-------------------------
+
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
+
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
-What did we create?
-========================
-This quickstart has set up a native Java EE 6 application. After this command completes, look in your
-QUICKSTART_HOME/forge-from-scratch/ folder. You will see a folder with the same name as the project-name
-you entered in the prompt above. Browse through this project to see the code that was generated as a result of this command.
-For a full description of what was generated by running this script and details on the structure of the application,
-visit the [Forge UI Scaffolding Guide](https://docs.jboss.org/author/display/FORGE/UI+Scaffolding)
Deploy and test the newly generated application
-===============================================
-Next, you need to start JBoss AS 7 (or EAP 6). To do this, run
-
- $JBOSS_HOME/bin/standalone.sh
-
-or if you are using windows
-
- $JBOSS_HOME/bin/standalone.bat
+---------------------------
-To build the application, type 'build', then to deploy the application, use the
-'jboss-as-7' Forge plugin; just type:
+Make sure you have started the JBoss server. See the instructions in the previous section.
- forge> forge install-plugin jboss-as-7
- forge> as7 setup
- forge> as7 deploy
+To build the application,type the following command:
-This will deploy `target/{project-name}.war`.
-
-The application will be running at the following URL <http://localhost:8080/{project-name}/>.
-You may access it at this URL, just make sure to replace {project-name} with the name of the
-project you chose when running the script.
+ forge> build
+
+To deploy the application, use the `jboss-as-7` Forge plugin. Type the following commands:
+
+ forge> forge install-plugin jboss-as-7
+ forge> as7 setup
+ forge> as7 deploy
+
+This will deploy `target/YOUR_PROJECT_NAME.war`.
+
+The application will be running at the following URL: <http://localhost:8080/YOUR_PROJECT_NAME/>.
+
+Be sure to replace YOUR_PROJECT_NAME with the name of the project you chose when running the script.
To undeploy from JBoss AS, run this command:
forge> as7 undeploy
-You can also start JBoss AS 7 and deploy the project using Eclipse. See the JBoss AS 7
-Getting Started Guide for Developers for more information.
-
Next Steps
-============================
-Open `generate.fsh` and take a look inside! There is not much magic happening here. All of the
-commands used to generate this project are clearly listed just as if they were typed by your
-own hands.
+-------
+
+Open `generate.fsh` and take a look inside! There is not much magic happening here. All of the commands used to generate this project are clearly listed just as if they were typed by your own hands.
+
+Play around with creating more entities, relationships, UI, and generating JAX-RS endpoints,all with just a few simple commands.
-Play around with creating more entities, relationships, UI, and generating JAX-RS endpoints,
-all with just a few simple commands.
Explore plugins!
-================
-Forge has a rich plugin ecosystem. Want to deploy your application to the Cloud?
-Use the Forge Openshift Express plugin: http://github.com/forge/plugin-openshift-express/
+----------------
+
+Forge has a rich plugin ecosystem. Want to deploy your application to the Cloud? Use the Forge Openshift Express plugin: http://github.com/forge/plugin-openshift-express/
To see a full list of avaialable plugins, make sure that you have an active internet connection and type:
forge> forge find-plugin *
-Importing the project into an IDE
-=================================
-If you created the project using the Forge Console in JBoss Tools, then there is
-nothing to do; the projet should already be imported.
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
-If you created the project from a Forge console running outside of the IDE, then
-you need to import the project into your IDE. If you are using NetBeans 6.8 or
-IntelliJ IDEA 9, then all you have to do is open the project as an existing
-project. Both of these IDEs recognize Maven projects natively.
-Downloading the sources and Javadocs
-====================================
+Debug the Application
+------------------------------------
-If you want to be able to debug into the source code or look at the Javadocs
-of any library in the project, you can run either of the following two
-commands to pull them into your local repository. The IDE should then detect
-them.
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
- forge> mvn dependency:sources
- forge> mvn dependency:resolve -Dclassifier=javadoc
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
View
73 greeter/README.md
@@ -5,26 +5,75 @@ Author: Pete Muir
What is it?
-----------
-This example demonstrates the use of *CDI 1.0*, *JPA 2.0*, *JTA 1.1*, *EJB 3.1* and *JSF 2.0* in
-*JBoss AS 7* or *JBoss Enterprise Application Platform 6*.
+This example demonstrates the use of *CDI 1.0*, *JPA 2.0*, *JTA 1.1*, *EJB 3.1* and *JSF 2.0* in *JBoss Enterprise Application Platform 6* or *JBoss AS 7*.
+
System requirements
-------------------
-The example can be deployed using Maven from the command line or from Eclipse using
-JBoss Tools.
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
+
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
+
+Configure Maven
+---------------
+
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
+
+
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
+-------------------------
+
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
-To set up Maven or JBoss Tools in Eclipse, refer to the
-<a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a>.
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
-Deploying the application
+
+Build and Deploy the Quickstart
-------------------------
-To deploy the application to JBoss AS 7 (or JBoss Enterprise Application Platform 6) using Maven, start the JBoss application server and type
+_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._
+
+
+#### Build and Deploy the Archive
+
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
+
+ mvn clean package jboss-as:deploy
+
+4. This will deploy `target/jboss-as-greeter.war` to the running instance of the server.
+
+#### Undeploy the Archive
+
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to undeploy the archive:
+
+ mvn jboss-as:undeploy
+
+
+Access the application
+---------------------
+
+The application will be running at the following URL: <http://localhost:8080/jboss-as-greeter>.
+
+
+
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
+
+
+Debug the Application
+------------------------------------
- mvn package jboss-as:deploy
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
-The application is deployed to <http://localhost:8080/jboss-as-greeter>.
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
-You can read more details in the
-<a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a>.
View
89 h2-console/README.md
@@ -5,83 +5,74 @@ Author: Pete Muir
What is it?
-----------
-JBoss AS bundles H2 as an in memory, in process database. H2 is written in Java so
-can run on any platform JBoss AS runs.
+JBoss AS bundles H2 as an in-memory, in-process database. H2 is written in Java so can run on any platform JBoss AS runs.
-This is quickstart shows you how to use the H2 console with JBoss AS. It reuses the
-jboss-as-greeter quickstart as a GUI for entering data.
+This is quickstart shows you how to use the H2 console with JBoss Enterprise Platform 6 or JBoss AS 7. It uses the `greeter` quickstart as a GUI for entering data.
System requirements
-------------------
-All you need to follow these instructions is Java 6.0 (Java SDK 1.6) or better, Maven
-3.0 or better, and the jboss-as-greeter quickstart (normally located in `../greeter`).
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
-The application this project produces is designed to be run on a JBoss AS 7 or EAP 6.
-The following instructions target JBoss AS 7, but they also apply to JBoss EAP 6.
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
-Note: Unlike most of the quickstarts, you will require JBoss AS 7.1.x or later to use this quickstart.
+Configure Maven
+---------------
-Finally, you'll need the H2 Console. You can download it from <http://www.h2database.com/html/download.html>. We recommend using the platform independent zip.
-
-With the prerequisites out of the way, you're ready to build and deploy.
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
-Deploying the sample jboss-as-greeter application
--------------------------------------------------
-
-First you need to start JBoss AS 7 (or EAP 6). To do this, run
-
- $JBOSS_HOME/bin/standalone.sh
-
-or if you are using windows
+
+Additional requirements
+-----------------------
+
+You will need the H2 Console to run test this quickstart. You can download it from <http://www.h2database.com/html/download.html>. We recommend using the platform independent zip.
- $JBOSS_HOME/bin/standalone.bat
-To deploy the application, you first need to produce the archive to deploy using
-the following Maven goal. Assuming the jboss-as-greeter application is in `../greeter`:
+Prerequisites
+-----------
- mvn package -f ../greeter/pom.xml
+This quickstart depends on the deployment of the 'greeter' quickstart. Before running this quickstart, see the [greeter README](../greeter/README.html) file for details on how to deploy it.
-You can now deploy the artifact to JBoss AS by executing the following command:
+You can verify the deployment of the `greeter` quickstart by accessing the following URL: <http://localhost:8080/jboss-as-greeter>
- mvn jboss-as:deploy -f ../greeter/pom.xml
+Note: Unlike most of the quickstarts, this one requires JBoss AS 7.1.x or later.
-This will deploy `target/jboss-as-greeter.war`.
-
-The application will be running at the following URL <http://localhost:8080/jboss-as-greeter/>.
-To undeploy from JBoss AS, run this command:
+Deploy the H2 Console
+------------------------
- mvn jboss-as:undeploy -f ../greeter/pom.xml
+This quickstart comes bundled with a version of the H2 Console built for JBoss Enterprise Application Platform 6 and JBoss AS 7. The changes that have been made to the stock console are described below.
-You can also start JBoss AS 7 and deploy the project using Eclipse. See the JBoss AS 7
-<a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a>
-for more information.
-
-You can read more about the greeter application in the README.md for that project.
+Deploy the console by copying the `QUICKSTART_HOME/h2-console/h2console.war` to the `$JBOSS_HOME/standalone/deployments` directory.
-Deploying the H2 Console
-------------------------
-This quickstart comes bundled with a version of the H2 Console built for JBoss AS 7 (the changes to
-the stock console are discussed below). Deploy the console by copying the `h2console.war` to the `$JBOSS_HOME/standalone/deployments` directory. You can use the console by visiting <http://localhost:8080/h2console>.
+Access the H2 Console
+---------------------
+
+You can access the console at the following URL: <http://localhost:8080/h2console>.
-You need to enter the JDBC URL, and credentials. To access the "test" database that the greeter quickstart uses, use these details
+You need to enter the JDBC URL, and credentials. To access the "test" database that the `greeter` quickstart uses, enter these details:
-* JDBC URL `jdbc:h2:mem:test;DB_CLOSE_DELAY=-1`
-* User Name `sa`
-* Password `sa`
+* JDBC URL: `jdbc:h2:mem:test;DB_CLOSE_DELAY=-1`
+* User Name: `sa`
+* Password: `sa`
-Now, hit the Test Connection button, and make sure you can connect. If you can, go ahead and click Connect.
+Click on the *Test Connection* button to make sure you can connect. If you can, go ahead and click *Connect*.
-Now, let's take a look at the data added by the greeter application. Run the following SQL command
+Investigate the H2 Console
+-------------------------
+
+Take a look at the data added by the `greeter` application. Run the following SQL command:
select * from users;
-You should see the two seed users, and any you have added using the greeter application
+You should see the two users seeded by the `greeter` quickstart, plus any users you added when testing that application.
+
-Changes to the H2 Console for JBoss AS 7
+Changes to the H2 Console for JBoss Enterprise Application Platform 6 and JBoss AS 7
----------------------------------------
-In order to make the H2 console run on JBoss AS 7 we had to add a dependency on the H2 module from JBoss AS (added to the META-INF/MANIFEST.MF), and remove the H2 libraries from the war. The rebuilt console is provided in this quickstart.
+To make the H2 console run on JBoss Enterprise Application Platform 6 and JBoss AS 7, the H2 libraries were removed from the WAR and a dependency on the H2 module was added to the META-INF/MANIFEST.MF fle. The rebuilt console is provided with this quickstart.
+
View
99 helloworld-errai/README.md
@@ -1,73 +1,94 @@
helloworld-errai: Hello World Using the Errai Framework
=======================================================
+Author: Jonathon Fuerth
+
What is it?
-----------
-This example demonstrates the use of *CDI 1.0* and *JAX-RS* in *JBoss AS 7* with a GWT front-end client.
-GWT is basically a typesafe, statically checked programming model for producing HTML5+CSS3+JavaScript
-front-ends. In this example, we use RESTful services on the backend. The client communicates with the
-backend using stubs that are generated based on the JAX-RS resources when the application is compiled.
+This example demonstrates the use of *CDI 1.0* and *JAX-RS* in *JBoss Enterprise Application Platform 6* or *JBoss AS 7* with a GWT front-end client.
-You can test the REST endpoint at the URL http://localhost:8080/jboss-as-helloworld-errai/hello/json/David
+GWT is basically a typesafe, statically checked programming model for producing HTML5+CSS3+JavaScript front-ends. In this example, we use RESTful services on the backend. The client communicates with the backend using stubs that are generated based on the JAX-RS resources when the application is compiled.
+You can test the REST endpoint at the URL http://localhost:8080/jboss-as-helloworld-errai/hello/json/David
System requirements
-------------------
-All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven
-3.0 or better.
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
+
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
-The application this project produces is designed to be run on a JBoss AS 7.
-NOTE:
-This project retrieves artifacts from the JBoss Community Maven repository, a
-superset of the Maven central repository.
+Configure Maven
+---------------
-With the prerequisites out of the way, you're ready to build and deploy.
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
-Deploying the Application
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
-------------------------
+
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
+
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
+
-First you need to start JBoss AS 7. To do this, run
-
- $JBOSS_HOME/bin/standalone.sh
-
-or if you are using windows
-
- $JBOSS_HOME/bin/standalone.bat
+Build and Deploy the Quickstart
+-------------------------
-To deploy the application, you first need to produce the archive to deploy using
-the following Maven goal:
+_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._
- mvn clean package
-You can now deploy the artifact to JBoss AS by executing the following command:
+#### Build and Deploy the Archive
- mvn jboss-as:deploy
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
-This will deploy `target/jboss-as-helloworld-errai.war`.
-
-The application will be running at the following URL <http://localhost:8080/jboss-as-helloworld-errai/>.
+ mvn clean package jboss-as:deploy
-To undeploy from JBoss AS, run this command:
+4. This will deploy `target/jboss-as-helloworld-errai.war` to the running instance of the server.
- mvn jboss-as:undeploy
+#### Undeploy the Archive
-You can also start JBoss AS 7 and deploy the project using Eclipse. See the JBoss AS 7
-Getting Started Guide for Developers for more information.
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to undeploy the archive:
+ mvn jboss-as:undeploy
-Running the Application in GWT Dev Mode
+
+Access the application
+---------------------
+
+The application will be running at the following URL: <http://localhost:8080/jboss-as-helloworld-errai/>.
+
+
+Run the Application in GWT Dev Mode
---------------------------------------
-GWT Dev Mode provides an edit-save-refresh development experience. If you plan to try
-modifying this demo, we recommend you start the application in Dev Mode so you don't
-have to repackage the whole application every time you change it.
+GWT Dev Mode provides an edit-save-refresh development experience. If you plan to modify this demo, we recommend you start the application in Dev Mode so you don't have to repackage the entire application every time you change it.
+
+1. Deploy the WAR file and start the JBoss Server as described above.
+2. Open a command line and navigate to the helloworld-errai quickstart directory
+3. Execute the following command:
+
+ mvn gwt:run
+
+
+
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
+
-Deploy the war file and start JBoss AS 7 as described above.
+Debug the Application
+------------------------------------
-Then execute the command:
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
- mvn gwt:run
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
View
94 helloworld-gwt/README.md
@@ -6,68 +6,88 @@ What is it?
-----------
This example demonstrates the use of *CDI 1.0* and *JAX-RS* in *JBoss AS 7* or *JBoss Enterprise Application Platform 6* with a GWT front-end client.
-GWT is basically a typesafe, statically checked programming model for producing HTML5+CSS3+JavaScript
-front-ends. In this example, we use RESTful services on the backend.
+GWT is basically a typesafe, statically checked programming model for producing HTML5+CSS3+JavaScript front-ends. In this example, we use RESTful services on the backend.
You can test the REST endpoint at the URL http://localhost:8080/jboss-as-helloworld-gwt/hello/json/David
-
System requirements
-------------------
-All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven
-3.0 or better.
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
+
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
-The application this project produces is designed to be run on a JBoss AS 7.
-NOTE:
-This project retrieves artifacts from the JBoss Community Maven repository, a
-superset of the Maven central repository.
+Configure Maven
+---------------
-With the prerequisites out of the way, you're ready to build and deploy.
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
-Deploying the Application
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
-------------------------
+
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
+
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
+
-First you need to start JBoss AS 7 or JBoss Enterprise Application Platform 6. To do this, run
-
- $JBOSS_HOME/bin/standalone.sh
-
-or if you are using windows
-
- $JBOSS_HOME/bin/standalone.bat
+Build and Deploy the Quickstart
+-------------------------
-To deploy the application, you first need to produce the archive to deploy using
-the following Maven goal:
+_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._
- mvn clean package
-You can now deploy the artifact to JBoss AS by executing the following command:
+#### Build and Deploy the Archive
- mvn jboss-as:deploy
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
-This will deploy `target/jboss-as-helloworld-gwt.war`.
-
-The application will be running at the following URL <http://localhost:8080/jboss-as-helloworld-gwt/>.
+ mvn clean package jboss-as:deploy
+
+4. This will deploy `target/jboss-as-helloworld-gwt.war` to the running instance of the server.
+
+#### Undeploy the Archive
-To undeploy from JBoss AS, run this command:
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to undeploy the archive:
- mvn jboss-as:undeploy
+ mvn jboss-as:undeploy
-You can also start JBoss AS 7 and deploy the project using Eclipse. See the JBoss AS 7
-<a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a> for more information.
+Access the application
+---------------------
-Running the Application in GWT Dev Mode
+The application will be running at the following URL: <http://localhost:8080/jboss-as-helloworld-gwt/>.
+
+
+Run the Application in GWT Dev Mode
---------------------------------------
-GWT Dev Mode provides an edit-save-refresh development experience. If you plan to try
-modifying this demo, we recommend you start the application in Dev Mode so you don't
-have to repackage the whole application every time you change it.
+GWT Dev Mode provides an edit-save-refresh development experience. If you plan to modify this demo, we recommend you start the application in Dev Mode so you don't have to repackage the entire application every time you change it.
+
+1. Deploy the WAR file and start the JBoss Server as described above.
+2. Open a command line and navigate to the helloworld-errai quickstart directory
+3. Execute the following command:
+
+ mvn gwt:run
+
+
+
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
+
+
+Debug the Application
+------------------------------------
-Deploy the war file and start JBoss AS 7 as described above.
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
-Then execute the command:
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
- mvn gwt:run
View
39 helloworld-jms/README.md
@@ -13,8 +13,6 @@ It contains the following:
2. A message consumer that receives message from a JMS destination deployed to a JBoss Enterprise Application Platform 6 or JBoss AS 7 server.
-This quickstart can be run from the Maven command line, or from the Eclipse environment.
-
System requirements
-------------------
@@ -35,11 +33,14 @@ Add an Application User
This quickstart uses secured management interfaces and requires that you create an application user to access the running application. Instructions to set up the quickstart application user can be found here: [Add an Application User](../README.html/#addapplicationuser)
-Start the JBoss Server
--------------------------
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Full Profile
+---------------
-This quickstart requires a running server. Follow the instructions here to [Start the JBoss Server with the _full_ profile](../README.html/#startserverfull).
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the full profile:
+ For Linux: JBOSS_HOME/bin/standalone.sh -c standalone-full.xml
+ For Windows: JBOSS_HOME\bin\standalone.bat -c standalone-full.xml
Build and Deploy the Quickstart
@@ -49,21 +50,25 @@ To run the quickstart from the command line:
1. Make sure you have started the JBoss server. See the instructions in the previous section.
-2. Open a command line and navigate to the root of the directory of the helloworld-jms quickstart directory:
+2. Open a command line and navigate to the root of the helloworld-jms quickstart directory:
cd PATH_TO_QUICKSTARTS/helloworld-jms
3. Type the following command to compile and execute the quickstart:
- For JBoss Enterprise Application Platform 6, Maven user settings NOT configured:
+ For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured):
mvn clean compile exec:java -s PATH_TO_QUICKSTARTS/example-settings.xml
- For JBoss AS 7 or JBoss Enterprise Application Platform 6, Maven user settings configured:
+ For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured):
mvn clean compile exec:java
+
-4. If the maven command is successful, with the default configuration you will see output similar to this:
+Investigate the Console Output
+-------------------------
+
+If the maven command is successful, with the default configuration you will see output similar to this:
Mar 14, 2012 1:38:58 PM org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
INFO: Attempting to acquire connection factory "jms/RemoteConnectionFactory"
@@ -78,12 +83,13 @@ To run the quickstart from the command line:
Mar 14, 2012 1:38:58 PM org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
INFO: Received message with content Hello, World!
-5. The example provides for a certain amount of customization for the `mvn:exec` plugin using the system properties described in the next section.
Optional Properties
-------------------
+The example provides for a certain amount of customization for the `mvn:exec` plugin using the system properties.
+
* `username`
This username is used for both the JMS connection and the JNDI look-up. Instructions to set up the quickstart application user can be found here: [Add an Application User](../README.html/#addapplicationuser).
@@ -128,4 +134,17 @@ Optional Properties
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
+
+
+Debug the Application
+------------------------------------
+
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
+
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
+
View
86 helloworld-jsf/README.md
@@ -5,64 +5,76 @@ Author: Brian Leathem
What is it?
-----------
-This is your project! It's a sample, deployable Maven 3 project to help you
-get your foot in the door developing with Java EE 6 on JBoss AS 7 or EAP 6. This
-project is setup to allow you to create a compliant Java EE 6 application
-using JSF 2.0, CDI 1.0, and RichFaces 4.1. In the example, a standard JSF
-h:inputText component is ajax enabled using the RichFaces a4j:ajax tag,
-triggering the application server to re-render a sub-section of the page on
-a browser event.
+This project demonstrates how to create a Java EE 6 compliant application using JSF 2.0, CDI 1.0, and RichFaces 4.1.
+
+In this example, a standard JSF `h:inputText` component is AJAX enabled using the RichFaces `a4j:ajax tag`. This triggers the application server to re-render only a subsection of the page on a browser event.
+
System requirements
-------------------
-All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven
-3.0 or better.
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
+
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
+
+Configure Maven
+---------------
+
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
-The application this project produces is designed to be run on a JBoss AS 7 or EAP 6.
-The following instructions target JBoss AS 7, but they also apply to JBoss EAP 6.
-With the prerequisites out of the way, you're ready to build and deploy.
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Web Profile
+-------------------------
+
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the web profile:
+
+ For Linux: JBOSS_HOME/bin/standalone.sh
+ For Windows: JBOSS_HOME\bin\standalone.bat
-Deploying the application
+
+Build and Deploy the Quickstart
-------------------------
-First you need to start JBoss AS 7 (or EAP 6). To do this, run
+_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._
+
+
+#### Build and Deploy the Archive
- $JBOSS_HOME/bin/standalone.sh
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
-or if you are using windows
+ mvn clean package jboss-as:deploy
- $JBOSS_HOME/bin/standalone.bat
+4. This will deploy `target/jboss-as-helloworld-jsf.war` to the running instance of the server.
-To deploy the application, you first need to produce the archive to deploy using
-the following Maven goal:
+#### Undeploy the Archive
- mvn package
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to undeploy the archive:
-You can now deploy the artifact to JBoss AS by executing the following command:
+ mvn jboss-as:undeploy
+
- mvn jboss-as:deploy
+Access the application
+---------------------
-This will deploy `target/jboss-as-helloworld-jsf.war`.
+The application will be running at the following URL: <http://localhost:8080/jboss-as-helloworld-jsf/>.
-The application will be running at the following URL <http://localhost:8080/jboss-as-helloworld-jsf/>.
-To undeploy from JBoss AS, run this command:
- mvn jboss-as:undeploy
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.html/#useeclipse)
-You can also start JBoss AS 7 and deploy the project using Eclipse. See the JBoss AS 7
-<a href="https://docs.jboss.org/author/display/AS71/Getting+Started+Developing+Applications+Guide" title="Getting Started Developing Applications Guide">Getting Started Developing Applications Guide</a>
-for more information.
-Downloading the sources and Javadocs
-====================================
+Debug the Application
+------------------------------------
-If you want to be able to debug into the source code or look at the Javadocs
-of any library in the project, you can run either of the following two
-commands to pull them into your local repository. The IDE should then detect
-them.
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
- mvn dependency:sources
- mvn dependency:resolve -Dclassifier=javadoc
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
View
78 helloworld-mdb/README.md
@@ -7,41 +7,68 @@ What is it?
This example demonstrates the use of *JMS 1.1* and *EJB 3.1 Message-Driven Bean* in JBoss AS 7.1.0.
+This project creates a queue named `HELLOWORLDMDBQueue` which is bound in JNDI as `java:/queue/HELLOWORLDMDBQueue`.
+
+
System requirements
-------------------
-All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven
-3.0 or better.
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
+
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.
-The application this project produces is designed to be run on a JBoss AS 7 or JBoss Enterprise Application Platform 6.
-This Project will use the provided connection factory named `InVmConnectionFactory` which is bound into JNDI as `java:/ConnectionFactory` and a queue named `testQueue` which is bound into JNDI as `queue/test`.
+Configure Maven
+---------------
+
+If you have not yet done so, you must [Configure Maven](../README.html/#mavenconfiguration) before testing the quickstarts.
+
-With the prerequisites out of the way, you're ready to build and deploy.
+Start JBoss Enterprise Application Platform 6 or JBoss Application Server 7 with the Full Profile
+---------------
-Deploying the application
+1. Open a command line and navigate to the root of the JBoss directory.
+2. The following shows the command line to start the server with the full profile:
+
+ For Linux: JBOSS_HOME/bin/standalone.sh -c standalone-full.xml
+ For Windows: JBOSS_HOME\bin\standalone.bat -c standalone-full.xml
+
+
+Build and Deploy the Quickstart
-------------------------
-For JBoss AS 7 or JBoss Enterprise Application Platform 6:
+_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.html/#buildanddeploy) for complete instructions and additional options._
- On Linux run: $JBOSS_HOME/bin/standalone.sh -c standalone-full.xml
- On Windows run: $JBOSS_HOME/bin/standalone.bat -c standalone-full.xml
+#### Build and Deploy the Archive
-To deploy the application, you first need to produce the archive to deploy using
-the following Maven goal:
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to build and deploy the archive:
- mvn package
+ mvn clean package jboss-as:deploy
-You can now deploy the artifact to JBoss AS by executing the following command:
+4. This will deploy `target/jboss-as-helloworld-mdb.war` to the running instance of the server.
- mvn jboss-as:deploy
+#### Undeploy the Archive
-This will deploy `target/jboss-as-helloworld-mdb.war`.
-
-The application will be running at the following URL <http://localhost:8080/jboss-as-helloworld-mdb/HelloWorldMDBServletClient>.
+1. Make sure you have started the JBoss Server as described above.
+2. Open a command line and navigate to the root directory of this quickstart.
+3. Type this command to undeploy the archive:
-Go to the JBoss Application Server console or Server log and the result can look like this:
+ mvn jboss-as:undeploy
+
+
+Access the application
+---------------------
+
+The application will be running at the following URL: <http://localhost:8080/jboss-as-helloworld-mdb/>.
+
+
+Investigate the Server Console Output
+-------------------------
+
+Look at the JBoss Application Server console or Server log and you should see log messages like the following:
15:42:35,453 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldMDB] (Thread-47 (group:HornetQ-client-global-threads-1267410030)) Received Message: This is message 1
15:42:35,455 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldMDB] (Thread-46 (group:HornetQ-client-global-threads-1267410030)) Received Message: This is message 2