Red Hat

Developer Materials

helloworld-html5: HTML5 and REST Hello World Example

What is it?

The helloworld-html5 quickstart demonstrates the use of CDI 1.2 and JAX-RS 2.0 in Red Hat JBoss Enterprise Application Platform 7 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 7 or later.

All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.1.1 or later. See Configure Maven for JBoss EAP 7 to make sure you are configured correctly for testing the quickstarts.

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.

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:   EAP7_HOME/bin/standalone.sh
     For Windows: EAP7_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 wildfly: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 by sending an HTTP POST request to the URLs below. Feel free to replace YOUR_NAME with a name of your choosing.

  • The XML content can be tested by sending an HTTP POST to the following URL: http://localhost:8080/jboss-helloworld-html5/hello/xml/YOUR_NAME

    To issue the POST command using cURL, type the following command in terminal:

      curl -i -X POST http://localhost:8080/jboss-helloworld-html5/hello/xml/YOUR_NAME
    

    You will see the following response:

      HTTP/1.1 200 OK
      Connection: keep-alive
      X-Powered-By: Undertow/1
      Server: JBoss-EAP/7
      Content-Type: application/xml
      Content-Length: 44
      Date: Tue, 13 Oct 2015 18:40:04 GMT
    
      <xml><result>Hello YOUR_NAME!</result></xml>
    
  • The JSON content can be tested by sending an HTTP POST to the following URL: http://localhost:8080/jboss-helloworld-html5/hello/json/YOUR_NAME

    To issue the POST command using cURL, type the following command in terminal:

      curl -i -X POST http://localhost:8080/jboss-helloworld-html5/hello/json/YOUR_NAME
    

    You will see the following response:

      HTTP/1.1 200 OK
      Connection: keep-alive
      X-Powered-By: Undertow/1
      Server: JBoss-EAP/7
      Content-Type: application/json
      Content-Length: 29
      Date: Tue, 13 Oct 2015 06:32:20 GMT
        
      {"result":"Hello YOUR_NAME!"}
    

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

Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse

You can also start the server and deploy the quickstarts or run the Arquillian tests 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

Recent Changelog

  • Oct 13, 2015(Tomas Repel):Update of description of REST endpoint testing in README
  • Oct 12, 2015(Tomas Repel):Update of maven war plugin version to 2.6 in helloworld html5 minor fixes of README.md in helloword html5 update of jQuery version to 2.1.4 in helloworld html5
  • Sep 7, 2015(Rafael Benevides):Fix formatting and removed trailing spaces
  • Aug 20, 2015(Sande Gilda):JBEAP 577 Replace links to shared resources for JBoss EAP 7 material
  • Aug 4, 2015(Sande Gilda):JBEAP 578 Update Maven version in README files
  • Aug 3, 2015(Sande Gilda):JBEAP 564 Clarify Maven instructions
  • Jul 27, 2015(Sande Gilda):Replace OpenShift instructions with a Coming Soon message
  • Jul 23, 2015(Sande Gilda):Replace CONFIGURE_MAVEN link with CONFIGURE_MAVEN_JBOSS_EAP7 link
  • Jul 3, 2015(Vineet Reynolds):JDF 807 Moved helloworld html5 from WFK to EAP quickstarts
  • Jan 29, 2015(Sande Gilda):Modify JBDS Maven Arquillian instructions to point to shared developer guides. Fix product names
Avg:
Your Rating:
×