Package org.eclipse.jetty.websocket.servlet

Interface WebSocketCreator

  • All Known Implementing Classes:
    WebSocketServerFactory
    @Deprecated(since="2021-05-27")
public interface WebSocketCreator
    Deprecated.
    The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
    Abstract WebSocket creator interface.

    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 WebSocketCreator implementation.

    This has been moved from the WebSocketServlet to a standalone class managed by the WebSocketServerFactory due to need of WebSocket Extensions that require the ability to create new websockets (such as the mux extension)

    • Method Detail

      • createWebSocket

        java.lang.Object createWebSocket​(ServletUpgradeRequest req,
                                 ServletUpgradeResponse resp)
        Deprecated.
        Create a websocket from the incoming request.
        Parameters:
        req - the request details
        resp - the response details
        Returns:
        a websocket object to use, or null if no websocket should be created from this request.