Skip to content
Browse files

Bring archetype READMEs in synch with the quickstarts

  • Loading branch information...
1 parent 7bb2312 commit e7b7d78fac7906e49c743bf6175de26fa63df000 @sgilda sgilda committed Apr 5, 2012
View
92 jboss-javaee6-webapp-archetype/src/main/resources/archetype-resources/README.md
@@ -0,0 +1,92 @@
+${artifactId}
+========================
+
+What is it?
+-----------
+
+This is your project! It is a sample, deployable Maven 3 project to help you get your foot in the door developing with Java EE 6 on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
+This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java.
+
+
+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.
+
+
+Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
+-------------------------
+
+1. Open a command line and navigate to the root of the JBoss server 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
+-------------------------
+
+_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._
+
+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/${artifactId}.war` to the running instance of the server.
+
+
+Access the application
+---------------------
+
+The application will be running at the following URL: <http://localhost:8080/${artifactId}/>.
+
+
+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. When you are finished testing, type this command to undeploy the archive:
+
+ mvn jboss-as:undeploy
+
+
+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._
+
+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:
+
+ mvn clean test -Parq-jbossas-remote
+
+
+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 jboss-javaee6-webapp-archetype/src/main/resources/archetype-resources/readme.md
@@ -1,86 +0,0 @@
-${artifactId}
-========================
-
-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 Enterprise Application Platform 6 or JBoss AS 7. This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to help you get your feet wet with database access in enterprise Java.
-
-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 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
--------------------------
-
-First you need to start JBoss Enterprise Application Platform 6 or JBoss AS 7. To do this, run
-
- $JBOSS_HOME/bin/standalone.sh
-
-or if you are using 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
-
-You can now deploy the artifact to JBoss AS by executing the following command:
-
- mvn jboss-as:deploy
-
-This will deploy `target/${artifactId}.war`.
-
-The application will be running at the following URL <http://localhost:8080/${artifactId}/>.
-
-To undeploy from JBoss AS, run this command:
-
- 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.
-
-Running the Arquillian tests
-============================
-
-By default, tests are configured to be skipped. The reason is that the sample
-test is an Arquillian test, which requires the use of a container. You can
-activate this test by selecting one of the container configuration provided
-for JBoss AS 7 (remote).
-
-To run the test in JBoss AS 7, first start a JBoss AS 7 instance. Then, run the
-test goal with the following profile activated:
-
- mvn clean test -Parq-jbossas-remote
-
-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 Getting Started Guide for Developers.
-
-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.
-
-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
92 jboss-javaee6-webapp-blank-archetype/src/main/resources/archetype-resources/README.md
@@ -0,0 +1,92 @@
+${artifactId}
+========================
+
+What is it?
+-----------
+
+This is your project! It is a sample, deployable Maven 3 project to help you get your foot in the door developing with Java EE 6 on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
+This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java.
+
+
+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.
+
+
+Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
+-------------------------
+
+1. Open a command line and navigate to the root of the JBoss server 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
+-------------------------
+
+_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._
+
+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/${artifactId}.war` to the running instance of the server.
+
+
+Access the application
+---------------------
+
+The application will be running at the following URL: <http://localhost:8080/${artifactId}/>.
+
+
+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. When you are finished testing, type this command to undeploy the archive:
+
+ mvn jboss-as:undeploy
+
+
+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._
+
+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:
+
+ mvn clean test -Parq-jbossas-remote
+
+
+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 jboss-javaee6-webapp-blank-archetype/src/main/resources/archetype-resources/readme.md
@@ -1,86 +0,0 @@
-${artifactId}
-========================
-
-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 Enterprise Application Platform 6 or JBoss AS 7. This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to help you get your feet wet with database access in enterprise Java.
-
-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 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
--------------------------
-
-First you need to start JBoss Enterprise Application Platform 6 or JBoss AS 7. To do this, run
-
- $JBOSS_HOME/bin/standalone.sh
-
-or if you are using 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
-
-You can now deploy the artifact to JBoss AS by executing the following command:
-
- mvn jboss-as:deploy
-
-This will deploy `target/${artifactId}.war`.
-
-The application will be running at the following URL <http://localhost:8080/${artifactId}/>.
-
-To undeploy from JBoss AS, run this command:
-
- 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.
-
-Running the Arquillian tests
-============================
-
-By default, tests are configured to be skipped. The reason is that the sample
-test is an Arquillian test, which requires the use of a container. You can
-activate this test by selecting one of the container configuration provided
-for JBoss AS 7 (remote).
-
-To run the test in JBoss AS 7, first start a JBoss AS 7 instance. Then, run the
-test goal with the following profile activated:
-
- mvn clean test -Parq-jbossas-remote
-
-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 Getting Started Guide for Developers.
-
-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.
-
-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
143 jboss-javaee6-webapp-ear-archetype/src/main/resources/archetype-resources/README.md
@@ -4,83 +4,120 @@ ${rootArtifactId}
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 Enterprise Application Platform 6 or JBoss AS 7. This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to help you get your feet wet with database access in enterprise Java.
+This is your project! It is a sample, deployable Maven 3 project to help you get your foot in the door developing with Java EE 6 on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
+This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java.
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
+---------------
-The application this project produces is designed to be run on a JBoss Enterprise Application Platform 6 or JBoss AS 7.
+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.
-Deploying the application
+Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------
+
+1. Open a command line and navigate to the root of the JBoss server 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 Enterprise Application Platform 6 or JBoss AS 7. To do this, run
-
- $JBOSS_HOME/bin/standalone.sh
-
-or if you are using windows
-
- $JBOSS_HOME/bin/standalone.bat
-S
-To deploy the application, you first need to produce the archive to deploy using
-the following Maven goal:
+Build and Deploy the Quickstart
+-------------------------
- mvn package
+_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._
-You can now deploy the artifact to JBoss AS by executing the following 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 build and deploy the archive:
- mvn jboss-as:deploy
+ mvn clean package jboss-as:deploy
+
+4. This will deploy `target/${rootArtifactId}.ear` to the running instance of the server.
+
+
+Access the application
+---------------------
-This will deploy `target/${rootArtifactId}.ear`.
-
The application will be running at the following URL <http://localhost:8080/${rootArtifactId}/>.
-To undeploy from JBoss AS, run this command:
+1. Enter a name, email address, and Phone nubmer in the input field and click the _Register_ button.
+2. If the data entered is valid, the new member will be registered and added to the _Members_ display list.
+3. If the data is not valid, you must fix the validation errors and try again.
+4. When the registration is successful, you will see a log message in the server console:
- mvn jboss-as:undeploy
+ Registering _the_name_you_entered_
+
+
+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. When you are finished testing, type this command to undeploy the archive:
+
+ mvn jboss-as:undeploy
+
+
+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._
+
+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:
+
+ mvn clean test -Parq-jbossas-remote
+
+
+Investigate the Console Output
+---------------------
+You should see the following console output when you run the tests:
+
+ Results :
+ Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
-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.
-
-Running the Arquillian tests
-============================
-By default, tests are configured to be skipped. The reason is that the sample
-test is an Arquillian test, which requires the use of a container. You can
-activate this test by selecting one of the container configuration provided
-for JBoss AS 7 (remote).
+Investigate the Server Console Output
+---------------------
+You should see messages similar to the following:
-To run the test in JBoss AS 7, first start a JBoss AS 7 instance. Then, run the
-test goal with the following profile activated:
+ INFO [org.jboss.as.server] (management-handler-thread - 9) JBAS018559: Deployed "test.war"
+ INFO [org.jboss.as.quickstarts.kitchensink_ear.controller.MemberRegistration] (http--127.0.0.1-8080-2) Registering Jane Doe
+ INFO [org.jboss.as.quickstarts.kitchensink_ear.test.MemberRegistrationTest] (http--127.0.0.1-8080-2) Jane Doe was persisted with id 1
+ INFO [org.jboss.weld.deployer] (MSC service thread 1-6) JBAS016009: Stopping weld service for deployment test.war
+ INFO [org.jboss.as.jpa] (MSC service thread 1-1) JBAS011403: Stopping Persistence Unit Service 'test.war#primary'
+ INFO [org.hibernate.tool.hbm2ddl.SchemaExport] (MSC service thread 1-1) HHH000227: Running hbm2ddl schema export
+ INFO [org.hibernate.tool.hbm2ddl.SchemaExport] (MSC service thread 1-1) HHH000230: Schema export complete
+ INFO [org.jboss.as.connector.subsystems.datasources] (MSC service thread 1-5) JBAS010409: Unbound data source [jboss/datasources/KitchensinkEarQuickstartTestDS]
+ INFO [org.jboss.as.server.deployment] (MSC service thread 1-6) JBAS015877: Stopped deployment test.war in 19ms
+ INFO [org.jboss.as.server] (management-handler-thread - 10) JBAS018558: Undeployed "test.war"
- mvn clean test -Parq-jbossas-remote
-Importing the project into an IDE
-=================================
+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 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 Getting Started Guide for Developers.
+Debug the Application
+---------------------
-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.
+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.
-Downloading the sources and Javadocs
-====================================
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
-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
143 jboss-javaee6-webapp-ear-blank-archetype/src/main/resources/archetype-resources/README.md
@@ -4,83 +4,120 @@ ${rootArtifactId}
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 Enterprise Application Platform 6 or JBoss AS 7. This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to help you get your feet wet with database access in enterprise Java.
+This is your project! It is a sample, deployable Maven 3 project to help you get your foot in the door developing with Java EE 6 on JBoss Enterprise Application Platform 6 or JBoss AS 7.
+
+This project is setup to allow you to create a compliant Java EE 6 application using JSF 2.0, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to introduce you to database access in enterprise Java.
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
+---------------
-The application this project produces is designed to be run on a JBoss Enterprise Application Platform 6 or JBoss AS 7.
+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.
-Deploying the application
+Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
-------------------------
+
+1. Open a command line and navigate to the root of the JBoss server 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 Enterprise Application Platform 6 or JBoss AS 7. To do this, run
-
- $JBOSS_HOME/bin/standalone.sh
-
-or if you are using windows
-
- $JBOSS_HOME/bin/standalone.bat
-S
-To deploy the application, you first need to produce the archive to deploy using
-the following Maven goal:
+Build and Deploy the Quickstart
+-------------------------
- mvn package
+_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._
-You can now deploy the artifact to JBoss AS by executing the following 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 build and deploy the archive:
- mvn jboss-as:deploy
+ mvn clean package jboss-as:deploy
+
+4. This will deploy `target/${rootArtifactId}.ear` to the running instance of the server.
+
+
+Access the application
+---------------------
-This will deploy `target/${rootArtifactId}.ear`.
-
The application will be running at the following URL <http://localhost:8080/${rootArtifactId}/>.
-To undeploy from JBoss AS, run this command:
+1. Enter a name, email address, and Phone nubmer in the input field and click the _Register_ button.
+2. If the data entered is valid, the new member will be registered and added to the _Members_ display list.
+3. If the data is not valid, you must fix the validation errors and try again.
+4. When the registration is successful, you will see a log message in the server console:
- mvn jboss-as:undeploy
+ Registering _the_name_you_entered_
+
+
+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. When you are finished testing, type this command to undeploy the archive:
+
+ mvn jboss-as:undeploy
+
+
+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._
+
+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:
+
+ mvn clean test -Parq-jbossas-remote
+
+
+Investigate the Console Output
+---------------------
+You should see the following console output when you run the tests:
+
+ Results :
+ Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
-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.
-
-Running the Arquillian tests
-============================
-By default, tests are configured to be skipped. The reason is that the sample
-test is an Arquillian test, which requires the use of a container. You can
-activate this test by selecting one of the container configuration provided
-for JBoss AS 7 (remote).
+Investigate the Server Console Output
+---------------------
+You should see messages similar to the following:
-To run the test in JBoss AS 7, first start a JBoss AS 7 instance. Then, run the
-test goal with the following profile activated:
+ INFO [org.jboss.as.server] (management-handler-thread - 9) JBAS018559: Deployed "test.war"
+ INFO [org.jboss.as.quickstarts.kitchensink_ear.controller.MemberRegistration] (http--127.0.0.1-8080-2) Registering Jane Doe
+ INFO [org.jboss.as.quickstarts.kitchensink_ear.test.MemberRegistrationTest] (http--127.0.0.1-8080-2) Jane Doe was persisted with id 1
+ INFO [org.jboss.weld.deployer] (MSC service thread 1-6) JBAS016009: Stopping weld service for deployment test.war
+ INFO [org.jboss.as.jpa] (MSC service thread 1-1) JBAS011403: Stopping Persistence Unit Service 'test.war#primary'
+ INFO [org.hibernate.tool.hbm2ddl.SchemaExport] (MSC service thread 1-1) HHH000227: Running hbm2ddl schema export
+ INFO [org.hibernate.tool.hbm2ddl.SchemaExport] (MSC service thread 1-1) HHH000230: Schema export complete
+ INFO [org.jboss.as.connector.subsystems.datasources] (MSC service thread 1-5) JBAS010409: Unbound data source [jboss/datasources/KitchensinkEarQuickstartTestDS]
+ INFO [org.jboss.as.server.deployment] (MSC service thread 1-6) JBAS015877: Stopped deployment test.war in 19ms
+ INFO [org.jboss.as.server] (management-handler-thread - 10) JBAS018558: Undeployed "test.war"
- mvn clean test -Parq-jbossas-remote
-Importing the project into an IDE
-=================================
+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 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 Getting Started Guide for Developers.
+Debug the Application
+---------------------
-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.
+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.
-Downloading the sources and Javadocs
-====================================
+ mvn dependency:sources
+ mvn dependency:resolve -Dclassifier=javadoc
-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

0 comments on commit e7b7d78

Please sign in to comment.
Something went wrong with that request. Please try again.