Interface WebSockets

public interface WebSockets

Provides access to WebSocket related functionality of Burp.

Method Summary

Modifier and Type	Method	Description
ExtensionWebSocketCreation	createWebSocket(HttpService service, String path)	Create a new WebSocket using the specified service and path.
ExtensionWebSocketCreation	createWebSocket(HttpRequest upgradeRequest)	Create a new WebSocket using the specified upgrade request.
Registration	registerWebSocketCreatedHandler(WebSocketCreatedHandler handler)	Register a handler which will be invoked whenever a WebSocket is created by any Burp tool.

Method Details

registerWebSocketCreatedHandler

Registration registerWebSocketCreatedHandler(WebSocketCreatedHandler handler)

Register a handler which will be invoked whenever a WebSocket is created by any Burp tool.

Parameters:

handler - An object created by the extension that implements WebSocketCreatedHandler interface.

Returns:

The Registration for the handler.

createWebSocket

ExtensionWebSocketCreation createWebSocket(HttpService service,
 String path)

Create a new WebSocket using the specified service and path.

Parameters:

service - An HttpService specifying the target host

path - path for the upgrade HTTP request

Returns:

The ExtensionWebSocketCreation result.

createWebSocket

ExtensionWebSocketCreation createWebSocket(HttpRequest upgradeRequest)

Create a new WebSocket using the specified upgrade request.

Parameters:

upgradeRequest - The HttpRequest upgrade request

Returns:

The ExtensionWebSocketCreation result.