1 //
2 // ========================================================================
3 // Copyright (c) 1995-2013 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 import org.eclipse.jetty.websocket.api.UpgradeRequest;
22 import org.eclipse.jetty.websocket.api.UpgradeResponse;
23 import org.eclipse.jetty.websocket.api.extensions.Extension;
24
25 /**
26 * Abstract WebSocket creator interface.
27 * <p>
28 * 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
29 * WebSocketCreator implementation.
30 * <p>
31 * This has been moved from the WebSocketServlet to a standalone class managed by the WebSocketServerFactory due to need of WebSocket {@link Extension}s that
32 * require the ability to create new websockets (such as the mux extension)
33 */
34 public interface WebSocketCreator
35 {
36 /**
37 * Create a websocket from the incoming request.
38 * <p>
39 * Note: if you have Servlet specific information you need to access from the UpgradeRequest, cast the {@link UpgradeRequest} to
40 * {@link ServletUpgradeRequest} for this extra information.
41 * <p>
42 * Future versions of this interface will change to use the Servlet specific Upgrade Request and Response parameters.
43 *
44 * @param req
45 * the request details
46 * @param resp
47 * the response details
48 * @return a websocket object to use, or null if no websocket should be created from this request.
49 */
50 Object createWebSocket(UpgradeRequest req, UpgradeResponse resp);
51 }