1 // ========================================================================
2 // Copyright (c) 2010 Mort Bay Consulting Pty. Ltd.
3 // ------------------------------------------------------------------------
4 // All rights reserved. This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v1.0
6 // and Apache License v2.0 which accompanies this distribution.
7 // The Eclipse Public License is available at
8 // http://www.eclipse.org/legal/epl-v10.html
9 // The Apache License v2.0 is available at
10 // http://www.opensource.org/licenses/apache2.0.php
11 // You may elect to redistribute this code under either of these licenses.
12 // ========================================================================
13
14 package org.eclipse.jetty.websocket;
15
16 import java.io.IOException;
17
18 import javax.servlet.ServletException;
19 import javax.servlet.http.HttpServlet;
20 import javax.servlet.http.HttpServletRequest;
21 import javax.servlet.http.HttpServletResponse;
22
23
24 /* ------------------------------------------------------------ */
25 /**
26 * Servlet to upgrade connections to WebSocket
27 * <p>
28 * The request must have the correct upgrade headers, else it is
29 * handled as a normal servlet request.
30 * <p>
31 * The initParameter "bufferSize" can be used to set the buffer size,
32 * which is also the max frame byte size (default 8192).
33 * <p>
34 * The initParameter "maxIdleTime" can be used to set the time in ms
35 * that a websocket may be idle before closing (default 300,000).
36 *
37 */
38 public abstract class WebSocketServlet extends HttpServlet
39 {
40 WebSocketFactory _websocket;
41
42 /* ------------------------------------------------------------ */
43 /**
44 * @see javax.servlet.GenericServlet#init()
45 */
46 @Override
47 public void init() throws ServletException
48 {
49 String bs=getInitParameter("bufferSize");
50 _websocket = new WebSocketFactory(bs==null?8192:Integer.parseInt(bs));
51 String mit=getInitParameter("maxIdleTime");
52 if (mit!=null)
53 _websocket.setMaxIdleTime(Integer.parseInt(mit));
54 }
55
56 /* ------------------------------------------------------------ */
57 /**
58 * @see javax.servlet.http.HttpServlet#service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
59 */
60 @Override
61 protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
62 {
63 if ("WebSocket".equals(request.getHeader("Upgrade")))
64 {
65 boolean hixie = request.getHeader("Sec-WebSocket-Key1")!=null;
66
67 String protocol=request.getHeader(hixie?"Sec-WebSocket-Protocol":"WebSocket-Protocol");
68 if (protocol==null)
69 protocol=request.getHeader("Sec-WebSocket-Protocol");
70 WebSocket websocket=doWebSocketConnect(request,protocol);
71
72 String host=request.getHeader("Host");
73 String origin=request.getHeader("Origin");
74 origin=checkOrigin(request,host,origin);
75
76 if (websocket!=null)
77 _websocket.upgrade(request,response,websocket,origin,protocol);
78 else
79 {
80 if (hixie)
81 response.setHeader("Connection","close");
82 response.sendError(503);
83 }
84 }
85 else
86 super.service(request,response);
87 }
88
89 protected String checkOrigin(HttpServletRequest request, String host, String origin)
90 {
91 if (origin==null)
92 origin=host;
93 return origin;
94 }
95
96 abstract protected WebSocket doWebSocketConnect(HttpServletRequest request,String protocol);
97
98
99 }