Red Hat

Developer Materials

helloworld-rs: Helloworld Using JAX-RS (Java API for RESTful Web Services)

  • Author: Gustavo A. Brey
  • Contributors: Sande Gilda, Paul Robinson , Pete Muir , mmusgrov
  • Published: Mar 04, 2015
  • Level: Intermediate
  • Technologies:CDI, JAX-RS
  • Target Product:JBoss EAP

What is it?

The helloworld-rs quickstart demonstrates the use of CDI 1.0 and JAX-RS in Red Hat JBoss Enterprise Application Platform.

System requirements

The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 6.1 or later.

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

Configure Maven

If you have not yet done so, you must Configure Maven before testing the quickstarts.


In the following instructions, replace EAP_HOME with the actual path to your JBoss EAP 6 installation. The installation path is described in detail here: Use of EAP_HOME and JBOSS_HOME Variables.

Start the JBoss EAP Server

  1. Open a command prompt and navigate to the root of the JBoss EAP directory.
  2. The following shows the command line to start the server:

     For Linux:   EAP_HOME/bin/
     For Windows: EAP_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 prompt and navigate to the root directory of this quickstart.
  3. Type this command to build and deploy the archive:

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

Access the application

The application is deployed to http://localhost:8080/jboss-helloworld-rs.

The XML content can be viewed by accessing the following URL: http://localhost:8080/jboss-helloworld-rs/rest/xml

The JSON content can be viewed by accessing this URL: http://localhost:8080/jboss-helloworld-rs/rest/json

Undeploy the Archive

  1. Make sure you have started the JBoss EAP server as described above.
  2. Open a command prompt 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 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 general information about how to import a quickstart, add a JBoss EAP server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts

Debug the Application

If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.

    mvn dependency:sources

Build and Deploy the Quickstart - to OpenShift

Create an OpenShift Express Account and Domain

If you do not yet have an OpenShift account and domain, Sign in to OpenShift to create the account and domain. Get Started with OpenShift will show you how to install the OpenShift Express command line interface.

Create the OpenShift Application

NOTE: The domain name for this application will be In these instructions, be sure to replace all instances of YOUR_DOMAIN_NAME with your own OpenShift account user name.

Open a shell command prompt and change to a directory of your choice. Enter the following command to create a JBoss EAP 6 application:

    rhc app create -a helloworldrs -t jbosseap-6

This command creates an OpenShift application named helloworldrs and will run the application inside the jbosseap-6 container. You should see some output similar to the following:

Application Options
  Namespace:  YOUR_DOMAIN_NAME
  Cartridges: jbosseap-6 (addtl. costs may apply)
  Gear Size:  default
  Scaling:    no

Creating application 'helloworldrs' ... done

Waiting for your DNS name to be available ... done

Cloning into 'helloworldrs'...
Warning: Permanently added the RSA host key for IP address '' to the list of known hosts.

Your application 'helloworldrs' is now available.

  SSH to:
  Git remote: ssh://
  Cloned to:  CURRENT_DIRECTORY/helloworldrs

Run 'rhc show-app helloworldrs' for more details about your app.

The create command creates a git repository in the current directory with the same name as the application. Notice that the output also reports the URL at which the application can be accessed. Make sure it is available by typing the published url into a browser or use command line tools such as curl or wget. Be sure to replace YOUR_DOMAIN_NAME with your OpenShift account domain name.

Migrate the Quickstart Source

Now that you have confirmed it is working you can migrate the quickstart source. You do not need the generated default application, so navigate to the new git repository directory and tell git to remove the source and pom files:

    cd helloworldrs
    git rm -r src pom.xml

Copy the source for the helloworld-rs quickstart into this new git repository:

    cp -r QUICKSTART_HOME/helloworld-rs/src .
    cp QUICKSTART_HOME/helloworld-rs/pom.xml .

Deploy the OpenShift Application

You can now deploy the changes to your OpenShift application using git as follows:

    git add src pom.xml
    git commit -m "helloworld-rs quickstart on OpenShift"
    git push

The final push command triggers the OpenShift infrastructure to build and deploy the changes.

Note that the openshift profile in the pom.xml file is activated by OpenShift. This causes the WAR built by OpenShift to be copied to the deployments/ directory and deployed without a context path.

Test the OpenShift Application

When the push command returns you can test the application by getting the following URLs either via a browser or using tools such as curl or wget. Be sure to replace the YOUR_DOMAIN_NAME in the URL with your OpenShift account domain name.

You can use the OpenShift command line tools or the OpenShift web console to discover and control the application.

View the JBoss EAP Server Log on OpenShift

Now you can look at the output of the server by running the following command:

    rhc tail -a helloworldrs

This will show the tail of the JBoss EAP server log.

Note: You may see the following error in the log:

    2014/03/17 07:50:36,231 ERROR [] (management-handler-thread - 4) JBAS014613: Operation ("read-resource") failed - address: ([("subsystem" => "deployment-scanner")]) - failure description: "JBAS014807: Management resource '[(\"subsystem\" => \"deployment-scanner\")]' not found"

This is a benign error that occurs when the status of the deployment is checked too early in the process. This process is retried, so you can safely ignore this error.

Delete the OpenShift Application

If you plan to test the jax-rs-client quickstart on OpenShift, you may want to wait to delete this application because it is also used by that quickstart for testing. When you are finished with the application you can delete if from OpenShift as follows:

    rhc app-delete -a helloworldrs

Note: There is a limit to the number of applications you can deploy concurrently to OpenShift. If the rhc app create command returns an error indicating you have reached that limit, you must delete an existing application before you continue.

  • To view the list of your OpenShift applications, type: rhc domain show
  • To delete an application from OpenShift, type the following, substituting the application name you want to delete: rhc app-delete -a APPLICATION_NAME_TO_DELETE

Recent Changelog

  • Mar 4, 2015(Sande Gilda):Bz1198744 Update README JBDS instructions to be more clear
  • Feb 3, 2015(Sande Gilda):Update the quickstart README files to point to the new shared EAP_HOME and Build and Deploy instructions
  • Jan 22, 2015(Sande Gilda):Bz1185085 Update README files to use full product name for JBDS
  • Dec 18, 2014(Sande Gilda):Bz1092026 Update README Target Product metadata value remove Product Versions metadata and make sure the full product name is near the top of the files
  • Nov 6, 2014(Sande Gilda):Bz1160776 prepare for google search and fix typos
  • Oct 30, 2014(Sande Gilda):Bz1158059 Replace instances of JDBS with JBDS in README and links
  • Sep 30, 2014(Sande Gilda):Bz1144471 Remove Javadocs instructions as the requirement for Javadoc availability was dropped
  • Sep 24, 2014(Sande Gilda):Bz1146050 Add EAP 6.4 to the product version
  • Sep 24, 2014(Sande Gilda):Bz1146025 Fix issues with bean validation custom constraints README file. Also updated all README JDBS sections
  • Jun 3, 2014(Sande Gilda):Bz1104263 Update OpenShift instructions
Your Rating: