# jaxrs-client: JAX-RS Client API example

Rafael Benevides

> The `jaxrs-client` quickstart demonstrates JAX-RS Client API, which interacts with a JAX-RS Web service that runs on WildFly.

## What is it?

The `jaxrs-client` quickstart demonstrates the JAX-RS Client API which interacts with a JAX-RS Web service.

This client "calls" many `POST`, `GET`, and `DELETE` operations using different ways: synchronized, asynchronous, delayed and filtered invocations.

## System Requirements

The application this project produces is designed to be run on WildFly Application Server 13 or later.

All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See Configure Maven to Build and Deploy the Quickstarts to make sure you are configured correctly for testing the quickstarts.

## Use of WILDFLY_HOME

In the following instructions, replace `WILDFLY_HOME` with the actual path to your WildFly installation. The installation path is described in detail here: Use of WILDFLY_HOME and JBOSS_HOME Variables.

## Start the WildFly Standalone Server

1. Open a terminal and navigate to the root of the WildFly directory.

2. Start the WildFly server with the default profile by typing the following command.

       $ WILDFLY_HOME/bin/standalone.sh

   Note | For Windows, use the `WILDFLY_HOME\bin\standalone.bat` script.

## Build and Deploy the Quickstart

1. Make sure you start the WildFly server as described above.

2. Open a terminal and navigate to the root directory of this quickstart.

3. Type the following command to build the artifacts.

       $ mvn clean package wildfly:deploy

This deploys the `jaxrs-client/target/jaxrs-client.war` to the running instance of the server.

You should see a message in the server log indicating that the archive deployed successfully.

## Run the Arquillian Tests

This quickstart provides Arquillian tests. By default, these tests are configured to be skipped since Arquillian tests require the use of a container.

Note | The Arquillian tests deploy the application, so make sure you undeploy the quickstart before you begin.

Follow these steps to run the tests.

1. Start the WildFly server as described above.

2. Open a terminal and navigate to the root directory of this quickstart.

3. Type the following command to run the `verify` goal with the `arq-remote` profile activated.

       $ mvn clean verify -Parq-remote

Note | You can also let Arquillian manage the WildFly server by using the `arq-managed` profile, meaning the tests will start the server for you. This profile requires that you provide Arquillian with the location of the WildFly server, either by setting the `JBOSS_HOME` environment variable, or by setting the `jbossHome` property in the `arquillian.xml` file. For more information, see Run the Arquillian Tests.

## Investigate the Console Output

When you run the Arquillian tests, Maven prints summary of the performed tests to the console. You should see the following results.

    -------------------------------------------------------
    T E S T S
    -------------------------------------------------------
    Running org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest requestResponseFiltersTest
    INFO: ### Testing Request and Response Filters ###
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest requestResponseFiltersTest
    INFO: dropping all contacts
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest requestResponseFiltersTest
    INFO: Invoking create new contact using a ClientRequestFilter
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest requestResponseFiltersTest
    INFO: Invoking list all contacts using a ClientResponseFilter
    org.jboss.as.quickstarts.jaxrsclient.test.LogResponseFilter filter
    INFO: Date: Mon Dec 29 15:34:45 BRST 2014- Status: 200
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest delayedInvocationTest
    INFO: ### Testing Delayed invocaton ###
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest delayedInvocationTest
    INFO: dropping all contacts
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest delayedInvocationTest
    INFO: Creating a new contact invocation
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest delayedInvocationTest
    INFO: Creating list all contacts invocation
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest delayedInvocationTest
    INFO: invoking the new contact
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest delayedInvocationTest
    INFO: invoking list all contacts ASYNC
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest asyncCrudTest
    INFO: ### CRUD tests  ASYNC ###
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest asyncCrudTest
    INFO: dropping all contacts ASYNC
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest asyncCrudTest
    INFO: creating a new contact ASYNC
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest asyncCrudTest
    INFO: delete a contact by id ASYNC
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest asyncCrudTest
    INFO: fetching all contacts ASYNC
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest invocationCallBackTest
    INFO: ### Testing invocation callback ###
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest invocationCallBackTest
    INFO: dropping all contacts
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest invocationCallBackTest
    INFO: Creating a InvocationCallback
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest invocationCallBackTest
    INFO: Invoking a service using the InvocationCallback
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest cruedTest
    INFO: ### CRUD tests ###
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest cruedTest
    INFO: dropping all contacts
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest cruedTest
    INFO: creating a new contact
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest cruedTest
    INFO: fetching a contact by id
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest cruedTest
    INFO: fetching all contacts
    org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest cruedTest
    INFO: delete a contact by id
    Tests run: 5, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.51 sec - in org.jboss.as.quickstarts.jaxrsclient.test.ContactsRestClientTest

    Results :

    Tests run: 5, Failures: 0, Errors: 0, Skipped: 0

## Undeploy the Quickstart

When you are finished testing the quickstart, follow these steps to undeploy the archive.

1. Make sure you start the WildFly server as described above.

2. Open a terminal and navigate to the root directory of this quickstart.

3. Type this command to undeploy the archive:

       $ mvn wildfly: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 in Red Hat JBoss Developer Studio or from Eclipse using JBoss tools. For general information about how to import a quickstart, add a WildFly server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.

To run the tests in Red Hat JBoss Developer Studio:

1. You must first set the active Maven profile in project properties to be either `arq-managed` for running on managed server or `arq-remote` for running on remote server.

2. Then, to run the tests, right click on the project or individual classes and select Run As –> JUnit Test in the context menu.

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