Class: Buby::MessageEditorController

Inherits:
Object
  • Object
show all
Includes:
Java::Burp::IMessageEditorController
Defined in:
lib/buby/message_editor_controller.rb

Overview

This interface is used by an IMessageEditor to obtain details about the currently displayed message. Extensions that create instances of Burp’s HTTP message editor can optionally provide an implementation of IMessageEditorController, which the editor will invoke when it requires further information about the current message (for example, to send it to another Burp tool). Extensions that provide custom editor tabs via an IMessageEditorTabFactory will receive a reference to an IMessageEditorController object for each tab instance they generate, which the tab can invoke if it requires further information about the current message.

Instance Method Summary collapse

Instance Method Details

#getHttpService ⇒ IHttpService

This method is abstract.

This method is used to retrieve the HTTP service for the current message.

Returns:

  • (IHttpService) —

    The HTTP service for the current message.

Raises:

  • (NotImplementedError) 


21
 
# File 'lib/buby/message_editor_controller.rb', line 21

def getHttpService; raise NotImplementedError; end

#getRequest ⇒ Array<byte>

Deprecated.

This will become a raw version/proxied version pair like ContextMenuFactory#createMenuItems in 2.0.

This method is abstract.

This method is used to retrieve the HTTP request associated with the current message (which may itself be a response).

Returns:

  • (Array<byte>) —

    The HTTP request associated with the current message.

Raises:

  • (NotImplementedError) 


31
 
# File 'lib/buby/message_editor_controller.rb', line 31

def getRequest; raise NotImplementedError; end

#getResponse ⇒ Array<byte>

Deprecated.

This will become a raw version/proxied version pair like ContextMenuFactory#createMenuItems in 2.0.

This method is abstract.

This method is used to retrieve the HTTP response associated with the current message (which may itself be a request).

Returns:

  • (Array<byte>) —

    The HTTP response associated with the current message.

Raises:

  • (NotImplementedError) 


41
 
# File 'lib/buby/message_editor_controller.rb', line 41

def getResponse; raise NotImplementedError; end