Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ctomc committed Feb 9, 2014
1 parent 78a3c64 commit 099de3e
Show file tree
Hide file tree
Showing 261 changed files with 1,300 additions and 1,323 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -4,7 +4,7 @@ Quickstarts Contributing Guide
Purpose of the quickstarts
--------------------------

- To demonstrate Java EE 6 technologies
- To demonstrate Java EE 7 technologies

- To provide developers with working examples and instructions that are easy to follow .

Expand Down
97 changes: 37 additions & 60 deletions README.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions RELEASE_PROCEDURE.md
Expand Up @@ -4,13 +4,13 @@ Quickstarts Release Procedure
Testing the quickstarts
-----------------------

Most of the quickstarts require JBoss Enterprise Application Platform or JBoss AS only in standalone mode. Some require the "standalone-full" profile, some require XTS, some require Postgres and some require other quickstarts to be deployed. Profiles are used in the root POM to separate out these groups, allowing you to test the quickstarts easily. For example, to run those that require only standalone mode:
Most of the quickstarts require WildFly 8 only in standalone mode. Some require the "standalone-full" profile, some require XTS, some require Postgres and some require other quickstarts to be deployed. Profiles are used in the root POM to separate out these groups, allowing you to test the quickstarts easily. For example, to run those that require only standalone mode:

mvn clean install jboss-as:deploy jboss-as:undeploy -Parq-jbossas-remote -P-requires-postgres,-requires-full,-complex-dependencies,-requires-xts
mvn clean install wildfly:deploy wildfly:undeploy -Parq-jbossas-remote -P-requires-postgres,-requires-full,-complex-dependencies,-requires-xts

Or, to run those only those quickstarts that require the full profile

mvn clean install jboss-as:deploy jboss-as:undeploy -Parq-jbossas-remote -P-requires-postgres,-default,-complex-dependencies,-requires-xts
mvn clean install wildfly:deploy wildfly:undeploy -Parq-jbossas-remote -P-requires-postgres,-default,-complex-dependencies,-requires-xts

And so on.

Expand Down
4 changes: 2 additions & 2 deletions bean-validation/README.md
Expand Up @@ -20,7 +20,7 @@ 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.
The application this project produces is designed to be run on WildFly 8.


Configure Maven
Expand All @@ -29,7 +29,7 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.md#mavenconfiguration) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
Start WildFly 8 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss server directory.
Expand Down
12 changes: 6 additions & 6 deletions bean-validation/pom.xml
Expand Up @@ -67,11 +67,11 @@

<dependencyManagement>
<dependencies>
<!-- JBoss distributes a complete set of Java EE 6 APIs including a Bill
<!-- JBoss distributes a complete set of Java EE 7 APIs including a Bill
of Materials (BOM). A BOM specifies the versions of a "stack" (or a collection)
of artifacts. We use this here so that we always get the correct versions
of artifacts. Here we use the jboss-javaee-6.0-with tools stack (you can read this as
the JBoss stack of the Java EE 6 APIs, with some extras tools for your project, such
the JBoss stack of the Java EE 7 APIs, with some extras tools for your project, such
as Arquillian for testing) -->
<dependency>
<groupId>org.jboss.bom</groupId>
Expand All @@ -93,16 +93,16 @@
<dependencies>

<!-- First declare the APIs we depend on and need for compilation.
All of them are provided by JBoss AS 7 -->
All of them are provided by WildFly 8 -->

<!-- Import the CDI API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the CDI API, we use provided scope as the API is included in WildFly 8 -->
<dependency>
<groupId>javax.enterprise</groupId>
<artifactId>cdi-api</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the JPA API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the JPA API, we use provided scope as the API is included in WildFly 8 -->
<dependency>
<groupId>org.hibernate.javax.persistence</groupId>
<artifactId>hibernate-jpa-2.0-api</artifactId>
Expand All @@ -111,7 +111,7 @@

<!-- JSR-303 (Bean Validation) Implementation -->
<!-- Provides portable constraints such as @Email -->
<!-- Hibernate Validator is shipped in JBoss AS 7 -->
<!-- Hibernate Validator is shipped in WildFly 8 -->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
Expand Down
Expand Up @@ -65,7 +65,7 @@ public static Archive<?> createTestArchive() {
.addAsWebInfResource("test-ds.xml", "test-ds.xml");
}

// Get configured validator directly from JBoss AS 7 environment
// Get configured validator directly from WildFly 8 environment
@Inject
Validator validator;

Expand Down
2 changes: 1 addition & 1 deletion bean-validation/src/test/resources/arquillian.xml
Expand Up @@ -27,7 +27,7 @@
<!-- Force the use of the Servlet 3.0 protocol with all containers, as it is the most mature -->
<defaultProtocol type="Servlet 3.0" />

<!-- Example configuration for a remote JBoss Enterprise Application Platform 6 or AS 7 instance -->
<!-- Example configuration for a remote WildFly 8 or AS 7 instance -->
<container qualifier="jboss" default="true">
<!-- By default, arquillian will use the JBOSS_HOME environment variable. Alternatively, the configuration below can be uncommented. -->
<!--<configuration> -->
Expand Down
12 changes: 6 additions & 6 deletions bmt/README.md
Expand Up @@ -12,13 +12,13 @@ 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 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.

This example demonstrates how to manually manage transaction demarcation while accessing JPA entities in JBoss Enterprise Application Platform 6 or JBoss AS 7.
This example demonstrates how to manually manage transaction demarcation while accessing JPA entities in WildFly 8.

When you run this example, you will be provided with a `Use bean managed Entity Managers` checkbox.
* If you check the checkbox, it shows the developer responsibilities when injecting an Entity Manager into a managed (stateless) bean.
* If you uncheck the checkbox, shows the developer responsibilities when using JPA and transactions with an unmanaged component.

JBoss Enterprise Application Platform 6 and JBoss AS 7 ship with H2, an in-memory database written in Java. 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.
WildFly 8 and WildFly 8 ship with H2, an in-memory database written in Java. 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 Java EE 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._

Expand All @@ -28,7 +28,7 @@ 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.
The application this project produces is designed to be run on WildFly 8.


Configure Maven
Expand All @@ -37,7 +37,7 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.md#mavenconfiguration) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile
Start WildFly 8 with the Web Profile
-------------------------

1. Open a command line and navigate to the root of the JBoss server directory.
Expand All @@ -56,7 +56,7 @@ _NOTE: The following build command assumes you have configured your Maven user s
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 wildfly:deploy

4. This will deploy `target/jboss-as-bmt.war` to the running instance of the server.

Expand All @@ -80,7 +80,7 @@ Undeploy the Archive
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
mvn wildfly:undeploy


Run the Quickstart in JBoss Developer Studio or Eclipse
Expand Down
22 changes: 11 additions & 11 deletions bmt/pom.xml
Expand Up @@ -43,14 +43,14 @@

<dependencyManagement>
<dependencies>
<!-- Define the version of JBoss' Java EE 6 APIs we want to use -->
<!-- JBoss distributes a complete set of Java EE 6 APIs including
<!-- Define the version of JBoss' Java EE 7 APIs we want to use -->
<!-- JBoss distributes a complete set of Java EE 7 APIs including
a Bill of Materials (BOM). A BOM specifies the versions of a "stack" (or
a collection) of artifacts. We use this here so that we always get the correct
versions of artifacts. Here we use the jboss-javaee-6.0 stack (you can
read this as the JBoss stack of the Java EE 6 APIs). You can actually
use this stack with any version of JBoss AS that implements Java EE 6, not
just JBoss AS 7! -->
read this as the JBoss stack of the Java EE 7 APIs). You can actually
use this stack with any version of JBoss AS that implements Java EE 7, not
just WildFly 8! -->
<dependency>
<groupId>org.jboss.spec</groupId>
<artifactId>jboss-javaee-web-7.0</artifactId>
Expand All @@ -63,43 +63,43 @@

<dependencies>

<!-- Import the CDI API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the CDI API, we use provided scope as the API is included in WildFly 8 -->
<dependency>
<groupId>javax.enterprise</groupId>
<artifactId>cdi-api</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the Common Annotations API (JSR-250), we use provided scope
as the API is included in JBoss AS 7 -->
as the API is included in WildFly 8 -->
<dependency>
<groupId>org.jboss.spec.javax.annotation</groupId>
<artifactId>jboss-annotations-api_1.2_spec</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the Servlet API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the Servlet API, we use provided scope as the API is included in WildFly 8 -->
<dependency>
<groupId>org.jboss.spec.javax.servlet</groupId>
<artifactId>jboss-servlet-api_3.1_spec</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the JPA API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the JPA API, we use provided scope as the API is included in WildFly 8 -->
<dependency>
<groupId>org.jboss.spec.javax.transaction</groupId>
<artifactId>jboss-transaction-api_1.2_spec</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the EJB API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the EJB API, we use provided scope as the API is included in WildFly 8 -->
<dependency>
<groupId>org.jboss.spec.javax.ejb</groupId>
<artifactId>jboss-ejb-api_3.2_spec</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the JPA API, we use provided scope as the API is included in JBoss AS 7 -->
<!-- Import the JPA API, we use provided scope as the API is included in WildFly 8 -->
<dependency>
<groupId>org.hibernate.javax.persistence</groupId>
<artifactId>hibernate-jpa-2.1-api</artifactId>
Expand Down
8 changes: 4 additions & 4 deletions carmart-tx/README.md
Expand Up @@ -32,7 +32,7 @@ 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.
The application this project produces is designed to be run on WildFly 8.


Configure Maven
Expand All @@ -41,7 +41,7 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.md#configure-maven-) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss AS 7
Start WildFly 8
-----------------------------------------------------------

1. Open a command line and navigate to the root of the JBoss server directory.
Expand All @@ -60,7 +60,7 @@ _NOTE: The following build command assumes you have configured your Maven user s
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 wildfly:deploy
4. This will deploy `target/jboss-as-carmart-tx.war` to the running instance of the server.

Expand All @@ -78,7 +78,7 @@ Undeploy the Archive
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
mvn wildfly:undeploy


Debug the Application
Expand Down
10 changes: 5 additions & 5 deletions carmart-tx/pom.xml
Expand Up @@ -46,12 +46,12 @@
</properties>

<dependencyManagement>
<!-- JBoss distributes a complete set of Java EE 6 APIs including
<!-- JBoss distributes a complete set of Java EE 7 APIs including
a Bill of Materials (BOM). A BOM specifies the versions of a "stack" (or
a collection) of artifacts. We use this here so that we always get the correct
versions of artifacts. Here we use the jboss-javaee-6.0-with-infinispan stack
and the jboss-javaee-6.0-with-transactions stack (you can read this as the
JBoss stack of the Java EE 6 APIs, with Infinispan and Transactions) -->
JBoss stack of the Java EE 7 APIs, with Infinispan and Transactions) -->
<dependencies>
<dependency>
<groupId>org.jboss.bom</groupId>
Expand All @@ -73,19 +73,19 @@
<dependencies>

<!-- First declare the APIs we depend on and need for compilation.
The dependencies with provided scope are provided by JBoss AS 7, The other
The dependencies with provided scope are provided by WildFly 8, The other
compiled scoped dependencies will be add to the application libraries -->

<!-- Import the JSF API, we use provided scope as the API is included
in JBoss AS 7 -->
in WildFly 8 -->
<dependency>
<groupId>org.jboss.spec.javax.faces</groupId>
<artifactId>jboss-jsf-api_2.1_spec</artifactId>
<scope>provided</scope>
</dependency>

<!-- Import the CDI API, we use provided scope as the API is included
in JBoss AS 7 -->
in WildFly 8 -->
<dependency>
<groupId>javax.enterprise</groupId>
<artifactId>cdi-api</artifactId>
Expand Down
18 changes: 9 additions & 9 deletions carmart/README.md
Expand Up @@ -16,7 +16,7 @@ Users can list cars, add new cars, or remove them from the CarMart. Information

The CarMart quickstart can work in two modes:

* _Library mode_ - In this mode, the application and the data grid are running in the same JVM. All libraries (JAR files) are bundled with the application and deployed to JBoss Enterprise Application Platform 6 or JBoss AS 7. The library usage mode only allows local access to a single node in a distributed cluster. This usage mode gives the application access to data grid functionality within a virtual machine in the container being used.
* _Library mode_ - In this mode, the application and the data grid are running in the same JVM. All libraries (JAR files) are bundled with the application and deployed to WildFly 8. The library usage mode only allows local access to a single node in a distributed cluster. This usage mode gives the application access to data grid functionality within a virtual machine in the container being used.

* _Client-server mode_ - In this mode, the Cache is stored in a managed, distributed and clusterable data grid server. Applications can remotely access the data grid server using Hot Rod, memcached or REST client APIs. This web application bundles only the HotRod client and communicates with a remote JBoss Data Grid (JDG) server. The JDG server is configured via the `standalone.xml` configuration file.

Expand All @@ -26,7 +26,7 @@ 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.
The application this project produces is designed to be run on WildFly 8.


Configure Maven
Expand All @@ -35,7 +35,7 @@ Configure Maven
If you have not yet done so, you must [Configure Maven](../README.md#configure-maven-) before testing the quickstarts.


Start JBoss Enterprise Application Platform 6 or JBoss AS 7
Start WildFly 8
-----------------------------------------------------------

1. Open a command line and navigate to the root of the JBoss server directory.
Expand All @@ -54,7 +54,7 @@ _NOTE: The following build command assumes you have configured your Maven user s
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 wildfly:deploy
4. This will deploy `target/jboss-as-carmart.war` to the running instance of the server.

Expand All @@ -72,7 +72,7 @@ Undeploy the Archive
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
mvn wildfly:undeploy


Debug the Application
Expand All @@ -87,7 +87,7 @@ If you want to debug the source code or look at the Javadocs of any library in t
Build and Start the Application in Client-server Mode (using the HotRod client)
---------------------------------------------------------------------------------

NOTE: The application must be deployed to JBoss Enterprise Application Platform 6 or JBoss AS 7. It can not be deployed to JDG since it does not support deployment of applications.
NOTE: The application must be deployed to WildFly 8. It can not be deployed to JDG since it does not support deployment of applications.

1. Obtain the JDG server distribution. See the following for more information: <http://www.redhat.com/products/jbossenterprisemiddleware/data-grid/>

Expand All @@ -102,7 +102,7 @@ NOTE: The application must be deployed to JBoss Enterprise Application Platform

$JDG_HOME/bin/standalone.sh -Djboss.socket.binding.port-offset=100

4. Start JBoss AS 7 into which you want to deploy your application
4. Start WildFly 8 into which you want to deploy your application

$JBOSS_HOME/bin/standalone.sh

Expand All @@ -117,12 +117,12 @@ NOTE: The application must be deployed to JBoss Enterprise Application Platform

7. Deploy the application

mvn jboss-as:deploy -Premote
mvn wildfly:deploy -Premote

8. The application will be running at the following URL: <http://localhost:8080/jboss-as-carmart/>

9. Undeploy the application

mvn jboss-as:undeploy -Premote
mvn wildfly:undeploy -Premote


0 comments on commit 099de3e

Please sign in to comment.