Module org.eclipse.jetty.websocket.servlet

Package org.eclipse.jetty.websocket.servlet

Class WebSocketServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.websocket.servlet.WebSocketServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

JettyWebSocketServlet

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

Abstract Servlet used to bridge the Servlet API to the WebSocket API.

To use this servlet, you will be required to register your websockets with the WebSocketMapping so that it can create your websockets under the appropriate conditions.

The most basic implementation would be as follows:

 package my.example;

 import WebSocketServlet;
 import WebSocketServletFactory;

 public class MyEchoServlet extends WebSocketServlet
 {
     @Override
     public void configure(WebSocketServletFactory factory)
     {
       factory.setDefaultMaxFrameSize(4096);
       factory.addMapping(factory.parsePathSpec("/"), (req,res)->new EchoSocket());
     }
 }
 

Only request that conforms to a "WebSocket: Upgrade" handshake request will trigger the WebSocketMapping handling of creating WebSockets. All other requests are treated as normal servlet requests. The configuration defined by this servlet init parameters will be used as the customizer for any mappings created by WebSocketServletFactory.addMapping(PathSpec, WebSocketCreator) during configure(WebSocketServletFactory) calls. The request upgrade may be peformed by this servlet, or is may be performed by a WebSocketUpgradeFilter instance that will share the same WebSocketMapping instance. If the filter is used, then the filter configuraton is used as the default configuration prior to this servlets configuration being applied.

Configuration / Init-Parameters:

idleTimeout

set the time in ms that a websocket may be idle before closing

maxTextMessageSize

set the size in UTF-8 bytes that a websocket may be accept as a Text Message before closing

maxBinaryMessageSize

set the size in bytes that a websocket may be accept as a Binary Message before closing

inputBufferSize

set the size in bytes of the buffer used to read raw bytes from the network layer
*

outputBufferSize

set the size in bytes of the buffer used to write bytes to the network layer

maxFrameSize

The maximum frame size sent or received.

autoFragment

If true, frames are automatically fragmented to respect the maximum frame size.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
WebSocketServlet()

Method Summary

Modifier and Type	Method	Description
protected abstract void	configure(WebSocketServletFactory factory)	Configure the WebSocketServletFactory for this servlet instance by setting default configuration (which may be overriden by annotations) and mapping WebSocketCreators.
protected abstract FrameHandlerFactory	getFactory()
void	init()
protected void	service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)

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

configure

protected abstract void configure(WebSocketServletFactory factory)

Configure the WebSocketServletFactory for this servlet instance by setting default configuration (which may be overriden by annotations) and mapping WebSocketCreators. This method assumes a single FrameHandlerFactory will be available as a bean on the ContextHandler, which in practise will mostly the the Jetty WebSocket API factory.

Parameters:

factory - the WebSocketServletFactory

getFactory

protected abstract FrameHandlerFactory getFactory()

Returns:

the instance of FrameHandlerFactory to be used to create the FrameHandler

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

service

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

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException