Package org.eclipse.jetty.ee10.websocket.server

Interface JettyWebSocketCreator

public interface JettyWebSocketCreator

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.

Method Summary

Modifier and Type	Method	Description
Object	createWebSocket(JettyServerUpgradeRequest req, JettyServerUpgradeResponse resp)	Creates a websocket from the incoming request.

Method Details

createWebSocket

Object createWebSocket(JettyServerUpgradeRequest req,
 JettyServerUpgradeResponse resp)
                throws Exception

Creates a websocket from the incoming request.

If no websocket is to be created (return value of null), this JettyWebSocketCreator is responsible for sending a response with JettyServerUpgradeResponse.sendError(int, String), JettyServerUpgradeResponse.sendForbidden(String) or JettyServerUpgradeResponse.setStatusCode(int).

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.

Throws:

Exception - if the WebSocket creation throws