Package burp.api.montoya.proxy

Interface ProxyWebSocketMessage

All Superinterfaces:

WebSocketMessage

public interface ProxyWebSocketMessage
extends WebSocketMessage

WebSocket message intercepted by the Proxy.

Method Summary

Modifier and Type	Method	Description
Annotations	annotations()	This method retrieves the annotations for the message.
boolean	contains(String searchTerm, boolean caseSensitive)	Searches the data in the web socket message for the specified search term.
boolean	contains(Pattern pattern)	Searches the data in the web socket message for the specified regular expression.
Direction	direction()
ByteArray	editedPayload()
int	listenerPort()	Returns the proxy listener port used for the web socket message.
ByteArray	payload()
ZonedDateTime	time()
HttpRequest	upgradeRequest()
int	webSocketId()

Method Details

annotations

Annotations annotations()

This method retrieves the annotations for the message.

Specified by:

annotations in interface WebSocketMessage

Returns:

The Annotations for the message.

direction

Direction direction()

Specified by:

direction in interface WebSocketMessage

Returns:

The direction of the message.

payload

ByteArray payload()

Specified by:

payload in interface WebSocketMessage

Returns:

WebSocket payload.

upgradeRequest

HttpRequest upgradeRequest()

Specified by:

upgradeRequest in interface WebSocketMessage

Returns:

The HttpRequest used to create the WebSocket.

webSocketId

int webSocketId()

Returns:

The ID for the web socket connection that this message is linked to.

time

ZonedDateTime time()

Returns:

An instance of ZonedDateTime indicating when the message was sent.

editedPayload

ByteArray editedPayload()

Returns:

The payload after modification from tools and extensions. null if the message has not been edited.

listenerPort

int listenerPort()

Returns the proxy listener port used for the web socket message.

Returns:

the port number used by the proxy listener

contains

boolean contains(String searchTerm,
 boolean caseSensitive)

Searches the data in the web socket message for the specified search term.

Parameters:

searchTerm - The value to be searched for.

caseSensitive - Flags whether the search is case-sensitive.

Returns:

True if the search term is found.

contains

boolean contains(Pattern pattern)

Searches the data in the web socket message for the specified regular expression.

Parameters:

pattern - The regular expression to be searched for.

Returns:

True if the pattern is matched.