Quickstarts

jax-rs-client: External JAX-RS Client

What is it?

This example demonstrates an external JAX-RS RestEasy client which interacts with a JAX-RS Web service that uses CDI 1.0 and JAX-RS in Red Hat JBoss Enterprise Application Platform.

This client "calls" the HelloWorld JAX-RS Web Service that was created in the helloworld-rs quickstart. See the Prerequisite section below for details on how to build and deploy the helloworld-rs quickstart.

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.

Prerequisites

IMPORTANT: This quickstart depends on the deployment of the 'helloworld-rs' quickstart for its test. Before running this quickstart, see the helloworld-rs README file for details on how to deploy it.

You can verify the deployment of the helloworld-rs quickstart by accessing the following content:

Run the Arquillian Tests

This quickstart provides Arquillian tests.

NOTE: The following commands assume you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Run the Arquillian Tests for complete instructions and additional options.

  1. Make sure you have started the JBoss Server as described above.
  2. Make sure the helloworld-rs quickstart has been deployed on the server as noted in the Prerequisites section above.
  3. Open a command line and navigate to the root directory of this quickstart.
  4. Type the following command to run the test goal with the following profile activated:

    mvn clean test 
    

Investigate the Console Output

This command will compile the example and execute a test to make two separate requests to the Web Service. Towards the end of the Maven build output, you should see the following if the execution is successful:

    ===============================================
    URL: http://localhost:8080/jboss-helloworld-rs/rest/xml
    MediaType: application/xml

    *** Response from Server ***

    <xml><result>Hello World!</result></xml>

    ===============================================
    ===============================================
    URL: http://localhost:8080/jboss-helloworld-rs/rest/json
    MediaType: application/json

    *** Response from Server ***

    {"result":"Hello World!"}
    ===============================================

OpenShift

To make this quickstart more interesting, deploy the RESTful service to OpenShift. The following instructions will guide you as to the modifications that must be made to successfully execute the jax-rs-client against a service deployed to OpenShift.

Build and Deploy the Quickstart - to OpenShift

IMPORTANT: This quickstart depends on the deployment of the helloworld-rs quickstart to OpenShift for its test. Follow the instructions Build and Deploy the Quickstart - to OpenShift in the helloworld-rs README to deploy that application to OpenShift. Do NOT yet follow the step "Delete the OpenShift Application".

As it says in the helloworld-rs instructions, you can verify the deployment of the helloworld-rs quickstart by accessing the following content. Be sure to replace the YOUR_DOMAIN_NAME in the URL with your domain name.

Modify the jax-rs-client quickstart pom.xml

Now that you have deployed the application, it is time to make changes to the jax-rs-client quickstart Arquillian tests.

  1. Open a shell command prompt and navigate to the QUICKSTART_HOME/jax-rs-client/ directory.
  2. Make a backup copy of the pom.xml file.
  3. Open the pom.xml file in an editor and modify the xmlUrl and jsonUrl property values as follows. Be sure to replace the YOUR_DOMAIN_NAME in the URL with your OpenShift domain name.

    <property>
        <name>xmlUrl</name>
        <value>http://helloworldrs-YOUR_DOMAIN_NAME.rhcloud.com/rest/xml</value>
    </property>
    <property>
        <name>jsonUrl</name>
        <value>http://helloworldrs-YOUR_DOMAIN_NAME.rhcloud.com/rest/json</value>
    </property>
    

Run the Maven test

Type the following command to run the jax-rs-client:

    mvn test

This command will compile the example and execute a test to make two separate requests to the Web Service. Towards the end of the Maven build output, you should see the following if the execution is successful:

    ===============================================
    URL: http://helloworldrs-YOUR_DOMAIN_NAME.rhcloud.com/rest/xml
    MediaType: application/xml

    *** Response from Server ***

    <xml><result>Hello World!</result></xml>

    ===============================================
    ===============================================
    URL: http://helloworldrs-YOUR_DOMAIN_NAME.rhcloud.com/rest/json
    MediaType: application/json

    *** Response from Server ***

    {"result":"Hello World!"}

    ===============================================

When you are finished testing, restore the pom.xml file to the previous version if you want to test locally.

Delete the OpenShift Application

When you are finished with the application you can delete it 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

Share the Knowledge

Find this guide useful?

Feedback

Find a bug in the guide? Something missing? You can fix it by [forking the repository](http://github.com/jboss-jdf/jboss-as-quickstart), making the correction and [sending a pull request](http://help.github.com/send-pull-requests). If you're just plain stuck, feel free to ask a question in the [user discussion forum](http://jboss.org/jdf/forums/jdf-users).

Recent Changelog

  • Nov 17, 2013: Bz1029445: update openshift instructions to be more current with latest version Sande Gilda
  • Nov 13, 2013: Revert "bz1029445: remove openshift instructions from readme files as they do not currently work" Sande Gilda
  • Nov 13, 2013: Bz1029445: remove openshift instructions from readme files as they do not currently work Sande Gilda
  • Nov 08, 2013: Bz1028448: add spaces to end of metadata so it renders with a line break in html Sande Gilda
  • Oct 07, 2013: Merge from master to 6.2.x for er5 Sande Gilda
  • Sep 24, 2013: Remove references to jboss as 7 from the quickstarts Sande Gilda
  • Sep 23, 2013: Update metadata source urls to new repository Sande Gilda
  • Sep 13, 2013: Jdf-487: remove -as- from quickstart artifactid and archive names and access urls in readme files Sande Gilda
  • Jun 12, 2013: Modify readme file internal links to use generated anchors. remove hard-coded anchors. fixed obsolete links and other markdown rendering problems Sande Gilda
  • Feb 12, 2013: Add quickstart source repository of record to the readme files Sande Gilda
  • Sep 11, 2012: Add target product (https://issues.jboss.org/browse/jdf-108) Sande Gilda
  • Jul 30, 2012: Fix openshift instructions, issue #291, developer and doc links Sande Gilda
  • Jul 19, 2012: Fix issue #301 and issue #302 : remove openshift warning, make template readme instructions clearer Sande Gilda
  • May 18, 2012: Move metadata to quickstarts Pete Muir
  • May 03, 2012: Clarify that the domain portion of the openshift url will be your own domain Sande Gilda

See full history »