Package burp.api.montoya.websocket

Interface MessageHandler

public interface MessageHandler

This interface allows an extension to be notified when messages are received or the WebSocket has been closed.

Method Summary

Modifier and Type	Method	Description
BinaryMessageAction	handleBinaryMessage(BinaryMessage binaryMessage)	Invoked when a binary message is sent or received from the application.
TextMessageAction	handleTextMessage(TextMessage textMessage)	Invoked when a text message is sent or received from the application.
default void	onClose()	Invoked when the WebSocket is closed.

Method Details

handleTextMessage

TextMessageAction handleTextMessage(TextMessage textMessage)

Invoked when a text message is sent or received from the application. This gives the extension the ability to modify the message before it is sent to the application or processed by Burp.

Parameters:

textMessage - Intercepted text based WebSocket message.

Returns:

The message.

handleBinaryMessage

BinaryMessageAction handleBinaryMessage(BinaryMessage binaryMessage)

Invoked when a binary message is sent or received from the application. This gives the extension the ability to modify the message before it is sent to the application or processed by Burp.

Parameters:

binaryMessage - Intercepted binary based WebSocket message.

Returns:

The message.

onClose

default void onClose()

Invoked when the WebSocket is closed.