1 //
2 // ========================================================================
3 // Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
4 // ------------------------------------------------------------------------
5 // All rights reserved. This program and the accompanying materials
6 // are made available under the terms of the Eclipse Public License v1.0
7 // and Apache License v2.0 which accompanies this distribution.
8 //
9 // The Eclipse Public License is available at
10 // http://www.eclipse.org/legal/epl-v10.html
11 //
12 // The Apache License v2.0 is available at
13 // http://www.opensource.org/licenses/apache2.0.php
14 //
15 // You may elect to redistribute this code under either of these licenses.
16 // ========================================================================
17 //
18
19 package org.eclipse.jetty.websocket.servlet;
20
21 /**
22 * Abstract WebSocket creator interface.
23 * <p>
24 * Should you desire filtering of the WebSocket object creation due to criteria such as origin or sub-protocol, then you will be required to implement a custom
25 * WebSocketCreator implementation.
26 * <p>
27 * This has been moved from the WebSocketServlet to a standalone class managed by the WebSocketServerFactory due to need of WebSocket {@link org.eclipse.jetty.websocket.api.extensions.Extension}s that
28 * require the ability to create new websockets (such as the mux extension)
29 */
30 public interface WebSocketCreator
31 {
32 /**
33 * Create a websocket from the incoming request.
34 *
35 * @param req
36 * the request details
37 * @param resp
38 * the response details
39 * @return a websocket object to use, or null if no websocket should be created from this request.
40 */
41 Object createWebSocket(ServletUpgradeRequest req, ServletUpgradeResponse resp);
42 }