websocket-endpoint: Web application using WebSockets and JSON-P

Shows how to use WebSockets with JSON to broadcast information to all open WebSocket sessions in WildFly.

What is it?

The websocket-endpoint quickstart demonstrates how to use Java API for WebSockets to create server endpoints in WildFly Application Server.

The BidWebSocketEndpoint provides the WebSocket endpoint that receives Message instances from clients/browsers and replies with the current Bidding instance. The conversion from JSON content to the specific instances are made by MessageDecoder and BiddingEncode classes.

Every update made on the Bidding are immediately propagated to all opened WebSocket sessions without any browser submission or AJAX polling mechanism.

System Requirements

The application this project produces is designed to be run on WildFly Application Server 13 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

Open a terminal and navigate to the root of the WildFly directory.
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

Make sure you start the WildFly server as described above.
Open a terminal and navigate to the root directory of this quickstart.
Type the following command to build the artifacts.
```
$ mvn clean package wildfly:deploy
```

This deploys the websocket-endpoint/target/websocket-endpoint.war to the running instance of the server.

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

Access the application

Access the running application in a browser at the following URL: http://localhost:8080/websocket-endpoint/

You are presented with a simple form that shows a bidding with the status NOT_STARTED.

Click on Do a bid! button. That will start the bidding and trigger the 1 minute countdown timer. You can also notice that every Bid will be listed under the List of bids section.

You should open the application URL in other browsers or tabs. You will notice that every change on the bidding is automatically update in all opened browser or tabs. The item will be SOLD once that it reaches the Buy now price. At the countdown timeout, the bidding will be EXPIRED. You can click on Buy it now button to immediately buy the item.

You can restart the bidding if you click on Reset bidding button.

Undeploy the Quickstart

When you are finished testing the quickstart, follow these steps to undeploy the archive.

Make sure you start the WildFly 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
```

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.

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