# helloworld-ws: Hello World JAX-WS Web Service

Lee Newson

> The `helloworld-ws` quickstart demonstrates a simple Hello World application, bundled and deployed as a WAR, that uses JAX-WS to say Hello.

## What is it?

The `helloworld-ws` quickstart demonstrates the use of JAX-WS in WildFly Application Server as a simple Hello World application.

## System Requirements

The application this project produces is designed to be run on WildFly Application Server 12 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 `helloworld-ws/target/helloworld-ws.war` to the running instance of the server.

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

Review the server log to see useful information about the deployed web service endpoint.

    JBWS024061: Adding service endpoint metadata: id=org.jboss.as.quickstarts.wshelloworld.HelloWorldServiceImpl
     address=http://localhost:8080/{artifactId}/HelloWorldService
     implementor=org.jboss.as.quickstarts.wshelloworld.HelloWorldServiceImpl
     serviceName={http://www.jboss.org/eap/quickstarts/wshelloworld/HelloWorld}HelloWorldService
     portName={http://www.jboss.org/eap/quickstarts/wshelloworld/HelloWorld}HelloWorld
     annotationWsdlLocation=null
     wsdlLocationOverride=null
     mtomEnabled=false

## Access the Application

You can verify that the Web Service is running and deployed correctly by accessing the following URL: http://localhost:8080/helloworld-ws/HelloWorldService?wsdl. This URL will display the deployed WSDL endpoint for the Web Service.

## 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 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.wshelloworld.ClientArqTest
    [Client] Requesting the WebService to say Hello.
    [WebService] Hello World!
    [Client] Requesting the WebService to say Hello to John.
    [WebService] Hello John!
    [Client] Requesting the WebService to say Hello to John, Mary and Mark.
    [WebService] Hello John, Mary & Mark!
    Tests run: 3, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.988 sec

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

When you deploy this quickstart, you are presented with a window that explains there is no user interface for this quickstart and directs you to click on a link to view the WSDL definition. However, the Eclipse browser does not support the display of WSDL definitions. Instead, open an external browser and access the following URL: http://localhost:8080/helloworld-ws/HelloWorldService?wsdl. This URL will display the deployed WSDL endpoint for the Web Service.

## Deploy the Quickstart to OpenShift Online

Use these instructions to deploy the quickstart to Red Hat OpenShift Online. If you do not yet have an OpenShift Online account and are interested in signing up for one, see Choose a Plan in the OpenShift Online documentation located on the Red Hat Customer Portal. For information about running JBoss EAP on Red Hat OpenShift Online, see Getting Started with JBoss EAP for OpenShift Online, also located on the Red Hat Customer Portal.

### Create and Deploy the Quickstart Project

Follow these instructions to deploy this quickstart to OpenShift Online.

1. Browse to OpenShift Online console and login with your credentials.

2. On the View All Projects or Welcome to Project page, click Create Project.

3. On the Create Project page, enter the following information:

       Name:  helloworld-ws
       Display Name helloworld-ws
       Description: helloworld-ws

4. Click Create to create the project.

5. On the My Projects page, choose your new helloworld-ws and click Browse Catalog.

6. Choose JBoss EAP CD (no https) and then click Next to view the Information page.

7. Click Next to navigate to the Configuration page. . . Enter the following information. You can leave the remaining fields as they are.

       Add to Project: helloworld-ws
       Application Name: helloworld-ws
       Custom http Route Hostname: (leave blank)
       Git Repository URL: https://github.com/wildfly/quickstart/
       Git Reference: master
       Context directory: helloworld-ws

8. Click the Create button.

9. Click on the Continue to the project overview link.

   - You should see "Build #1 is running …​" with the console log below.

         Cloning ...
         Downloading ...
         Building ...
         Copying ...
         Pushing ...

   - At the end of the build, you should see "Push successful".

   - Click View Full Log to see the entire log.

10. Click the Overview tab to see the `helloworld-ws` deployment.

11. Click on the application URL on the right side of the page to view the running application. It should be in the following pattern:

        http://APPLICATION_NAME-PROJECT_NAME.PORT.HOST.openshiftapps.com

### Delete the Quickstart Project

Follow these instructions to delete the project from OpenShift Online.

1. Go to the View All Projects page and select Delete Project from the drop down list to the right of the helloworld-ws project.

2. Type the name of the project to confirm, and then click Delete

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