Java EE 7 WebSocket Sample

This project contains a simple WebSocket application which demonstrates the Java EE 7 technology.

These web sockets sample shows how to set up WebSocket Endpoints using annotations or programmatically.

These samples exercise different operations on a WebSocket connection:

• Opening
• Reading
• Writing
• Closing

Also shown is the use of encoders, decoders, the PathParam annotation, and Pong message processing.

Getting Started

Browse the code to see what it does, or build and run it yourself!

Running in Eclipse

Maven

1. Download and install Eclipse with the WebSphere Developer Tools.
2. Clone this repository.
3. Import the sample into Eclipse using File -> Import -> Maven -> Existing Maven Projects option.
4. Right click on the project and select Run As -> Run on Server option. Find and select the Liberty profile server and press Finish.
5. Go to: http://localhost:9080/sample.javaee7.websocket/

Gradle

1. Go to Help > Eclipse Marketplace > Install Buildship Gradle Integration 2.0
2. Clone this project and import into Eclipse as an 'Existing Gradle Project'.
3. Go to Window > Show View > Other > Gradle Executions & Gradle Tasks
4. Go to Gradle Tasks view and run clean in build folder, then build in build folder, then libertyStart in liberty folder.
5. You should see the following in the console: Application sample.javaee7.websocket started in XX.XX seconds.
6. Go to: http://localhost:9080/sample.javaee7.websocket/

Running with the Command Line

Maven

This project can be built with Apache Maven. The project uses Liberty Maven Plug-in to automatically download and install Liberty profile runtime from the Liberty repository. Liberty Maven Plug-in is also used to create, configure, and run the application on the Liberty server.

Use the following steps to run the application with Maven:

1. Execute full Maven build. This will cause Liberty Maven Plug-in to download and install Liberty profile server.

   $ mvn clean install

2. To run the server with the WebSocket application execute:

   $ mvn liberty:run-server

Once the server is running, the application will be available under http://localhost:9080/sample.javaee7.websocket/.

Gradle

This project can also be built and run with Gradle. The provided build.gradle file applies the Liberty Gradle Plug-in and is configured to automatically download and install the Liberty Java EE7 Web Profile 7 runtime from Maven Central. The Liberty Gradle Plug-in has built-in tasks that can be used to create, configure, and run the application on the Liberty server.

Use the following steps to run the application with Gradle:

1. Execute the full Gradle build. The Liberty Gradle Plug-in will download and install the Liberty server.

   $ ./gradlew clean build

2. To start the server with the Servlet sample execute:

   $ ./gradlew libertyStart

   Alternatively, execute the run command:

   $ ./gradlew libertyRun --no-daemon

Once the server has started, the application will be available under http://localhost:9080/sample.javaee7.websocket/.

3. To stop the server, execute:

   $ ./gradlew libertyStop

Please refer to the ci.gradle repository for documentation about using the Liberty Gradle Plug-in.

Deploying to Bluemix

Click the button below to deploy your own copy of this application to Bluemix.

Once the application is deployed and running in bluemix, it will be available under http://MYAPPNAME.mybluemix.net/sample.javaee7.websocket/.

Notice

© Copyright IBM Corporation 2015, 2017.

License

This information contains sample code provided in source code form. You may copy, modify, and distribute these sample programs in any form without payment to IBM for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample code is written.

Notwithstanding anything to the contrary, IBM PROVIDES THE SAMPLE SOURCE CODE ON AN "AS IS" BASIS AND IBM DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND ANY WARRANTY OR CONDITION OF NON-INFRINGEMENT. IBM SHALL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY OR ECONOMIC CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR OPERATION OF THE SAMPLE SOURCE CODE. IBM SHALL NOT BE LIABLE FOR LOSS OF, OR DAMAGE TO, DATA, OR FOR LOST PROFITS, BUSINESS REVENUE, GOODWILL, OR ANTICIPATED SAVINGS. IBM HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS TO THE SAMPLE SOURCE CODE.