The helloworld-ws
quickstart demonstrates a simple Hello World application, bundled and deployed as a WAR, that uses JAX-WS to say Hello.
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 8.0 or later.
All you need to build this project is Java 11.0 (Java SDK 11) or later and Maven 3.6.0 or later. See Configure Maven to Build and Deploy the Quickstarts to make sure you are configured correctly for testing the quickstarts.
In the following instructions, replace EAP_HOME
with the actual path to your JBoss EAP installation. The installation path is described in detail here: Use of EAP_HOME and JBOSS_HOME Variables.
When you see the replaceable variable QUICKSTART_HOME, replace it with the path to the root directory of all of the quickstarts.
-
Open a terminal and navigate to the root of the JBoss EAP directory.
-
Start the JBoss EAP server with the default profile by typing the following command.
$ EAP_HOME/bin/standalone.sh
NoteFor Windows, use the EAP_HOME\bin\standalone.bat
script.
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type the following command to build the quickstart.
$ mvn clean package
-
Type the following command to deploy the quickstart.
$ mvn 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
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.
This quickstart includes Arquillian integration tests. They are located under the src/test/
directory. The integration tests verify that the quickstart runs correctly when deployed on the server.
Follow these steps to run the integration tests.
-
Make sure you start the JBoss EAP server, as previously described.
-
Make sure you build and deploy the quickstart, as previously described.
-
Type the following command to run the
verify
goal with thearq-remote
profile activated.$ mvn verify -Parq-remote
Note
|
You may also use the environment variable |
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
When you are finished testing the quickstart, follow these steps to undeploy the archive.
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type this command to undeploy the archive:
$ mvn wildfly:undeploy
On OpenShift, the S2I build with Apache Maven will use an openshift
profile used to provision a JBoss EAP server to deploy and run the quickstart in OpenShift environment.
You can activate the Maven profile named openshift
when building the quickstart:
$ mvn clean package -Popenshift
The provisioned JBoss EAP server for OpenShift, with the quickstart deployed, can then be found in the target/server
directory, and its usage is similar to a standard server distribution.
You may note that it uses the cloud feature pack which enables a configuration tuned for OpenShift environment.
The server provisioning functionality is provided by the EAP Maven Plugin, and you may find its configuration in the quickstart pom.xml
:
<profile>
<id>openshift</id>
<build>
<plugins>
<plugin>
<groupId>org.jboss.eap.plugins</groupId>
<artifactId>eap-maven-plugin</artifactId>
<version>${version.eap.maven.plugin}</version>
<configuration>
<feature-packs>
<feature-pack>
<location>org.jboss.eap:wildfly-ee-galleon-pack</location>
</feature-pack>
<feature-pack>
<location>org.jboss.eap.cloud:eap-cloud-galleon-pack</location>
</feature-pack>
</feature-packs>
<layers>
<layer>cloud-server</layer>
</layers>
<filename>ROOT.war</filename>
</configuration>
<executions>
<execution>
<goals>
<goal>package</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
Note
|
Since the plugin configuration above deploys quickstart on root web context of the provisioned server, the URL to access the application should not have the |
This section contains the basic instructions to build and deploy this quickstart to JBoss EAP for OpenShift or JBoss EAP for OpenShift Online using Helm Charts.
-
You must be logged in OpenShift and have an
oc
client to connect to OpenShift -
Helm must be installed to deploy the backend on OpenShift.
Once you have installed Helm, you need to add the repository that provides Helm Charts for JBoss EAP.
$ helm repo add jboss-eap https://jbossas.github.io/eap-charts/
"jboss-eap" has been added to your repositories
$ helm search repo jboss-eap
NAME CHART VERSION APP VERSION DESCRIPTION
jboss-eap/eap8 ... ... A Helm chart to build and deploy EAP 8.0 applications
Log in to your OpenShift instance using the oc login
command.
The backend will be built and deployed on OpenShift with a Helm Chart for JBoss EAP.
Navigate to the root directory of this quickstart and run the following command:
$ helm install helloworld-ws -f charts/helm.yaml jboss-eap/eap8
NAME: helloworld-ws
...
STATUS: deployed
REVISION: 1
The Helm Chart for this quickstart contains all the information to build an image from the source code using S2I on Java 17:
build:
uri: https://github.com/jboss-developer/jboss-eap-quickstarts.git
ref: 8.0.x
contextDir: helloworld-ws
deploy:
replicas: 1
This will create a new deployment on OpenShift and deploy the application.
If you want to see all the configuration elements to customize your deployment you can use the following command:
$ helm show readme jboss-eap/eap8
Let’s wait for the application to be built and deployed:
$ oc get deployment helloworld-ws -w
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
helloworld-ws 1 1 1 0 12s
...
helloworld-ws 1 1 1 1 2m
Get the URL of the route to the deployment.
$ oc get route helloworld-ws -o jsonpath="{.spec.host}"
Access the application in your web browser using the displayed URL.
Note
|
The Maven profile named |
This quickstart includes Arquillian integration tests. They are located under the src/test/
directory. The integration tests verify that the quickstart runs correctly when deployed on the server.
Note
|
The Arquillian integration tests expect a deployed application, so make sure you have deployed the quickstart on OpenShift before you begin. |
Run the integration tests using the following command to run the verify
goal with the arq-remote
profile activated and the proper URL:
$ mvn clean verify -Parq-remote -Dserver.host=https://$(oc get route helloworld-ws --template='{{ .spec.host }}')
Note
|
The tests are using SSL to connect to the quickstart running on OpenShift. So you need the certificates to be trusted by the machine the tests are run from. |