Author: Sande Gilda, Emmanuel Hugonett
Level: Beginner
Technologies: WebSocket, CDI, JSF
Summary: The websocket-hello
quickstart demonstrates how to create a simple WebSocket application.
Target Product: WildFly
Source: https://github.com/wildfly/quickstart/
The websocket-hello
quickstart demonstrates how to create a simple WebSocket-enabled application in WildFly Application Server. It consists of the following:
jboss-web.xml
file configured to enable WebSocketsWebSockets are a requirement of the Java EE 7 specification and are implemented in WildFly 11. 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 WildFly Application Server 11 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 for WildFly 11 to make sure you are configured correctly for testing the quickstarts.
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.
For Linux: WILDFLY_HOME/bin/standalone.sh
For Windows: WILDFLY_HOME\bin\standalone.bat
mvn clean install wildfly:deploy
This will deploy target/websocket-hello.war
to the running instance of the server.
The application will be running at the following URL: http://localhost:8080/websocket-hello/.
Open Connection
button to create the WebSocket connection and display current status of Open
.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.Close Connection
button to close the WebSocket connection and display the current status of Closed
.WebSocket connection is not established. Please click the Open Connection button.
mvn wildfly:undeploy
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 WildFly 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