Package burp.api.montoya.ui.contextmenu

Interface ContextMenuItemsProvider

public interface ContextMenuItemsProvider
This interface allows extensions to implement and register a provider for custom context menu items.

  • Method Details

    • provideMenuItems

      default List<Component> provideMenuItems(ContextMenuEvent event)
      Invoked by Burp Suite when the user requests a context menu with HTTP request/response information in the user interface. Extensions should return null or Collections.emptyList() from this method, to indicate that no menu items are required.
      Parameters:
      event - This object can be queried to find out about HTTP request/responses that are associated with the context menu invocation.
      Returns:
      A list of custom menu items (which may include sub-menus, checkbox menu items, etc.) that should be displayed.

    • provideMenuItems

      default List<Component> provideMenuItems(WebSocketContextMenuEvent event)
      Invoked by Burp Suite when the user requests a context menu with WebSocket information in the user interface. Extensions should return null or Collections.emptyList() from this method, to indicate that no menu items are required.
      Parameters:
      event - This object can be queried to find out about WebSocket messages that are associated with the context menu invocation.
      Returns:
      A list of custom menu items (which may include sub-menus, checkbox menu items, etc.) that should be displayed.

    • provideMenuItems

      default List<Component> provideMenuItems(AuditIssueContextMenuEvent event)
      Invoked by Burp Suite when the user requests a context menu with audit issue information in the user interface. Extensions should return null or Collections.emptyList() from this method, to indicate that no menu items are required.
      Parameters:
      event - This object can be queried to find out about audit issues that are associated with the context menu invocation.
      Returns:
      A list of custom menu items (which may include sub-menus, checkbox menu items, etc.) that should be displayed.