org.eclipse.jetty.websocket
Class WebSocketServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.eclipse.jetty.websocket.WebSocketServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public abstract class WebSocketServlet
extends javax.servlet.http.HttpServlet

Servlet to upgrade connections to WebSocket

The request must have the correct upgrade headers, else it is handled as a normal servlet request.

The initParameter "bufferSize" can be used to set the buffer size, which is also the max frame byte size (default 8192).

The initParameter "maxIdleTime" can be used to set the time in ms that a websocket may be idle before closing (default 300,000).

See Also:

Serialized Form

Constructor Summary

WebSocketServlet()

Method Summary

protected java.lang.String	checkOrigin(javax.servlet.http.HttpServletRequest request, java.lang.String host, java.lang.String origin)
protected abstract WebSocket	doWebSocketConnect(javax.servlet.http.HttpServletRequest request, java.lang.String protocol)
void	init()
protected void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

destroy, 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

WebSocketServlet

public WebSocketServlet()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

See Also:

GenericServlet.init()

service

protected void service(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws javax.servlet.ServletException,
                       java.io.IOException

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

HttpServlet.service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

checkOrigin

protected java.lang.String checkOrigin(javax.servlet.http.HttpServletRequest request,
                                       java.lang.String host,
                                       java.lang.String origin)

doWebSocketConnect

protected abstract WebSocket doWebSocketConnect(javax.servlet.http.HttpServletRequest request,
                                                java.lang.String protocol)