Demonstrates use of a Javascript WebSocket client, WebSocket configuration, programmatic binding, and secure WebSocket.

What is it?

The websocket-client quickstart demonstrates how to use the Java API for WebSockets to create Java client endpoint connected to a remote WebSocket server.

The example is modeled as a relay between a front-end WebSocket server endpoint and a back-end WebSocket client endpoint.

Message Flow:
Browser Javascript WebSocket ClientJBoss EAP WebSocket Server Endpoint`JBoss EAP Websocket Client EndpointRemote WebSocket Echo Server

CDI events are used to pass messages between the front-end and back-end servers. A single back-end WebSocket client endpoint is shared for all front-end clients.

The remote WebSocket server must be an Echo server; a simple WebSocket server that echos back messages the client sends for the purpose of testing. Such a server is publicly available at ws://echo.websocket.org, but any echo server will work.

Frontend does not use WebSocket annotations because it demonstrates how to use ServerEndpointConfig to modify the default Configurator to use an application scoped Endpoint, and how to deploy the Endpoint programatically.

Backend does not use WebSocket annotations because it demonstrates how to use ClientEndpointConfig to configure the WebSocket client to connect to a secure (wss) WebSocket.

System Requirements

The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7.1 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 EAP_HOME

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.

Start the JBoss EAP Standalone Server

  1. Open a terminal and navigate to the root of the JBoss EAP directory.

  2. Start the JBoss EAP server with the default profile by typing the following command.

    $ EAP_HOME/bin/standalone.sh 
    Note
    For Windows, use the EAP_HOME\bin\standalone.bat script.

Build and Deploy the Quickstart

  1. Make sure you start the JBoss EAP server as described above.

  2. Open a terminal and navigate to the root directory of this quickstart.

  3. Type the following command to build the artifacts.

    $ mvn clean package wildfly:deploy

This deploys the websocket-client/target/websocket-client.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-client/

You are presented with the WebSocket Echo Replay page confirming the connection to the remote WebSocket Echo server.

Connecting to ws://localhost:8080/websocket-client/relay
RECV: Opened frontend session FRONTEND_SESSION_ID

Type a message in the text input field at the bottom of the page and click Send. The message is processed and the form displays the relayed results. The message This is a test was used in the following example.

SEND: This is a test
RECV: BROADCAST: Connecting to backend wss://echo.websocket.org
RECV: BROADCAST: Opened backend session BACKEND_SESSION_ID
RECV: Sending message from frontend session FRONTEND_SESSION_ID
RECV: Received message from backend session BACKEND_SESSION_ID
RECV: This is a test

Undeploy the Quickstart

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

  1. Make sure you start the JBoss EAP server as described above.

  2. Open a terminal and navigate to the root directory of this quickstart.

  3. 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 JBoss EAP server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.

Deploy the Quickstart to OpenShift Online

Use these instructions to deploy the quickstart to Red Hat OpenShift Online. If you do not yet have an OpenShift Online account and are interested in signing up for one, see Choose a Plan in the OpenShift Online documentation located on the Red Hat Customer Portal. For information about running JBoss EAP on Red Hat OpenShift Online, see Getting Started with JBoss EAP for OpenShift Online, also located on the Red Hat Customer Portal.

Create and Deploy the Quickstart Project

Follow these instructions to deploy this quickstart to OpenShift Online.

  1. Browse to OpenShift Online console and login with your credentials.

  2. On the View All Projects or Welcome to Project page, click Create Project.

  3. On the Create Project page, enter the following information:

    Name:  websocket-client
    Display Name websocket-client
    Description: websocket-client
  4. Click Create to create the project.

  5. On the My Projects page, choose your new websocket-client and click Browse Catalog.

  6. Choose JBoss EAP CD (no https) and then click Next to view the Information page.

  7. Click Next to navigate to the Configuration page. . . Enter the following information. You can leave the remaining fields as they are.

    Add to Project: websocket-client
    Application Name: websocket-client
    Custom http Route Hostname: (leave blank)
    Git Repository URL: https://github.com/jboss-developer/jboss-eap-quickstarts/
    Git Reference: openshift
    Context directory: websocket-client
  8. Click the Create button.

  9. Click on the Continue to the project overview link.

    • You should see "Build #1 is running …​" with the console log below.

      Cloning ...
      Downloading ...
      Building ...
      Copying ...
      Pushing ...
    • At the end of the build, you should see "Push successful".

    • Click View Full Log to see the entire log.

  10. Click the Overview tab to see the websocket-client deployment.

  11. Click on the application URL on the right side of the page to view the running application. It should be in the following pattern:

    http://APPLICATION_NAME-PROJECT_NAME.PORT.HOST.openshiftapps.com

Delete the Quickstart Project

Follow these instructions to delete the project from OpenShift Online.

  1. Go to the View All Projects page and select Delete Project from the drop down list to the right of the websocket-client project.

  2. Type the name of the project to confirm, and then click Delete

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