Package burp.api.montoya.proxy.websocket

Interface TextMessageReceivedAction

public interface TextMessageReceivedAction
Extensions can implement this interface when returning a text message from ProxyMessageHandler.handleTextMessageReceived(InterceptedTextMessage).

  • Method Details

    • action

      MessageReceivedAction action()
      Returns:
      The action associated with this message.

    • payload

      String payload()
      Returns:
      The payload of this message.

    • continueWith

      static TextMessageReceivedAction continueWith(String payload)
      Build a text WebSocket message to follow the current interception rules to determine the appropriate action to take for the message.
      Parameters:
      payload - The text message payload.
      Returns:
      The TextMessageReceivedAction that allows user rules to be followed.

    • continueWith

      static TextMessageReceivedAction continueWith(TextMessage message)
      Build a text WebSocket message to follow the current interception rules to determine the appropriate action to take for the message.
      Parameters:
      message - The text message.
      Returns:
      The TextMessageReceivedAction that allows user rules to be followed.

    • intercept

      static TextMessageReceivedAction intercept(String payload)
      Build a text WebSocket message to be intercepted within the Proxy.
      Parameters:
      payload - The text message payload.
      Returns:
      The message.

    • intercept

      static TextMessageReceivedAction intercept(TextMessage message)
      Build a text WebSocket message to be intercepted within the Proxy.
      Parameters:
      message - The text message.
      Returns:
      The message.

    • doNotIntercept

      static TextMessageReceivedAction doNotIntercept(String payload)
      Build a text WebSocket message to continue within the Proxy without interception.
      Parameters:
      payload - The text message payload.
      Returns:
      The message.

    • doNotIntercept

      static TextMessageReceivedAction doNotIntercept(TextMessage message)
      Build a text WebSocket message to continue within the Proxy without interception.
      Parameters:
      message - The text message payload.
      Returns:
      The message.

    • drop

      static TextMessageReceivedAction drop()
      Build a text WebSocket message to be dropped.
      Returns:
      The message to be dropped.