helloworld-html5: HTML5 + REST Hello World Example

Author: Jay Balunas, Burr Sutter, Douglas Campos, Bruno Olivera Level: Beginner Technologies: CDI, JAX-RS, HTML5 Summary: Basic HTML5 |Demonstrates the use of CDI 1.0 and JAX-RS using the HTML5 architecture and RESTful services on the backend Target Product: WFK Source: https://github.com/jboss-jdf/jboss-as-quickstart/

What is it?

This example demonstrates the use of CDI 1.0 and JAX-RS in JBoss AS 7 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

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 AS 7 or JBoss Enterprise Application Platform 6.

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 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 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 both the client and service applications:

    mvn clean package jboss-as:deploy
   

4. This will deploy target/jboss-as-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-as-helloworld-html5/.

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

• The XML content can be tested by accessing the following URL: http://localhost:8080/jboss-as-helloworld-html5/hello/xml/YOUR_NAME
• The JSON content can be tested by accessing this URL: http://localhost:8080/jboss-as-helloworld-html5/hello/json/YOUR_NAME

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