The websocket-hello
quickstart demonstrates how to create a simple WebSocket application.
The websocket-hello
quickstart demonstrates how to create a simple WebSocket-enabled application in Red Hat JBoss Enterprise Application Platform. It consists of the following:
-
A JavaScript enabled WebSocket HTML client.
-
A WebSocket server endpoint that uses annotations to interact with the WebSocket events.
-
A
jboss-web.xml
file configured to enable WebSockets
WebSockets are a requirement of the Jakarta EE 10 specification and are implemented in JBoss EAP 8.0. They are configured in the undertow
subsystem of the server configuration file. This quickstart uses the WebSocket default settings, so it is not necessary to modify the server configuration to deploy and run this quickstart.
Note
|
This quickstart demonstrates only a few of the basic functions. A fully functional application should provide better error handling and intercept and handle additional events. |
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 websocket-hello/target/websocket-hello.war
to the running instance of the server.
You should see a message in the server log indicating that the archive deployed successfully.
The application will be running at the following URL: http://localhost:8080/websocket-hello/.
-
Click on the Open Connection button to create the WebSocket connection and display current status of
Open
. -
Type a name and click Say Hello to create and send the
Say hello to NAME
message. The message appears in the server log and a response is sent to the client. -
Click on the Close Connection button to close the WebSocket connection and display the current status of Closed.
-
If you attempt to send another message after closing the connection, the following message appears on the page:
WebSocket connection is not established. Please click the Open Connection button.
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 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 websocket-hello -f charts/helm.yaml jboss-eap/eap8
NAME: websocket-hello
...
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: websocket-hello
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 websocket-hello -w
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
websocket-hello 1 1 1 0 12s
...
websocket-hello 1 1 1 1 2m
Get the URL of the route to the deployment.
$ oc get route websocket-hello -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 websocket-hello --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. |