Author: Lee Newson
Level: Beginner
Technologies: JAX-WS
Summary: The helloworld-ws quickstart demonstrates a simple Hello World application, bundled and deployed as a WAR, that uses JAX-WS to say Hello.
Target Product: JBoss EAP
Source: https://github.com/jboss-developer/jboss-eap-quickstarts/
The helloworld-ws quickstart demonstrates the use of JAX-WS in Red Hat JBoss Enterprise Application Platform as a simple Hello World application.
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.
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.
The following shows the command line to start the server:
For Linux: EAP_HOME/bin/standalone.sh
For Windows: EAP_HOME\bin\standalone.bat
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.
Type this command to build and deploy the archive:
mvn clean install jboss-as:deploy
This will deploy target/jboss-helloworld-ws.war to the running instance of the server.
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/jboss-helloworld-ws/HelloWorldService
implementor=org.jboss.as.quickstarts.wshelloworld.HelloWorldServiceImpl
serviceName={http://www.jboss.org/jbossas/quickstarts/wshelloworld/HelloWorld}HelloWorldService
portName={http://www.jboss.org/jbossas/quickstarts/wshelloworld/HelloWorld}HelloWorld
annotationWsdlLocation=null
wsdlLocationOverride=null
mtomEnabled=false
You can verify that the Web Service is running and deployed correctly by accessing the following URL: http://localhost:8080/jboss-helloworld-ws/HelloWorldService?wsdl. This URL will display the deployed WSDL endpoint for the Web Service.
When you are finished testing, type this command to undeploy the archive:
mvn jboss-as:undeploy
This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.
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.
Type the following command to run the test goal with the following profile activated:
mvn clean test -Parq-jbossas-remote
The following expected output should appear. The output shows what was said to the Web Service by the client and the responses it received.
-------------------------------------------------------
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
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
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
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.
NOTE: The domain name for this application will be helloworldws-YOUR_DOMAIN_NAME.rhcloud.com. 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 helloworldws -t jbosseap-6
This command creates an OpenShift application called helloworldws 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 'helloworldws' ... done
Waiting for your DNS name to be available ... done
Cloning into 'helloworldws'...
Warning: Permanently added the RSA host key for IP address '54.237.58.0' to the list of known hosts.
Your application 'helloworldws' is now available.
URL: http://helloworldws-YOUR_DOMAIN_NAME.rhcloud.com/
SSH to: 52864af85973ca430200006f@helloworldws-YOUR_DOMAIN_NAME.rhcloud.com
Git remote: ssh://52864af85973ca430200006f@helloworldws-YOUR_DOMAIN_NAME.rhcloud.com/~/git/helloworldws.git/
Cloned to: CURRENT_DIRECTORY/helloworldws
Run 'rhc show-app helloworldws' for more details about your app.
The create command creates a git repository in the current directory with the same name as the application, in this case, helloworldws. 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 http://helloworldws-YOUR_DOMAIN_NAME.rhcloud.com/ 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.
Now that you have confirmed it is working you can now migrate the quickstart source and POM file. You no longer need the default application, so change directory into the new git repository and tell git to remove the source and pom files:
cd helloworldws
git rm -r src pom.xml
Copy the source and POM file for the helloworld-ws quickstart into this new git repository:
cp -r QUICKSTART_HOME/helloworld-ws/src .
cp QUICKSTART_HOME/helloworld-ws/pom.xml .
Verify that Openshift has Web services configured by default. To do this:
.openshift/config/standalone.xml file in an editor. If the webservices subsystem is not configured as below under the <profile> element, copy the following and replace the webservices subsystem to enable and configure Web Services:
<subsystem xmlns="urn:jboss:domain:webservices:1.2">
<modify-wsdl-address>true</modify-wsdl-address>
<wsdl-host>${env.OPENSHIFT_GEAR_DNS}</wsdl-host>
<wsdl-port>80</wsdl-port>
<endpoint-config name="Standard-Endpoint-Config"/>
<endpoint-config name="Recording-Endpoint-Config">
<pre-handler-chain name="recording-handlers" protocol-bindings="##SOAP11_HTTP ##SOAP11_HTTP_MTOM ##SOAP12_HTTP ##SOAP12_HTTP_MTOM">
<handler name="RecordingHandler" class="org.jboss.ws.common.invocation.RecordingServerHandler"/>
</pre-handler-chain>
</endpoint-config>
</subsystem>
You can now deploy the changes to your OpenShift application using git as follows:
git add src pom.xml
git commit -m "helloworld-ws 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 pom.xml file is activated by OpenShift and causes the WAR built by openshift to be copied to the deployments/ directory and deployed to the “jboss-helloworld-ws” context path.
Once the application is deployed, you can test the application by accessing the following URL 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.
http://helloworldws-YOUR_DOMAIN_NAME.rhcloud.com/jboss-helloworld-ws/HelloWorldService?wsdl
If the application has run successfully you should see the WSDL output in the browser.
You can use the OpenShift command line tools or the OpenShift web console to discover and control the application.
Now you can look at the output of the server by running the following command:
rhc tail -a helloworldws
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 [org.jboss.as.controller.management-operation] (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.
This quickstart provides tests that can be run remotely. By default, these tests are configured to be skipped as the tests require the application to be running remotely.
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.
Type the following command to run the test goal with the following profile activated and the URL of the deployed Application. Be sure to replaces YOUR_DOMAIN_NAME in the URL with your OpenShift account domain name:
mvn clean test -Pjbossas-remote -Dremote.server.url=http://helloworldws-YOUR_DOMAIN_NAME.rhcloud.com/
When you are finished with the application you can delete it from OpenShift as follows:
rhc app-delete -a helloworldws
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.
rhc domain showrhc app-delete -a APPLICATION_NAME_TO_DELETE