Holds all versioned docs & samples
JavaScript Java CSS HTML Other
Latest commit 7db5eed Aug 9, 2016 @ctomc ctomc committed on GitHub Merge pull request #110 from fkretzer/10.x
fix links in documentation
Permalink
Failed to load latest commit information.
app-client align deps version with WildFly 10.0.0.Final Feb 23, 2016
batch-processing align deps version with WildFly 10.0.0.Final Feb 23, 2016
bean-validation-custom-constraint align deps version with WildFly 10.0.0.Final Feb 23, 2016
bean-validation align deps version with WildFly 10.0.0.Final Feb 23, 2016
bmt Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
carmart-tx align deps version with WildFly 10.0.0.Final Feb 23, 2016
carmart align deps version with WildFly 10.0.0.Final Feb 23, 2016
cdi-alternative FIX: replace link jboss-cdi-alternative on wildfly-cdi-alternative Feb 6, 2016
cdi-decorator Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
cdi-injection Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
cdi-interceptors align deps version with WildFly 10.0.0.Final Feb 23, 2016
cdi-portable-extension align deps version with WildFly 10.0.0.Final Feb 23, 2016
cdi-stereotype align deps version with WildFly 10.0.0.Final Feb 23, 2016
cdi-veto align deps version with WildFly 10.0.0.Final Feb 23, 2016
cluster-ha-singleton align deps version with WildFly 10.0.0.Final Feb 23, 2016
cluster-mdb change hornetq to activemq for standalone and domain Feb 7, 2016
cmt align deps version with WildFly 10.0.0.Final Feb 23, 2016
contacts-jquerymobile align deps version with WildFly 10.0.0.Final Feb 23, 2016
deltaspike-authorization align deps version with WildFly 10.0.0.Final Feb 23, 2016
deltaspike-beanbuilder align deps version with WildFly 10.0.0.Final Feb 23, 2016
deltaspike-projectstage align deps version with WildFly 10.0.0.Final Feb 23, 2016
dist JDF-841 - Synchronize Wildfly and EAP Quickstarts Sep 9, 2015
ejb-asynchronous align deps version with WildFly 10.0.0.Final Feb 23, 2016
ejb-in-ear fix path from /jboss-... to /wildfly-... Apr 29, 2016
ejb-in-war align deps version with WildFly 10.0.0.Final Feb 23, 2016
ejb-multi-server align deps version with WildFly 10.0.0.Final Feb 23, 2016
ejb-remote align deps version with WildFly 10.0.0.Final Feb 23, 2016
ejb-security-interceptors Merge pull request #97 from wfink/JDF-857 Apr 28, 2016
ejb-security-plus align deps version with WildFly 10.0.0.Final Feb 23, 2016
ejb-security Merge pull request #96 from dmejer/ejb-security-readme-fix Apr 28, 2016
ejb-throws-exception align deps version with WildFly 10.0.0.Final Feb 23, 2016
ejb-timer Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
greeter Fixed incorrect URL in README.md May 28, 2016
guide fix links Aug 9, 2016
h2-console Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
helloworld-classfiletransformer Make deltaspike quickstarts work again & some typos fixes Nov 12, 2015
helloworld-client-ssl Make deltaspike quickstarts work again & some typos fixes Nov 12, 2015
helloworld-html5 align deps version with WildFly 10.0.0.Final Feb 23, 2016
helloworld-jdg align deps version with WildFly 10.0.0.Final Feb 23, 2016
helloworld-jms align deps version with WildFly 10.0.0.Final Feb 23, 2016
helloworld-mbean align deps version with WildFly 10.0.0.Final Feb 23, 2016
helloworld-mdb-propertysubstitution Fix helloworld-mdb-propertysubstitution application URL Jan 12, 2016
helloworld-mdb Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
helloworld-rf Make deltaspike quickstarts work again & some typos fixes Nov 12, 2015
helloworld-rs add JAX-RS activation class to make rest/* work Jan 24, 2016
helloworld-singleton Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
helloworld-ssl Make deltaspike quickstarts work again & some typos fixes Nov 12, 2015
helloworld-war-ssl formatting, replace tab with spaces May 3, 2016
helloworld-websocket Make deltaspike quickstarts work again & some typos fixes Nov 12, 2015
helloworld-ws align deps version with WildFly 10.0.0.Final Feb 23, 2016
helloworld Fixed incorrect URL in HelloWorld quickstart May 17, 2016
hibernate4 align deps version with WildFly 10.0.0.Final Feb 23, 2016
hibernate5 align deps version with WildFly 10.0.0.Final Feb 23, 2016
inter-app Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
jaxrs-client align deps version with WildFly 10.0.0.Final Feb 23, 2016
jaxws-addressing align deps version with WildFly 10.0.0.Final Feb 23, 2016
jaxws-ejb align deps version with WildFly 10.0.0.Final Feb 23, 2016
jaxws-pojo align deps version with WildFly 10.0.0.Final Feb 23, 2016
jaxws-retail JBIDE-21694 - Fix fails to compile in jaxws-retail quickstart Feb 25, 2016
jsonp align deps version with WildFly 10.0.0.Final Feb 23, 2016
jta-crash-rec align deps version with WildFly 10.0.0.Final Feb 23, 2016
jts-distributed-crash-rec Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
jts Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
kitchensink-angularjs align deps version with WildFly 10.0.0.Final Feb 23, 2016
kitchensink-ear align deps version with WildFly 10.0.0.Final Feb 23, 2016
kitchensink-html5-mobile align deps version with WildFly 10.0.0.Final Feb 23, 2016
kitchensink-jsp align deps version with WildFly 10.0.0.Final Feb 23, 2016
kitchensink-ml-ear align deps version with WildFly 10.0.0.Final Feb 23, 2016
kitchensink-ml align deps version with WildFly 10.0.0.Final Feb 23, 2016
kitchensink-utjs-angularjs Add Undertow.js based quickstarts Feb 26, 2016
kitchensink-utjs-mustache Add Undertow.js based quickstarts Feb 26, 2016
kitchensink align deps version with WildFly 10.0.0.Final Feb 23, 2016
logging-tools align deps version with WildFly 10.0.0.Final Feb 23, 2016
logging align deps version with WildFly 10.0.0.Final Feb 23, 2016
mail Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
managedexecutorservice align deps version with WildFly 10.0.0.Final Feb 23, 2016
numberguess Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
payment-cdi-event Merge pull request #88 from dgolovin/broken-pom-fix Aug 3, 2016
resteasy-jaxrs-client Fix link to helloworld-rs on resteasy-jaxrs May 9, 2016
security-vault-askpass Make deltaspike quickstarts work again & some typos fixes Nov 12, 2015
servlet-async Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
servlet-filterlistener Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
servlet-security Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
shopping-cart align deps version with WildFly 10.0.0.Final Feb 23, 2016
shrinkwrap-resolver align deps version with WildFly 10.0.0.Final Feb 23, 2016
temperature-converter Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
template Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
thread-racing align deps version with WildFly 10.0.0.Final Feb 23, 2016
websocket-client align deps version with WildFly 10.0.0.Final Feb 23, 2016
websocket-endpoint align deps version with WildFly 10.0.0.Final Feb 23, 2016
websocket-hello JBEAP-3128: Remove jboss-web.xml file with the obsolete enable-websoc… Feb 1, 2016
wicket-ear wicket-ear upgrade and bug fix Jun 19, 2016
wicket-war wicket-war upgrade and bug fix Jun 19, 2016
wsat-simple align deps version with WildFly 10.0.0.Final Feb 23, 2016
wsba-coordinator-completion-simple align deps version with WildFly 10.0.0.Final Feb 23, 2016
wsba-participant-completion-simple align deps version with WildFly 10.0.0.Final Feb 23, 2016
xml-dom4j Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
xml-jaxp Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
.gitignore JDF-841 - Synchronize Wildfly and EAP Quickstarts Sep 9, 2015
.quickstarts_ignore JDF-841 - Synchronize Wildfly and EAP Quickstarts Sep 9, 2015
CONTRIBUTING.md Update file headers to 2015 Sep 16, 2015
LICENSE.txt JDF-841 - Synchronize Wildfly and EAP Quickstarts Sep 9, 2015
README.md Fix docs & fix kitchensink-html5-mobile qs work again Nov 12, 2015
RELEASE_PROCEDURE.md JDF-841 - Synchronize Wildfly and EAP Quickstarts Sep 9, 2015
configure-postgresql.cli JDF-841 - Synchronize Wildfly and EAP Quickstarts Sep 9, 2015
contributor-settings.xml JDF-841 - Synchronize Wildfly and EAP Quickstarts Sep 9, 2015
pom.xml Add Undertow.js based quickstarts Feb 26, 2016
remove-postgresql.cli JDF-841 - Synchronize Wildfly and EAP Quickstarts Sep 9, 2015
settings.xml JDF-841 - Synchronize Wildfly and EAP Quickstarts Sep 9, 2015

README.md

WildFly Quickstarts

Summary: The quickstarts demonstrate Java EE 7 and a few additional technologies from the JBoss stack. They provide small, specific, working examples that can be used as a reference for your own project.

Introduction

These quickstarts run on JBoss WildFly. This version uses the correct dependencies and ensures you test and compile against your runtime environment.

Be sure to read this entire document before you attempt to work with the quickstarts. It contains the following information:

Use of WILDFLY_HOME and JBOSS_HOME Variables

The quickstart README files use the replaceable value WILDFLY_HOME to denote the path to the WildFly installation. When you encounter this value in a README file, be sure to replace it with the actual path to your WildFly installation. The installation path is described in detail here: Use of WILDFLY_HOME and JBOSS_HOME Variables.

Available Quickstarts

All available quickstarts can be found here: http://www.jboss.org/developer-materials/#!formats=jbossdeveloper_quickstart. You can filter by the quickstart name, the product, and the technologies demonstrated by the quickstart. You can also limit the results based on skill level and date published. The resulting page provides a brief description of each matching quickstart, the skill level, and the technologies used. Click on the quickstart to see more detailed information about how to run it. Some quickstarts require deployment of other quickstarts. This information is noted in the Prerequisites section of the quickstart README file.

Note: Some of these quickstarts use the H2 database included with WildFly. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment!

[TOC-quickstart]

Suggested Approach to the Quickstarts

We suggest you approach the quickstarts as follows:

  • Regardless of your level of expertise, we suggest you start with the helloworld quickstart. It is the simplest example and is an easy way to prove your server is configured and started correctly.
  • If you are a beginner or new to JBoss, start with the quickstarts labeled Beginner, then try those marked as Intermediate. When you are comfortable with those, move on to the Advanced quickstarts.
  • Some quickstarts are based upon other quickstarts but have expanded capabilities and functionality. If a prerequisite quickstart is listed, be sure to deploy and test it before looking at the expanded version.

System Requirements

The applications these projects produce are designed to be run on Red Hat JBoss Enterprise Application Platform 7 or later.

All you need to build these projects is Java 8.0 (Java SDK 1.8) or later and Maven 3.1.1 or later. See Configure Maven for WildFly 10 to make sure you are configured correctly for testing the quickstarts.

To run these quickstarts with the provided build scripts, you need the the WildFly distribution ZIP. For information on how to install and run JBoss, see the Red Hat JBoss Enterprise Application Platform Documentation Getting Started Guide located on the Customer Portal.

You can also use JBoss Developer Studio or Eclipse to run the quickstarts.

Run the Quickstarts

The root folder of each individual quickstart contains a README file with specific details on how to build and run the example. In most cases you do the following:

Build and Deploy the Quickstarts

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 most cases, you can use the following steps to build the application to test for compile errors or to view the contents of the archive. See the specific quickstart README file for complete details.

  1. Open a command prompt 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:

        mvn clean install
    

Build and Deploy the Quickstart Archive

In most cases, you can use the following steps to build and deploy the application. See the specific quickstart README file for complete details.

  1. Make sure you start the WildFly server as described in the quickstart README file.
  2. Open a command prompt and navigate to the root directory of the quickstart you want to run.
  3. Use this command to build and deploy the archive:

        mvn clean install wildfly:deploy
    

Undeploy an Archive

The command to undeploy the quickstart is simply:

    mvn wildfly:undeploy

Verify the Quickstarts Build with One Command


You can verify the quickstarts build using one command. However, quickstarts that have complex dependencies must be skipped. For example, the resteasy-jaxrs-client quickstart is a RESTEasy client that depends on the deployment of the helloworld-rs quickstart. As noted above, the root pom.xml file defines a complex-dependencies profile to exclude these quickstarts from the root build process.

To build the quickstarts:

  1. Do not start the WildFly server.
  2. Open a command prompt and navigate to the root directory of the quickstarts.
  3. Use this command to build the quickstarts that do not have complex dependencies:

        mvn clean install '-Pdefault,!complex-dependencies'
    

Note: If you see a java.lang.OutOfMemoryError: PermGen space error when you run this command, increase the memory by typing the following command for your operating system, then try the above command again.

    For Linux:   export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m"
    For Windows: SET MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m"

Undeploy the Deployed Quickstarts with One Command


To undeploy the quickstarts from the root of the quickstart folder, you must pass the argument -fae (fail at end) on the command line. This allows the command to continue past quickstarts that fail due to complex dependencies and quickstarts that only have Arquillian tests and do not deploy archives to the server.

You can undeploy quickstarts using the following procedure:

  1. Start the WildFly server.
  2. Open a command prompt and navigate to the root directory of the quickstarts.
  3. Use this command to undeploy any deployed quickstarts:

        mvn wildfly:undeploy -fae
    

To undeploy any quickstarts that fail due to complex dependencies, follow the undeploy procedure described in the quickstart's README file.

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, see the Red Hat JBoss Enterprise Application Platform Documentation Getting Started Guide and Development Guide or Get Started with JBoss Developer Studio.

Optional Components

The following components are needed for only a small subset of the quickstarts. Do not install or configure them unless the quickstart requires it.