Package burp.api.montoya.websocket

Interface WebSocketCreationHandler

public interface WebSocketCreationHandler

Extensions can implement this interface and then call WebSockets.registerWebSocketCreationHandler(burp.api.montoya.websocket.WebSocketCreationHandler) to register a WebSocket handler. The handler will be notified of new WebSockets created by any Burp tool.

Method Summary

Modifier and Type	Method	Description
void	handleWebSocketCreated(WebSocket webSocket, HttpRequest upgradeRequest, ToolSource toolSource)	This method is invoked by Burp when a WebSocket has been created.

Method Detail

handleWebSocketCreated

void handleWebSocketCreated(WebSocket webSocket,
                            HttpRequest upgradeRequest,
                            ToolSource toolSource)

This method is invoked by Burp when a WebSocket has been created.

Parameters:

webSocket - The WebSocket that was created.

upgradeRequest - The HTTP upgrade request that initiated the WebSocket creation.

toolSource - Indicates which Burp tool that created the WebSocket.