Skip to content

Latest commit

 

History

History
executable file
·
118 lines (56 loc) · 2.89 KB

README.md

File metadata and controls

executable file
·
118 lines (56 loc) · 2.89 KB
Raw

Tomcat 7.0.47 Websockets Example

This project is an attempt to illustrate how to create a websocket server with Apache Tomcat.

Tomcat 7.0.47 implements the Java WebSocket 1.0 API defined by JSR-356.

http://www.jcp.org/en/jsr/detail?id=356

This implementation provides support for Websockets as defined by RFC 6455

http://tools.ietf.org/html/rfc6455

The JSR-356 Java WebSocket 1.0 implementation is only available when Tomcat is running on Java 7 or later.

It is recommended to install Java 7 update 25 as this is the last known stable version of the Java 7 series.

Sample Code from Tomcat 7 Project

Sample Java code is available here

http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/examples/WEB-INF/classes/websocket/echo/

http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/examples/WEB-INF/classes/websocket/drawboard/

Sample HTML, CSS and Javascript code is available here

http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/examples/websocket/

Supported Browsers

The following browsers support the latest specification (RFC 6455) of the WebSocket protocol.

  • Google Chrome 16 or later (PC, Mobile)
  • Mozilla Firefox 11 or later (PC, Mobile)
  • Apple Safari 6 or later (Mac, IOS)
  • Microsoft Internet Explorer 10 or later
  • Opera 12.10 or later (PC, Mobile)

How to Checkout this Project

Clone the GIT project

$ git clone https://github.com/bigdata1024/tomcat-websockets-example.git websocket

How to Compile the Project

You will need Apache ANT 1.8 or later with Apache Maven 3.0 or later.

# Change the current working directory to the project folder
cd websocket

mvn clean package -U

How to Deploy the Project

Once the project has been compiled, copy the war file from the target folder to the $CATALINA_HOME/webapps folder

Restart Tomcat

The Websockets application should now be available, if all is well.

To Edit the Project Using Eclipse

You can generate the eclipse project for import into Eclipse by running the following commands

# Navigate into the Project Directory
cd websocket

# Optional
$ ant clean

# Generates the Eclipse Project and Downloads Sources for Dependencies
$ mvn eclipse:clean eclipse:eclipse -DdownloadSources=true

References for Websocket Annotations

Links to different annotations used in the project

https://javaee-spec.java.net/nonav/javadocs/javax/websocket/OnOpen.html

https://javaee-spec.java.net/nonav/javadocs/javax/websocket/OnMessage.html

https://javaee-spec.java.net/nonav/javadocs/javax/websocket/OnClose.html

https://javaee-spec.java.net/nonav/javadocs/javax/websocket/Endpoint.html

https://javaee-spec.java.net/nonav/javadocs/javax/websocket/OnError.html

https://javaee-spec.java.net/nonav/javadocs/javax/websocket/server/PathParam.html

https://javaee-spec.java.net/nonav/javadocs/javax/websocket/server/ServerEndpoint.html