org.eclipse.jetty.websocket.WebSocketServlet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetty-websocket Show documentation
There is a newer version: 8.2.0.v20160908
//
//  ========================================================================
//  Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
//  ------------------------------------------------------------------------
//  All rights reserved. This program and the accompanying materials
//  are made available under the terms of the Eclipse Public License v1.0
//  and Apache License v2.0 which accompanies this distribution.
//
//      The Eclipse Public License is available at
//      http://www.eclipse.org/legal/epl-v10.html
//
//      The Apache License v2.0 is available at
//      http://www.opensource.org/licenses/apache2.0.php
//
//  You may elect to redistribute this code under either of these licenses.
//  ========================================================================
//

package org.eclipse.jetty.websocket;

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;

/* ------------------------------------------------------------ */
/**
 * 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 is 300000)
 * 

 * The initParameter "maxTextMessageSize" can be used to set the size in characters
 * that a websocket may be accept before closing. (Default is 16768)
 * 

 * The initParameter "maxBinaryMessageSize" can be used to set the size in bytes
 * that a websocket may be accept before closing. (Default is -1 - or unlimited)
 * 
 * The initParameter "minVersion" can be used to set the minimum protocol version
 * accepted. (Default 13 - the RFC6455 version)
 */
@SuppressWarnings("serial")
public abstract class WebSocketServlet extends HttpServlet implements WebSocketFactory.Acceptor
{
    private final Logger LOG = Log.getLogger(getClass());
    private WebSocketFactory _webSocketFactory;

    /* ------------------------------------------------------------ */
    /**
     * @see javax.servlet.GenericServlet#init()
     */
    @Override
    public void init() throws ServletException
    {
        try
        {
            String bs = getInitParameter("bufferSize");
            _webSocketFactory = new WebSocketFactory(this, bs == null ? 8192 : Integer.parseInt(bs));
            _webSocketFactory.start();

            String max = getInitParameter("maxIdleTime");
            if (max != null)
                _webSocketFactory.setMaxIdleTime(Integer.parseInt(max));

            max = getInitParameter("maxTextMessageSize");
            if (max != null)
                _webSocketFactory.setMaxTextMessageSize(Integer.parseInt(max));

            max = getInitParameter("maxBinaryMessageSize");
            if (max != null)
                _webSocketFactory.setMaxBinaryMessageSize(Integer.parseInt(max));
            
            String min = getInitParameter("minVersion");
            if (min != null)
                _webSocketFactory.setMinVersion(Integer.parseInt(min));
        }
        catch (ServletException x)
        {
            throw x;
        }
        catch (Exception x)
        {
            throw new ServletException(x);
        }
    }

    /* ------------------------------------------------------------ */
    /**
     * @see javax.servlet.http.HttpServlet#service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
     */
    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
    {
        if (_webSocketFactory.acceptWebSocket(request, response) || response.isCommitted())
            return;
        super.service(request, response);
    }

    /* ------------------------------------------------------------ */
    public boolean checkOrigin(HttpServletRequest request, String origin)
    {
        return true;
    }

    /* ------------------------------------------------------------ */
    @Override
    public void destroy()
    {
        try
        {
            _webSocketFactory.stop();
        }
        catch (Exception x)
        {
            LOG.ignore(x);
        }
    }
}