org.eclipse.jetty.websocket
Class WebSocketServlet

java.lang.Object
  extended by javax.servlet.GenericServlet
      extended by javax.servlet.http.HttpServlet
          extended by org.eclipse.jetty.websocket.WebSocketServlet
All Implemented Interfaces:
Serializable, Servlet, ServletConfig, WebSocketFactory.Acceptor

public abstract class WebSocketServlet
extends HttpServlet
implements WebSocketFactory.Acceptor

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
 String checkOrigin(HttpServletRequest request, String host, String origin)
           
 void init()
           
protected  void service(HttpServletRequest request, 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
 
Methods inherited from interface org.eclipse.jetty.websocket.WebSocketFactory.Acceptor
doWebSocketConnect
 

Constructor Detail

WebSocketServlet

public WebSocketServlet()
Method Detail

init

public void init()
          throws ServletException
Overrides:
init in class GenericServlet
Throws:
ServletException
See Also:
GenericServlet.init()

service

protected void service(HttpServletRequest request,
                       HttpServletResponse response)
                throws ServletException,
                       IOException
Overrides:
service in class HttpServlet
Throws:
ServletException
IOException
See Also:
HttpServlet.service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

checkOrigin

public String checkOrigin(HttpServletRequest request,
                          String host,
                          String origin)
Specified by:
checkOrigin in interface WebSocketFactory.Acceptor


Copyright © 1995-2011 Mort Bay Consulting. All Rights Reserved.