No description, website, or topics provided.
Pull request Compare This branch is 256 commits behind jboss-developer:2.7.x.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cdi-add-interceptor-binding
deltaspike-authorization
deltaspike-beanbuilder
deltaspike-beanmanagerprovider
deltaspike-deactivatable
deltaspike-exception-handling
deltaspike-helloworld-jms
deltaspike-partialbean-advanced
deltaspike-partialbean-basic
deltaspike-projectstage
dist
greeter-spring
helloworld-errai
helloworld-gwt
helloworld-html5
helloworld-rf
kitchensink-angularjs
kitchensink-backbone
kitchensink-cordova
kitchensink-deltaspike
kitchensink-html5-mobile
kitchensink-rf
kitchensink-spring-asyncrequestmapping
kitchensink-spring-basic
kitchensink-spring-controlleradvice
kitchensink-spring-matrixvariables
kitchensink-spring-springmvctest
petclinic-spring
richfaces-validation
shrinkwrap-resolver
template
.gitignore
.gitmodules
.quickstarts_ignore
CONTRIBUTING.html
CONTRIBUTING.md
LICENSE.txt
README.html
README.md
RELEASE_PROCEDURE.html
RELEASE_PROCEDURE.md
pom.xml
settings.xml

README.md

Red Hat JBoss Web Framework Kit (WFK) Quickstarts

Summary: The quickstarts demonstrate Java EE 6 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 Red Hat JBoss Enterprise Application Platform 6.1 or later with the Red Hat JBoss Web Framework Kit. We recommend using the JBoss EAP ZIP file. 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:

Available Quickstarts

The following is a list of the currently available quickstarts. The table lists each quickstart name, the technologies it demonstrates, gives a brief description of the quickstart, and the level of experience required to set it up. For more detailed information about a quickstart, click on the quickstart name.

Some quickstarts are designed to enhance or extend other quickstarts. These are noted in the Prerequisites column. If a quickstart lists prerequisites, those must be installed or deployed before working with the quickstart.

Quickstarts with tutorials in the Get Started Developing Applications are noted with two asterisks ( ** ) following the quickstart name.

[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-html5 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 application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform (EAP) 6.1 or later with the Red Hat JBoss Web Framework Kit (WFK) 2.4.

To run these quickstarts with the provided build scripts, you need the following:

  1. Java 1.6, to run JBoss AS and Maven. You can choose from the following:

    • OpenJDK
    • Oracle Java SE
    • Oracle JRockit
  2. Maven 3.0.0 or later, to build and deploy the examples

    • If you have not yet installed Maven, see the Maven Getting Started Guide for details.

    • If you have installed Maven, you can check the version by typing the following in a command line:

        mvn --version 
      
  3. The JBoss EAP distribution ZIP.

    • For information on how to install and run JBoss, refer to the product documentation.
  4. You can also use JBoss Developer Studio or Eclipse to run the quickstarts.

Configure Maven

Configure Maven to Build and Deploy the Quickstarts

The quickstarts use artifacts located in the JBoss Developer repository. You must configure Maven to use that repository before you build and deploy the quickstarts.

Note: If you do not wish to configure the Maven settings, you must pass the configuration setting on every Maven command as follows: -s QUICKSTART_HOME/settings.xml

  1. Locate the Maven install directory for your operating system. It is usually installed in ${user.home}/.m2/.

         For Linux or Mac:   ~/.m2/
         For Windows: \Documents and Settings\USER_NAME\.m2\  -or-  \Users\USER_NAME\.m2\
    
  2. If you have an existing settings.xml file, rename it so you can restore it later.

         For Linux or Mac:  mv ~/.m2/settings.xml ~/.m2/settings-backup.xml
         For Windows: ren "\Documents and Settings\USER_NAME\.m2\settings.xml" settings-backup.xml
                 -or- ren "\Users\USER_NAME\.m2\settings.xml" settings-backup.xml
    
  3. If you have an existing repository/ directory, rename it so you can restore it later. For example

         For Linux or Mac:  mv ~/.m2/repository/ ~/.m2/repository-backup/
         For Windows: ren "\Documents and Settings\USER_NAME\.m2\repository\" repository-backup
                 -or- ren "\Users\USER_NAME\.m2\repository\" repository-backup
    
  4. Copy the settings.xml file from the root of the quickstarts directory to your Maven install directory.

         For Linux or Mac:  cp QUICKSTART_HOME/settings.xml  ~/.m2/settings.xml
         For Windows: copy QUICKSTART_HOME/settings.xml \Documents and Settings\USER_NAME\.m2\settings.xml 
                 -or- copy QUICKSTART_HOME/settings.xml \Users\USER_NAME\.m2\settings.xml
    

Restore Your Maven Configuration When You Finish Testing the Quickstarts

  1. Locate the Maven install directory for your operating system. It is usually installed in ${user.home}/.m2/.

         For Linux or Mac:   ~/.m2/
         For Windows: \Documents and Settings\USER_NAME\.m2\  -or-  \Users\USER_NAME\.m2\
    
  2. Restore the settings.xml file/

         For Linux or Mac:  mv ~/.m2/settings-backup.xml ~/.m2/settings.xml
         For Windows: ren "\Documents and Settings\USER_NAME\.m2\settings-backup.xml" settings.xml
                 -or- ren "\Users\USER_NAME\.m2\settings-backup.xml" settings.xml
    
  3. Restore the repository/ directory

         For Linux or Mac:  mv ~/.m2/repository-backup/ ~/.m2/repository/
         For Windows: ren "\Documents and Settings\USER_NAME\.m2\repository-backup\" repository
                 -or- ren "\Users\USER_NAME\.m2\repository\" repository-backup
    

Maven Profiles

Profiles are used by Maven to customize the build environment. The pom.xml in the root of the quickstart directory defines the following profiles:

  • The default profile defines the list of modules or quickstarts that require nothing but JBoss Enterprise Application Platform.
  • The non-maven profile lists quickstarts that do not require Maven, for example, quickstarts that use other Frameworks or technologies.
  • The functional-tests profile lists quickstarts that provide functional tests.

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:

Start the JBoss Server

Before you deploy a quickstart, in most cases you need a running JBoss EAP server. A few of the Arquillian tests do not require a running server. This will be noted in the README for that quickstart.

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.

Start the Default JBoss Server

To start JBoss EAP:

  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 JBoss server:

     For Linux:   JBOSS_HOME/bin/standalone.sh
     For Windows: JBOSS_HOME\bin\standalone.bat
    

Start the JBoss Server with the Full Profile

To start JBoss EAP with the Full 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 JBoss 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
    

Start the JBoss Server with Custom Configuration Options

To start JBoss EAP with custom configuration options:

  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 JBoss server. Replace the CUSTOM_OPTIONS with the custom optional parameters specified in the quickstart.

     For Linux:   JBOSS_HOME/bin/standalone.sh CUSTOM_OPTIONS
     For Windows: JBOSS_HOME\bin\standalone.bat CUSTOM_OPTIONS
    

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 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:

         mvn clean package
    

Build and Deploy the Quickstart Archive

  1. Make sure you start the JBoss server 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 clean package jboss-as:deploy
    

Undeploy an Archive

The command to undeploy the quickstart is simply:

    mvn jboss-as: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 jax-rs-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 JBoss server.

  2. Open a command line 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
    

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 JBoss server.

  2. Open a command line and navigate to the root directory of the quickstarts.

  3. Use this command to undeploy any deployed quickstarts:

         mvn jboss-as:undeploy -fae
    

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

Run the Arquillian Tests


Some of the quickstarts provide Arquillian tests. By default, these tests are configured to be skipped, as Arquillian tests an application on a real server, not just in a mocked environment.

You can either start the server yourself or let Arquillian manage its lifecycle during the testing. The individual quickstart README should tell you what to expect in the console output and the server log when you run the test.

  1. Test the quickstart on a remote server

    • Arquillian's remote container adapter expects a JBoss server instance to be already started prior to the test execution. You must Start the JBoss server as described in the quickstart README file.

    • If you need to run the tests on a JBoss server running on a machine other than localhost, you can configure this, along with other options, in the src/test/resources/arquillian.xml file using the following properties:

        <container qualifier="jboss" default="true">
            <configuration>
                <property name="managementAddress">myhost.example.com</property>
                <property name="managementPort">9999</property>
                <property name="username">customAdminUser</property>
                <property name="password">myPassword</property>
            </configuration>
        </container>    
      
    • Run the test goal with the following profile activated:

        mvn clean test -Parq-jbossas-remote     
      
  2. Test the quickstart on a managed server

    Arquillian's managed container adapter requires that your server is not running as it will start the container for you. However, you must first let it know where to find the JBoss server directory. The simplest way to do this is to set the JBOSS_HOME environment variable to the full path to your JBoss server directory. Alternatively, you can set the path in the jbossHome property in the Arquillian configuration file.

    • Open the src/test/resources/arquillian.xml file located in the quickstart directory.

    • Find the configuration for the JBoss container. It should look like this:

        <!-- Example configuration for a managed/remote JBoss EAP instance -->
        <container qualifier="jboss" default="true">
            <!-- If you want to use the JBOSS_HOME environment variable, just delete the jbossHome property -->
            <!--<configuration> -->
            <!--<property name="jbossHome">/path/to/jboss/as</property> -->
            <!--</configuration> -->
        </container>           
      
    • Uncomment the configuration element, find the jbossHome property and replace the "/path/to/jboss/as" value with the actual path to your JBoss EAP server.

    • Run the test goal with the following profile activated:

        mvn clean test -Parq-jbossas-managed
      

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 JBoss Enterprise Application Platform Development Guide or Get Started Developing Applications.