Red Hat

Developer Materials

HTML5 + REST Hello World Example

  • Author:
  • Contributors: Sande Gilda, Oliver Kiss, Vineet Reynolds, Rafael Benevides, Lucas Holmquist, Kris Borchers, Bruno Oliveira, Pete Muir, kborchers, Douglas Campos, Wesley Hales
  • Last Update: Feb 28, 2014
  • Level: Beginner
  • Technologies:CDI, JAX-RS, HTML5
  • Target Product:WFK

What is it?

This example demonstrates the use of CDI 1.0 and JAX-RS in Red Hat JBoss Enterprise Application Platform 6.1 or later using the HTML5 + REST architecture.

The application is basically a smart, HTML5+CSS3+JavaScript front-end using RESTful services on the backend.

  • HelloWorld.java - establishes the RESTful endpoints using JAX-RS
  • Web.xml - maps RESTful endpoints to "/hello"
  • index.html - is a jQuery augmented plain old HTML5 web page

The example can be deployed using Maven from the command line or from Eclipse using JBoss Tools.

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.5.

All you need to build this project is Java 6.0 (Java SDK 1.6) or later, Maven 3.0 or later.

An HTML5 compatible browser such as Chrome, Safari 5+, Firefox 5+, or IE 9+ is required.

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 before testing the quickstarts.

Start the JBoss EAP Server

  1. Open a command line and navigate to the root of the JBoss EAP directory.
  2. The following shows the command line to start the server with the default 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 for complete instructions and additional options.

  1. Make sure you have started the JBoss EAP 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 both the client and service applications:

     mvn clean package jboss-as:deploy
    
  4. This will deploy target/jboss-helloworld-html5.war to the running instance of the server.

Access the application

The application will be running at the following URL http://localhost:8080/jboss-helloworld-html5/.

You can also test the REST endpoint as follows. Feel free to replace YOUR_NAME with a name of your choosing.

Undeploy the Archive

  1. Make sure you have started the JBoss EAP 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 Functional Tests

This quickstart provides Arquillian functional tests as well. They are located in the functional-tests/ subdirectory under the root directory of this quickstart. Functional tests verify that your application behaves correctly from the user's point of view. The tests open a browser instance, simulate clicking around the page as a normal user would do, and then close the browser instance.

To run these tests, you must build the main project as described above.

  1. Open a command line and navigate to the root directory of this quickstart.
  2. Build the quickstart WAR using the following command:

     mvn clean package
    
  3. Navigate to the functional-tests/ directory in this quickstart.
  4. If you have a running instance of the JBoss EAP server, as described above, run the remote tests by typing the following command:

     mvn clean verify -Parq-jbossas-remote
    
  5. If you prefer to run the functional tests using managed instance of the JBoss EAP server, meaning the tests will start the server for you, type fhe following command:

     mvn clean verify -Parq-jbossas-managed
    

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

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

Build and Deploy the Quickstart - to OpenShift

You can also deploy the application directly to OpenShift, Red Hat's cloud based PaaS offering, follow the instructions here

Recent Changelog

  • Feb 28, 2014(Sande Gilda):Edits to README files to render metadata correctly and to use the correct term for JBoss EAP
  • Feb 17, 2014(Sande Gilda):JDF 614 Update WFK version from 2.4 to 2.5
  • Nov 25, 2013(Oliver Kiss):Functional tests for helloworld kitchensink and RichFaces quickstarts
  • Oct 2, 2013(Sande Gilda):JDF 503 Remove AS 7 references add versions general cleanup remove temp repo from settings
  • Sep 23, 2013(Sande Gilda):Update metadata source URLs to new repository
  • Sep 13, 2013(Sande Gilda):JDF 487 Remove as from quickstart artifactId and archive names and access URLs in README files
  • Jul 3, 2013(Sande Gilda):Fix Bug 980488 Change POST annotations to GET. Update README file
  • Jun 12, 2013(Sande Gilda):Modify README file internal links to use generated anchors. Remove hard coded anchors. Fixed obsolete links and other markdown rendering problems
  • May 16, 2013(Vineet Reynolds):JDF 320 Upgrade jQuery to 1.9.1 and jQuery Mobile to 1.3.1
  • Mar 21, 2013(Rafael Benevides):JDF 235 Move Aerogear Quickstart to JDF
Avg:
Your Rating: