Package burp.api.montoya.proxy.websocket

Interface BinaryMessageReceivedAction

public interface BinaryMessageReceivedAction
Extensions can implement this interface when returning a binary message from ProxyMessageHandler.handleBinaryMessageReceived(InterceptedBinaryMessage).

  • Method Details

    • action

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

    • payload

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

    • continueWith

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

    • continueWith

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

    • intercept

      static BinaryMessageReceivedAction intercept(ByteArray payload)
      Build a binary WebSocket message to be intercepted within the Proxy.
      Parameters:
      payload - The binary message payload.
      Returns:
      The message.

    • intercept

      static BinaryMessageReceivedAction intercept(BinaryMessage message)
      Build a binary WebSocket message to be intercepted within the Proxy.
      Parameters:
      message - The binary message.
      Returns:
      The message.

    • doNotIntercept

      static BinaryMessageReceivedAction doNotIntercept(ByteArray payload)
      Build a binary WebSocket message to continue within the Proxy without interception.
      Parameters:
      payload - The binary message payload.
      Returns:
      The message.

    • doNotIntercept

      static BinaryMessageReceivedAction doNotIntercept(BinaryMessage message)
      Build a binary WebSocket message to continue within the Proxy without interception.
      Parameters:
      message - The binary message.
      Returns:
      The message.

    • drop

      static BinaryMessageReceivedAction drop()
      Build a binary WebSocket message to be dropped.
      Returns:
      The message to be dropped.