Package burp.api.montoya.websocket
Interface WebSocketHandler
-
public interface WebSocketHandlerThis interface allows an extension to be notified when messages are received or the WebSocket has been closed.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description WebSocketBinaryMessagehandleBinaryMessage(ByteArray binaryMessage, Direction direction)Invoked when a binary message is sent or received from the application.WebSocketTextMessagehandleTextMessage(java.lang.String textMessage, Direction direction)Invoked when a text message is sent or received from the application.default voidonClose()Invoked when the WebSocket is closed.
-
-
-
Method Detail
-
handleTextMessage
WebSocketTextMessage handleTextMessage(java.lang.String textMessage, Direction direction)
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.direction- The direction of the message.- Returns:
- The message.
-
handleBinaryMessage
WebSocketBinaryMessage handleBinaryMessage(ByteArray binaryMessage, Direction direction)
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.direction- The direction of the message.- Returns:
- The message.
-
onClose
default void onClose()
Invoked when the WebSocket is closed.
-
-