org.ptolemy.ptango.lib.websocket

Class PtolemyWebSocketServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.websocket.WebSocketServlet

org.ptolemy.ptango.lib.websocket.PtolemyWebSocketServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, org.eclipse.jetty.websocket.WebSocketFactory.Acceptor, WebSocketService

public class PtolemyWebSocketServlet
extends org.eclipse.jetty.websocket.WebSocketServlet
implements WebSocketService

A servlet that manages locally hosted websockets. There is one servlet per URI path. Each servlet maintains a set of WebSockets affiliated with this path. WebSockets are pairwise (client - server). Uses Jetty 8 WebSocket classes. Note that Jetty 9 has substantial WebSocket revisions that are not backward compatible. Based on http://java.dzone.com/articles/creating-websocket-chat

Since:

Ptolemy II 10.0

Version:

$Id: PtolemyWebSocketServlet.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Elizabeth Latronico

See Also:

Serialized Form

Accepted Rating:

Red (ltrnc)

Proposed Rating:

Red (ltrnc)

Constructor Summary

Constructors

Constructor and Description
PtolemyWebSocketServlet() Create a new servlet.

Method Summary

Modifier and Type	Method and Description
void	clearEndpoints() Clear the list of endpoints.
org.eclipse.jetty.websocket.WebSocket	doWebSocketConnect(javax.servlet.http.HttpServletRequest request, java.lang.String protocol) Upon receiving a connect request, create a new websocket endpoint to manage communication.
java.net.URI	getRelativePath() Not used here.
void	onMessage(WebSocketEndpoint sender, java.lang.String message) Broadcast message to other recipient actors in the Ptolemy model.
void	setConnection(org.eclipse.jetty.websocket.WebSocket.Connection connection) Set the websocket connection that the service should use.
void	setRelativePath(java.net.URI relativePath) Not used here.

Methods inherited from class org.eclipse.jetty.websocket.WebSocketServlet

checkOrigin, destroy, init, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PtolemyWebSocketServlet

public PtolemyWebSocketServlet()

Create a new servlet.

Method Detail

doWebSocketConnect

public org.eclipse.jetty.websocket.WebSocket doWebSocketConnect(javax.servlet.http.HttpServletRequest request,
                                                                java.lang.String protocol)

Upon receiving a connect request, create a new websocket endpoint to manage communication.

Specified by:

doWebSocketConnect in interface org.eclipse.jetty.websocket.WebSocketFactory.Acceptor

Parameters:

request - The request.

protocol - The protocol of the request.

Returns:

A websocket to handle the new connection.

clearEndpoints

public void clearEndpoints()

Clear the list of endpoints. Called by the WebServer in initialize().

getRelativePath

public java.net.URI getRelativePath()

Not used here.

Specified by:

getRelativePath in interface WebSocketService

Returns:

The relative path that this HttpService is mapped to.

See Also:

setRelativePath(URI)

onMessage

public void onMessage(WebSocketEndpoint sender,
                      java.lang.String message)

Broadcast message to other recipient actors in the Ptolemy model.

Specified by:

onMessage in interface WebSocketService

Parameters:

sender - The WebSocketEndpoint that sent the message.

message - The message that was received.

setConnection

public void setConnection(org.eclipse.jetty.websocket.WebSocket.Connection connection)

Description copied from interface: WebSocketService

Set the websocket connection that the service should use.

Specified by:

setConnection in interface WebSocketService

setRelativePath

public void setRelativePath(java.net.URI relativePath)

Not used here.

Specified by:

setRelativePath in interface WebSocketService

Parameters:

relativePath - The URI to associate with this servlet.

See Also:

getRelativePath()